MetastoreServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.bigquery_biglake_v1alpha1.services.metastore_service.transports.base.MetastoreServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = 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
api_endpoint
Return the API endpoint used by the client instance.
Returns | |
---|---|
Type | Description |
str | The API endpoint used by the client instance. |
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
MetastoreServiceTransport | The transport used by the client instance. |
universe_domain
Return the universe domain used by the client instance.
Returns | |
---|---|
Type | Description |
str | The universe domain used by the client instance. |
Methods
MetastoreServiceClient
MetastoreServiceClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.bigquery_biglake_v1alpha1.services.metastore_service.transports.base.MetastoreServiceTransport]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = 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 |
Optional[Union[google.api_core.client_options.ClientOptions, dict]]
Custom options for the client. 1. The |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)
Releases underlying transport's resources.
catalog_path
catalog_path(project: str, location: str, catalog: str) -> str
Returns a fully-qualified catalog string.
check_lock
check_lock(
request: typing.Optional[
typing.Union[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.CheckLockRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.bigquery_biglake_v1alpha1.types.metastore.Lock
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 import bigquery_biglake_v1alpha1
def sample_check_lock():
# Create a client
client = bigquery_biglake_v1alpha1.MetastoreServiceClient()
# Initialize request argument(s)
request = bigquery_biglake_v1alpha1.CheckLockRequest(
name="name_value",
)
# Make the request
response = client.check_lock(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
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 |
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) -> str
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str) -> str
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str) -> str
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str) -> str
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str) -> str
Returns a fully-qualified project string.
create_catalog
create_catalog(
request: typing.Optional[
typing.Union[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.CreateCatalogRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
catalog: typing.Optional[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.Catalog
] = None,
catalog_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.bigquery_biglake_v1alpha1.types.metastore.Catalog
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 import bigquery_biglake_v1alpha1
def sample_create_catalog():
# Create a client
client = bigquery_biglake_v1alpha1.MetastoreServiceClient()
# Initialize request argument(s)
request = bigquery_biglake_v1alpha1.CreateCatalogRequest(
parent="parent_value",
catalog_id="catalog_id_value",
)
# Make the request
response = client.create_catalog(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
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 |
catalog |
google.cloud.bigquery_biglake_v1alpha1.types.Catalog
Required. The catalog to create. The |
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 |
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: typing.Optional[
typing.Union[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.CreateDatabaseRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
database: typing.Optional[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.Database
] = None,
database_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.bigquery_biglake_v1alpha1.types.metastore.Database
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 import bigquery_biglake_v1alpha1
def sample_create_database():
# Create a client
client = bigquery_biglake_v1alpha1.MetastoreServiceClient()
# Initialize request argument(s)
request = bigquery_biglake_v1alpha1.CreateDatabaseRequest(
parent="parent_value",
database_id="database_id_value",
)
# Make the request
response = client.create_database(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
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 |
database |
google.cloud.bigquery_biglake_v1alpha1.types.Database
Required. The database to create. The |
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 |
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: typing.Optional[
typing.Union[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.CreateLockRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
lock: typing.Optional[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.Lock
] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.bigquery_biglake_v1alpha1.types.metastore.Lock
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 import bigquery_biglake_v1alpha1
def sample_create_lock():
# Create a client
client = bigquery_biglake_v1alpha1.MetastoreServiceClient()
# Initialize request argument(s)
lock = bigquery_biglake_v1alpha1.Lock()
lock.table_id = "table_id_value"
request = bigquery_biglake_v1alpha1.CreateLockRequest(
parent="parent_value",
lock=lock,
)
# Make the request
response = client.create_lock(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
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 |
lock |
google.cloud.bigquery_biglake_v1alpha1.types.Lock
Required. The lock to create. The |
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: typing.Optional[
typing.Union[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.CreateTableRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
table: typing.Optional[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.Table
] = None,
table_id: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.bigquery_biglake_v1alpha1.types.metastore.Table
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 import bigquery_biglake_v1alpha1
def sample_create_table():
# Create a client
client = bigquery_biglake_v1alpha1.MetastoreServiceClient()
# Initialize request argument(s)
request = bigquery_biglake_v1alpha1.CreateTableRequest(
parent="parent_value",
table_id="table_id_value",
)
# Make the request
response = client.create_table(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
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 |
table |
google.cloud.bigquery_biglake_v1alpha1.types.Table
Required. The table to create. The |
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 |
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) -> str
Returns a fully-qualified database string.
delete_catalog
delete_catalog(
request: typing.Optional[
typing.Union[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.DeleteCatalogRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.bigquery_biglake_v1alpha1.types.metastore.Catalog
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 import bigquery_biglake_v1alpha1
def sample_delete_catalog():
# Create a client
client = bigquery_biglake_v1alpha1.MetastoreServiceClient()
# Initialize request argument(s)
request = bigquery_biglake_v1alpha1.DeleteCatalogRequest(
name="name_value",
)
# Make the request
response = client.delete_catalog(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
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 |
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: typing.Optional[
typing.Union[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.DeleteDatabaseRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.bigquery_biglake_v1alpha1.types.metastore.Database
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 import bigquery_biglake_v1alpha1
def sample_delete_database():
# Create a client
client = bigquery_biglake_v1alpha1.MetastoreServiceClient()
# Initialize request argument(s)
request = bigquery_biglake_v1alpha1.DeleteDatabaseRequest(
name="name_value",
)
# Make the request
response = client.delete_database(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
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 |
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: typing.Optional[
typing.Union[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.DeleteLockRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> None
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 import bigquery_biglake_v1alpha1
def sample_delete_lock():
# Create a client
client = bigquery_biglake_v1alpha1.MetastoreServiceClient()
# Initialize request argument(s)
request = bigquery_biglake_v1alpha1.DeleteLockRequest(
name="name_value",
)
# Make the request
client.delete_lock(request=request)
Parameters | |
---|---|
Name | Description |
request |
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 |
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: typing.Optional[
typing.Union[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.DeleteTableRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.bigquery_biglake_v1alpha1.types.metastore.Table
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 import bigquery_biglake_v1alpha1
def sample_delete_table():
# Create a client
client = bigquery_biglake_v1alpha1.MetastoreServiceClient()
# Initialize request argument(s)
request = bigquery_biglake_v1alpha1.DeleteTableRequest(
name="name_value",
)
# Make the request
response = client.delete_table(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
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 |
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 |
MetastoreServiceClient | 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 |
MetastoreServiceClient | 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 |
MetastoreServiceClient | The constructed client. |
get_catalog
get_catalog(
request: typing.Optional[
typing.Union[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.GetCatalogRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.bigquery_biglake_v1alpha1.types.metastore.Catalog
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 import bigquery_biglake_v1alpha1
def sample_get_catalog():
# Create a client
client = bigquery_biglake_v1alpha1.MetastoreServiceClient()
# Initialize request argument(s)
request = bigquery_biglake_v1alpha1.GetCatalogRequest(
name="name_value",
)
# Make the request
response = client.get_catalog(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
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 |
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: typing.Optional[
typing.Union[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.GetDatabaseRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.bigquery_biglake_v1alpha1.types.metastore.Database
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 import bigquery_biglake_v1alpha1
def sample_get_database():
# Create a client
client = bigquery_biglake_v1alpha1.MetastoreServiceClient()
# Initialize request argument(s)
request = bigquery_biglake_v1alpha1.GetDatabaseRequest(
name="name_value",
)
# Make the request
response = client.get_database(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
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 |
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: typing.Optional[
google.api_core.client_options.ClientOptions
] = None,
)
Deprecated. 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 |
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: typing.Optional[
typing.Union[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.GetTableRequest, dict
]
] = None,
*,
name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.bigquery_biglake_v1alpha1.types.metastore.Table
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 import bigquery_biglake_v1alpha1
def sample_get_table():
# Create a client
client = bigquery_biglake_v1alpha1.MetastoreServiceClient()
# Initialize request argument(s)
request = bigquery_biglake_v1alpha1.GetTableRequest(
name="name_value",
)
# Make the request
response = client.get_table(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
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 |
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. |
list_catalogs
list_catalogs(
request: typing.Optional[
typing.Union[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.ListCatalogsRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.bigquery_biglake_v1alpha1.services.metastore_service.pagers.ListCatalogsPager
)
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 import bigquery_biglake_v1alpha1
def sample_list_catalogs():
# Create a client
client = bigquery_biglake_v1alpha1.MetastoreServiceClient()
# Initialize request argument(s)
request = bigquery_biglake_v1alpha1.ListCatalogsRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_catalogs(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
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 |
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.ListCatalogsPager | Response message for the ListCatalogs method. Iterating over this object will yield results and resolve additional pages automatically. |
list_databases
list_databases(
request: typing.Optional[
typing.Union[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.ListDatabasesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.bigquery_biglake_v1alpha1.services.metastore_service.pagers.ListDatabasesPager
)
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 import bigquery_biglake_v1alpha1
def sample_list_databases():
# Create a client
client = bigquery_biglake_v1alpha1.MetastoreServiceClient()
# Initialize request argument(s)
request = bigquery_biglake_v1alpha1.ListDatabasesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_databases(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
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 |
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.ListDatabasesPager | Response message for the ListDatabases method. Iterating over this object will yield results and resolve additional pages automatically. |
list_locks
list_locks(
request: typing.Optional[
typing.Union[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.ListLocksRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.bigquery_biglake_v1alpha1.services.metastore_service.pagers.ListLocksPager
)
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 import bigquery_biglake_v1alpha1
def sample_list_locks():
# Create a client
client = bigquery_biglake_v1alpha1.MetastoreServiceClient()
# Initialize request argument(s)
request = bigquery_biglake_v1alpha1.ListLocksRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_locks(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
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 |
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.ListLocksPager | Response message for the ListLocks method. Iterating over this object will yield results and resolve additional pages automatically. |
list_tables
list_tables(
request: typing.Optional[
typing.Union[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.ListTablesRequest,
dict,
]
] = None,
*,
parent: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> (
google.cloud.bigquery_biglake_v1alpha1.services.metastore_service.pagers.ListTablesPager
)
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 import bigquery_biglake_v1alpha1
def sample_list_tables():
# Create a client
client = bigquery_biglake_v1alpha1.MetastoreServiceClient()
# Initialize request argument(s)
request = bigquery_biglake_v1alpha1.ListTablesRequest(
parent="parent_value",
)
# Make the request
page_result = client.list_tables(request=request)
# Handle the response
for response in page_result:
print(response)
Parameters | |
---|---|
Name | Description |
request |
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 |
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.ListTablesPager | 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
) -> str
Returns a fully-qualified lock string.
parse_catalog_path
parse_catalog_path(path: str) -> typing.Dict[str, str]
Parses a catalog path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str) -> typing.Dict[str, str]
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str) -> typing.Dict[str, str]
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str) -> typing.Dict[str, str]
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str) -> typing.Dict[str, str]
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str) -> typing.Dict[str, str]
Parse a project path into its component segments.
parse_database_path
parse_database_path(path: str) -> typing.Dict[str, str]
Parses a database path into its component segments.
parse_lock_path
parse_lock_path(path: str) -> typing.Dict[str, str]
Parses a lock path into its component segments.
parse_table_path
parse_table_path(path: str) -> typing.Dict[str, str]
Parses a table path into its component segments.
rename_table
rename_table(
request: typing.Optional[
typing.Union[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.RenameTableRequest,
dict,
]
] = None,
*,
name: typing.Optional[str] = None,
new_name: typing.Optional[str] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.bigquery_biglake_v1alpha1.types.metastore.Table
Renames 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 import bigquery_biglake_v1alpha1
def sample_rename_table():
# Create a client
client = bigquery_biglake_v1alpha1.MetastoreServiceClient()
# Initialize request argument(s)
request = bigquery_biglake_v1alpha1.RenameTableRequest(
name="name_value",
new_name="new_name_value",
)
# Make the request
response = client.rename_table(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.bigquery_biglake_v1alpha1.types.RenameTableRequest, dict]
The request object. Request message for the RenameTable method in MetastoreService |
name |
str
Required. The table's |
new_name |
str
Required. The new |
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. |
table_path
table_path(
project: str, location: str, catalog: str, database: str, table: str
) -> str
Returns a fully-qualified table string.
update_database
update_database(
request: typing.Optional[
typing.Union[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.UpdateDatabaseRequest,
dict,
]
] = None,
*,
database: typing.Optional[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.Database
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.bigquery_biglake_v1alpha1.types.metastore.Database
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 import bigquery_biglake_v1alpha1
def sample_update_database():
# Create a client
client = bigquery_biglake_v1alpha1.MetastoreServiceClient()
# Initialize request argument(s)
request = bigquery_biglake_v1alpha1.UpdateDatabaseRequest(
)
# Make the request
response = client.update_database(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.bigquery_biglake_v1alpha1.types.UpdateDatabaseRequest, dict]
The request object. Request message for the UpdateDatabase method. |
database |
google.cloud.bigquery_biglake_v1alpha1.types.Database
Required. The database to update. The database's |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
The list of fields to update. For the |
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: typing.Optional[
typing.Union[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.UpdateTableRequest,
dict,
]
] = None,
*,
table: typing.Optional[
google.cloud.bigquery_biglake_v1alpha1.types.metastore.Table
] = None,
update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
retry: typing.Optional[
typing.Union[
google.api_core.retry.retry_unary.Retry,
google.api_core.gapic_v1.method._MethodDefault,
]
] = _MethodDefault._DEFAULT_VALUE,
timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
metadata: typing.Sequence[typing.Tuple[str, str]] = ()
) -> google.cloud.bigquery_biglake_v1alpha1.types.metastore.Table
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 import bigquery_biglake_v1alpha1
def sample_update_table():
# Create a client
client = bigquery_biglake_v1alpha1.MetastoreServiceClient()
# Initialize request argument(s)
request = bigquery_biglake_v1alpha1.UpdateTableRequest(
)
# Make the request
response = client.update_table(request=request)
# Handle the response
print(response)
Parameters | |
---|---|
Name | Description |
request |
Union[google.cloud.bigquery_biglake_v1alpha1.types.UpdateTableRequest, dict]
The request object. Request message for the UpdateTable method. |
table |
google.cloud.bigquery_biglake_v1alpha1.types.Table
Required. The table to update. The table's |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
The list of fields to update. For the |
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. |