| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="biglake_v1.html">BigLake API</a> . <a href="biglake_v1.projects.html">projects</a> . <a href="biglake_v1.projects.locations.html">locations</a> . <a href="biglake_v1.projects.locations.catalogs.html">catalogs</a> . <a href="biglake_v1.projects.locations.catalogs.databases.html">databases</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="biglake_v1.projects.locations.catalogs.databases.tables.html">tables()</a></code> |
| </p> |
| <p class="firstline">Returns the tables Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, databaseId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a new database.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes an existing database specified by the database ID.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets the database specified by the resource name.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">List all databases in a specified catalog.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates an existing database specified by the database ID.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, databaseId=None, x__xgafv=None)</code> |
| <pre>Creates a new database. |
| |
| Args: |
| parent: string, Required. The parent resource where this database will be created. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id} (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Database is the container of tables. |
| "createTime": "A String", # Output only. The creation time of the database. |
| "deleteTime": "A String", # Output only. The deletion time of the database. Only set after the database is deleted. |
| "expireTime": "A String", # Output only. The time when this database is considered expired. Only set after the database is deleted. |
| "hiveOptions": { # Options of a Hive database. # Options of a Hive database. |
| "locationUri": "A String", # Cloud Storage folder URI where the database data is stored, starting with "gs://". |
| "parameters": { # Stores user supplied Hive database parameters. |
| "a_key": "A String", |
| }, |
| }, |
| "name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} |
| "type": "A String", # The database type. |
| "updateTime": "A String", # Output only. The last modification time of the database. |
| } |
| |
| databaseId: string, Required. The ID to use for the database, which will become the final component of the database's resource name. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Database is the container of tables. |
| "createTime": "A String", # Output only. The creation time of the database. |
| "deleteTime": "A String", # Output only. The deletion time of the database. Only set after the database is deleted. |
| "expireTime": "A String", # Output only. The time when this database is considered expired. Only set after the database is deleted. |
| "hiveOptions": { # Options of a Hive database. # Options of a Hive database. |
| "locationUri": "A String", # Cloud Storage folder URI where the database data is stored, starting with "gs://". |
| "parameters": { # Stores user supplied Hive database parameters. |
| "a_key": "A String", |
| }, |
| }, |
| "name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} |
| "type": "A String", # The database type. |
| "updateTime": "A String", # Output only. The last modification time of the database. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Deletes an existing database specified by the database ID. |
| |
| Args: |
| name: string, Required. The name of the database to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Database is the container of tables. |
| "createTime": "A String", # Output only. The creation time of the database. |
| "deleteTime": "A String", # Output only. The deletion time of the database. Only set after the database is deleted. |
| "expireTime": "A String", # Output only. The time when this database is considered expired. Only set after the database is deleted. |
| "hiveOptions": { # Options of a Hive database. # Options of a Hive database. |
| "locationUri": "A String", # Cloud Storage folder URI where the database data is stored, starting with "gs://". |
| "parameters": { # Stores user supplied Hive database parameters. |
| "a_key": "A String", |
| }, |
| }, |
| "name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} |
| "type": "A String", # The database type. |
| "updateTime": "A String", # Output only. The last modification time of the database. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets the database specified by the resource name. |
| |
| Args: |
| name: string, Required. The name of the database to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Database is the container of tables. |
| "createTime": "A String", # Output only. The creation time of the database. |
| "deleteTime": "A String", # Output only. The deletion time of the database. Only set after the database is deleted. |
| "expireTime": "A String", # Output only. The time when this database is considered expired. Only set after the database is deleted. |
| "hiveOptions": { # Options of a Hive database. # Options of a Hive database. |
| "locationUri": "A String", # Cloud Storage folder URI where the database data is stored, starting with "gs://". |
| "parameters": { # Stores user supplied Hive database parameters. |
| "a_key": "A String", |
| }, |
| }, |
| "name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} |
| "type": "A String", # The database type. |
| "updateTime": "A String", # Output only. The last modification time of the database. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>List all databases in a specified catalog. |
| |
| Args: |
| parent: string, Required. The parent, which owns this collection of databases. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id} (required) |
| pageSize: integer, The maximum number of databases to return. The service may return fewer than this value. If unspecified, at most 50 databases will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| pageToken: string, A page token, received from a previous `ListDatabases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDatabases` must match the call that provided the page token. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for the ListDatabases method. |
| "databases": [ # The databases from the specified catalog. |
| { # Database is the container of tables. |
| "createTime": "A String", # Output only. The creation time of the database. |
| "deleteTime": "A String", # Output only. The deletion time of the database. Only set after the database is deleted. |
| "expireTime": "A String", # Output only. The time when this database is considered expired. Only set after the database is deleted. |
| "hiveOptions": { # Options of a Hive database. # Options of a Hive database. |
| "locationUri": "A String", # Cloud Storage folder URI where the database data is stored, starting with "gs://". |
| "parameters": { # Stores user supplied Hive database parameters. |
| "a_key": "A String", |
| }, |
| }, |
| "name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} |
| "type": "A String", # The database type. |
| "updateTime": "A String", # Output only. The last modification time of the database. |
| }, |
| ], |
| "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates an existing database specified by the database ID. |
| |
| Args: |
| name: string, Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Database is the container of tables. |
| "createTime": "A String", # Output only. The creation time of the database. |
| "deleteTime": "A String", # Output only. The deletion time of the database. Only set after the database is deleted. |
| "expireTime": "A String", # Output only. The time when this database is considered expired. Only set after the database is deleted. |
| "hiveOptions": { # Options of a Hive database. # Options of a Hive database. |
| "locationUri": "A String", # Cloud Storage folder URI where the database data is stored, starting with "gs://". |
| "parameters": { # Stores user supplied Hive database parameters. |
| "a_key": "A String", |
| }, |
| }, |
| "name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} |
| "type": "A String", # The database type. |
| "updateTime": "A String", # Output only. The last modification time of the database. |
| } |
| |
| updateMask: string, The list of fields to update. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Database is the container of tables. |
| "createTime": "A String", # Output only. The creation time of the database. |
| "deleteTime": "A String", # Output only. The deletion time of the database. Only set after the database is deleted. |
| "expireTime": "A String", # Output only. The time when this database is considered expired. Only set after the database is deleted. |
| "hiveOptions": { # Options of a Hive database. # Options of a Hive database. |
| "locationUri": "A String", # Cloud Storage folder URI where the database data is stored, starting with "gs://". |
| "parameters": { # Stores user supplied Hive database parameters. |
| "a_key": "A String", |
| }, |
| }, |
| "name": "A String", # Output only. The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} |
| "type": "A String", # The database type. |
| "updateTime": "A String", # Output only. The last modification time of the database. |
| }</pre> |
| </div> |
| |
| </body></html> |
