Class MetastoreServiceAsyncClient (0.1.0)

MetastoreServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.bigquery.biglake_v1alpha1.services.metastore_service.transports.base.MetastoreServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

BigLake Metastore is a serverless, highly available, multi-tenant runtime metastore for Google Cloud Data Analytics products.

The BigLake Metastore API defines the following resource model:

A collection of Google Cloud projects: /projects/*
Each project has a collection of available locations: /locations/*
Each location has a collection of catalogs: /catalogs/*
Each catalog has a collection of databases: /databases/*
Each database has a collection of tables: /tables/*

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
`MetastoreServiceTransport`	The transport used by the client instance.

Methods

MetastoreServiceAsyncClient

MetastoreServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.bigquery.biglake_v1alpha1.services.metastore_service.transports.base.MetastoreServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the metastore service client.

Parameters

Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Union[str, .MetastoreServiceTransport]` The transport to use. If set to None, a transport is chosen automatically.
`client_options`	`ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

Exceptions

Type	Description
`google.auth.exceptions.MutualTlsChannelError`	If mutual TLS transport creation failed for any reason.

catalog_path

catalog_path(project: str, location: str, catalog: str)

Returns a fully-qualified catalog string.

check_lock

check_lock(request: Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.metastore.CheckLockRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Checks the state of a lock specified by the lock ID.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.bigquery import biglake_v1alpha1

async def sample_check_lock():
    # Create a client
    client = biglake_v1alpha1.MetastoreServiceAsyncClient()

    # Initialize request argument(s)
    request = biglake_v1alpha1.CheckLockRequest(
        name="name_value",
    )

    # Make the request
    response = await client.check_lock(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.CheckLockRequest, dict]]` The request object. Request message for the CheckLock method.
`name`	`str` Required. The name of the lock to check. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/locks/{lock_id} This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.bigquery.biglake_v1alpha1.types.Lock`	Represents a lock.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_catalog

create_catalog(request: Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.metastore.CreateCatalogRequest, dict]] = None, *, parent: Optional[str] = None, catalog: Optional[google.cloud.bigquery.biglake_v1alpha1.types.metastore.Catalog] = None, catalog_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Creates a new catalog.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.bigquery import biglake_v1alpha1

async def sample_create_catalog():
    # Create a client
    client = biglake_v1alpha1.MetastoreServiceAsyncClient()

    # Initialize request argument(s)
    request = biglake_v1alpha1.CreateCatalogRequest(
        parent="parent_value",
        catalog_id="catalog_id_value",
    )

    # Make the request
    response = await client.create_catalog(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.CreateCatalogRequest, dict]]` The request object. Request message for the CreateCatalog method.
`parent`	`str` Required. The parent resource where this catalog will be created. Format: projects/{project_id_or_number}/locations/{location_id} This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`catalog`	`Catalog` Required. The catalog to create. The `name` field does not need to be provided. This corresponds to the `catalog` field on the `request` instance; if `request` is provided, this should not be set.
`catalog_id`	`str` Required. The ID to use for the catalog, which will become the final component of the catalog's resource name. This corresponds to the `catalog_id` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.bigquery.biglake_v1alpha1.types.Catalog`	Catalog is the container of databases.

create_database

create_database(request: Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.metastore.CreateDatabaseRequest, dict]] = None, *, parent: Optional[str] = None, database: Optional[google.cloud.bigquery.biglake_v1alpha1.types.metastore.Database] = None, database_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Creates a new database.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.bigquery import biglake_v1alpha1

async def sample_create_database():
    # Create a client
    client = biglake_v1alpha1.MetastoreServiceAsyncClient()

    # Initialize request argument(s)
    request = biglake_v1alpha1.CreateDatabaseRequest(
        parent="parent_value",
        database_id="database_id_value",
    )

    # Make the request
    response = await client.create_database(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.CreateDatabaseRequest, dict]]` The request object. Request message for the CreateDatabase method.
`parent`	`str` Required. The parent resource where this database will be created. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id} This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`database`	`Database` Required. The database to create. The `name` field does not need to be provided. This corresponds to the `database` field on the `request` instance; if `request` is provided, this should not be set.
`database_id`	`str` Required. The ID to use for the database, which will become the final component of the database's resource name. This corresponds to the `database_id` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.bigquery.biglake_v1alpha1.types.Database`	Database is the container of tables.

create_lock

create_lock(request: Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.metastore.CreateLockRequest, dict]] = None, *, parent: Optional[str] = None, lock: Optional[google.cloud.bigquery.biglake_v1alpha1.types.metastore.Lock] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Creates a new lock.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.bigquery import biglake_v1alpha1

async def sample_create_lock():
    # Create a client
    client = biglake_v1alpha1.MetastoreServiceAsyncClient()

    # Initialize request argument(s)
    lock = biglake_v1alpha1.Lock()
    lock.table_id = "table_id_value"

    request = biglake_v1alpha1.CreateLockRequest(
        parent="parent_value",
        lock=lock,
    )

    # Make the request
    response = await client.create_lock(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.CreateLockRequest, dict]]` The request object. Request message for the CreateLock method.
`parent`	`str` Required. The parent resource where this lock will be created. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`lock`	`Lock` Required. The lock to create. The `name` field does not need to be provided for the lock creation. This corresponds to the `lock` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.bigquery.biglake_v1alpha1.types.Lock`	Represents a lock.

create_table

create_table(request: Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.metastore.CreateTableRequest, dict]] = None, *, parent: Optional[str] = None, table: Optional[google.cloud.bigquery.biglake_v1alpha1.types.metastore.Table] = None, table_id: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Creates a new table.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.bigquery import biglake_v1alpha1

async def sample_create_table():
    # Create a client
    client = biglake_v1alpha1.MetastoreServiceAsyncClient()

    # Initialize request argument(s)
    request = biglake_v1alpha1.CreateTableRequest(
        parent="parent_value",
        table_id="table_id_value",
    )

    # Make the request
    response = await client.create_table(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.CreateTableRequest, dict]]` The request object. Request message for the CreateTable method.
`parent`	`str` Required. The parent resource where this table will be created. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`table`	`Table` Required. The table to create. The `name` field does not need to be provided for the table creation. This corresponds to the `table` field on the `request` instance; if `request` is provided, this should not be set.
`table_id`	`str` Required. The ID to use for the table, which will become the final component of the table's resource name. This corresponds to the `table_id` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.bigquery.biglake_v1alpha1.types.Table`	Represents a table.

database_path

database_path(project: str, location: str, catalog: str, database: str)

Returns a fully-qualified database string.

delete_catalog

delete_catalog(request: Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.metastore.DeleteCatalogRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Deletes an existing catalog specified by the catalog ID.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.bigquery import biglake_v1alpha1

async def sample_delete_catalog():
    # Create a client
    client = biglake_v1alpha1.MetastoreServiceAsyncClient()

    # Initialize request argument(s)
    request = biglake_v1alpha1.DeleteCatalogRequest(
        name="name_value",
    )

    # Make the request
    response = await client.delete_catalog(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.DeleteCatalogRequest, dict]]` The request object. Request message for the DeleteCatalog method.
`name`	`str` Required. The name of the catalog to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id} This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.bigquery.biglake_v1alpha1.types.Catalog`	Catalog is the container of databases.

delete_database

delete_database(request: Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.metastore.DeleteDatabaseRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Deletes an existing database specified by the database ID.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.bigquery import biglake_v1alpha1

async def sample_delete_database():
    # Create a client
    client = biglake_v1alpha1.MetastoreServiceAsyncClient()

    # Initialize request argument(s)
    request = biglake_v1alpha1.DeleteDatabaseRequest(
        name="name_value",
    )

    # Make the request
    response = await client.delete_database(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.DeleteDatabaseRequest, dict]]` The request object. Request message for the DeleteDatabase method.
`name`	`str` Required. The name of the database to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.bigquery.biglake_v1alpha1.types.Database`	Database is the container of tables.

delete_lock

delete_lock(request: Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.metastore.DeleteLockRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Deletes an existing lock specified by the lock ID.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.bigquery import biglake_v1alpha1

async def sample_delete_lock():
    # Create a client
    client = biglake_v1alpha1.MetastoreServiceAsyncClient()

    # Initialize request argument(s)
    request = biglake_v1alpha1.DeleteLockRequest(
        name="name_value",
    )

    # Make the request
    await client.delete_lock(request=request)

Parameters

Name	Description
`request`	`Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.DeleteLockRequest, dict]]` The request object. Request message for the DeleteLock method.
`name`	`str` Required. The name of the lock to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/locks/{lock_id} This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

delete_table

delete_table(request: Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.metastore.DeleteTableRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Deletes an existing table specified by the table ID.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.bigquery import biglake_v1alpha1

async def sample_delete_table():
    # Create a client
    client = biglake_v1alpha1.MetastoreServiceAsyncClient()

    # Initialize request argument(s)
    request = biglake_v1alpha1.DeleteTableRequest(
        name="name_value",
    )

    # Make the request
    response = await client.delete_table(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.DeleteTableRequest, dict]]` The request object. Request message for the DeleteTable method.
`name`	`str` Required. The name of the table to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id} This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.bigquery.biglake_v1alpha1.types.Table`	Represents a table.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
`filename`	`str` The path to the service account private key json file.

Returns

Type	Description
`MetastoreServiceAsyncClient`	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter

Name	Description
`info`	`dict` The service account private key info.

Returns

Type	Description
`MetastoreServiceAsyncClient`	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
`filename`	`str` The path to the service account private key json file.

Returns

Type	Description
`MetastoreServiceAsyncClient`	The constructed client.

get_catalog

get_catalog(request: Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.metastore.GetCatalogRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Gets the catalog specified by the resource name.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.bigquery import biglake_v1alpha1

async def sample_get_catalog():
    # Create a client
    client = biglake_v1alpha1.MetastoreServiceAsyncClient()

    # Initialize request argument(s)
    request = biglake_v1alpha1.GetCatalogRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_catalog(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.GetCatalogRequest, dict]]` The request object. Request message for the GetCatalog method.
`name`	`str` Required. The name of the catalog to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id} This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.bigquery.biglake_v1alpha1.types.Catalog`	Catalog is the container of databases.

get_database

get_database(request: Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.metastore.GetDatabaseRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Gets the database specified by the resource name.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.bigquery import biglake_v1alpha1

async def sample_get_database():
    # Create a client
    client = biglake_v1alpha1.MetastoreServiceAsyncClient()

    # Initialize request argument(s)
    request = biglake_v1alpha1.GetDatabaseRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_database(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.GetDatabaseRequest, dict]]` The request object. Request message for the GetDatabase method.
`name`	`str` Required. The name of the database to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.bigquery.biglake_v1alpha1.types.Database`	Database is the container of tables.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter

Name	Description
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions

Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If any errors happen.

Returns

Type	Description
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	returns the API endpoint and the client cert source to use.

get_table

get_table(request: Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.metastore.GetTableRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Gets the table specified by the resource name.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.bigquery import biglake_v1alpha1

async def sample_get_table():
    # Create a client
    client = biglake_v1alpha1.MetastoreServiceAsyncClient()

    # Initialize request argument(s)
    request = biglake_v1alpha1.GetTableRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_table(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.GetTableRequest, dict]]` The request object. Request message for the GetTable method.
`name`	`str` Required. The name of the table to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id} This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.bigquery.biglake_v1alpha1.types.Table`	Represents a table.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

list_catalogs

list_catalogs(request: Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.metastore.ListCatalogsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

List all catalogs in a specified project.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.bigquery import biglake_v1alpha1

async def sample_list_catalogs():
    # Create a client
    client = biglake_v1alpha1.MetastoreServiceAsyncClient()

    # Initialize request argument(s)
    request = biglake_v1alpha1.ListCatalogsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_catalogs(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

Name	Description
`request`	`Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.ListCatalogsRequest, dict]]` The request object. Request message for the ListCatalogs method.
`parent`	`str` Required. The parent, which owns this collection of catalogs. Format: projects/{project_id_or_number}/locations/{location_id} This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.bigquery.biglake_v1alpha1.services.metastore_service.pagers.ListCatalogsAsyncPager`	Response message for the ListCatalogs method. Iterating over this object will yield results and resolve additional pages automatically.

list_databases

list_databases(request: Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.metastore.ListDatabasesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

List all databases in a specified catalog.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.bigquery import biglake_v1alpha1

async def sample_list_databases():
    # Create a client
    client = biglake_v1alpha1.MetastoreServiceAsyncClient()

    # Initialize request argument(s)
    request = biglake_v1alpha1.ListDatabasesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_databases(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

Name	Description
`request`	`Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.ListDatabasesRequest, dict]]` The request object. Request message for the ListDatabases method.
`parent`	`str` Required. The parent, which owns this collection of databases. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id} This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.bigquery.biglake_v1alpha1.services.metastore_service.pagers.ListDatabasesAsyncPager`	Response message for the ListDatabases method. Iterating over this object will yield results and resolve additional pages automatically.

list_locks

list_locks(request: Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.metastore.ListLocksRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

List all locks in a specified database.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.bigquery import biglake_v1alpha1

async def sample_list_locks():
    # Create a client
    client = biglake_v1alpha1.MetastoreServiceAsyncClient()

    # Initialize request argument(s)
    request = biglake_v1alpha1.ListLocksRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_locks(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

Name	Description
`request`	`Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.ListLocksRequest, dict]]` The request object. Request message for the ListLocks method.
`parent`	`str` Required. The parent, which owns this collection of locks. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.bigquery.biglake_v1alpha1.services.metastore_service.pagers.ListLocksAsyncPager`	Response message for the ListLocks method. Iterating over this object will yield results and resolve additional pages automatically.

list_tables

list_tables(request: Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.metastore.ListTablesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

List all tables in a specified database.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.bigquery import biglake_v1alpha1

async def sample_list_tables():
    # Create a client
    client = biglake_v1alpha1.MetastoreServiceAsyncClient()

    # Initialize request argument(s)
    request = biglake_v1alpha1.ListTablesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_tables(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters

Name	Description
`request`	`Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.ListTablesRequest, dict]]` The request object. Request message for the ListTables method.
`parent`	`str` Required. The parent, which owns this collection of tables. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.bigquery.biglake_v1alpha1.services.metastore_service.pagers.ListTablesAsyncPager`	Response message for the ListTables method. Iterating over this object will yield results and resolve additional pages automatically.

lock_path

lock_path(project: str, location: str, catalog: str, database: str, lock: str)

Returns a fully-qualified lock string.

parse_catalog_path

parse_catalog_path(path: str)

Parses a catalog path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_database_path

parse_database_path(path: str)

Parses a database path into its component segments.

parse_lock_path

parse_lock_path(path: str)

Parses a lock path into its component segments.

parse_table_path

parse_table_path(path: str)

Parses a table path into its component segments.

table_path

table_path(project: str, location: str, catalog: str, database: str, table: str)

Returns a fully-qualified table string.

update_database

update_database(request: Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.metastore.UpdateDatabaseRequest, dict]] = None, *, database: Optional[google.cloud.bigquery.biglake_v1alpha1.types.metastore.Database] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Updates an existing database specified by the database ID.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.bigquery import biglake_v1alpha1

async def sample_update_database():
    # Create a client
    client = biglake_v1alpha1.MetastoreServiceAsyncClient()

    # Initialize request argument(s)
    request = biglake_v1alpha1.UpdateDatabaseRequest(
    )

    # Make the request
    response = await client.update_database(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.UpdateDatabaseRequest, dict]]` The request object. Request message for the UpdateDatabase method.
`database`	`Database` Required. The database to update. The database's `name` field is used to identify the database to update. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} This corresponds to the `database` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` 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. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.bigquery.biglake_v1alpha1.types.Database`	Database is the container of tables.

update_table

update_table(request: Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.metastore.UpdateTableRequest, dict]] = None, *, table: Optional[google.cloud.bigquery.biglake_v1alpha1.types.metastore.Table] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Union[float, object] = <_MethodDefault._DEFAULT_VALUE: <object object>>, metadata: Sequence[Tuple[str, str]] = ())

Updates an existing table specified by the table ID.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud.bigquery import biglake_v1alpha1

async def sample_update_table():
    # Create a client
    client = biglake_v1alpha1.MetastoreServiceAsyncClient()

    # Initialize request argument(s)
    request = biglake_v1alpha1.UpdateTableRequest(
    )

    # Make the request
    response = await client.update_table(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
`request`	`Optional[Union[google.cloud.bigquery.biglake_v1alpha1.types.UpdateTableRequest, dict]]` The request object. Request message for the UpdateTable method.
`table`	`Table` Required. The table to update. The table's `name` field is used to identify the database to update. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id} This corresponds to the `table` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` 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. This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
`google.cloud.bigquery.biglake_v1alpha1.types.Table`	Represents a table.