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/*
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
MetastoreServiceClient(MetastoreServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
MetastoreServiceClient const &
|
MetastoreServiceClient(MetastoreServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
MetastoreServiceClient &&
|
MetastoreServiceClient(std::shared_ptr< MetastoreServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< MetastoreServiceConnection >
|
opts |
Options
|
Operators
operator=(MetastoreServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
MetastoreServiceClient const &
|
Returns | |
---|---|
Type | Description |
MetastoreServiceClient & |
operator=(MetastoreServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
MetastoreServiceClient &&
|
Returns | |
---|---|
Type | Description |
MetastoreServiceClient & |
Functions
CreateCatalog(std::string const &, google::cloud::bigquery::biglake::v1::Catalog const &, std::string const &, Options)
Creates a new catalog.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent resource where this catalog will be created. Format: projects/{project_id_or_number}/locations/{location_id} |
catalog |
google::cloud::bigquery::biglake::v1::Catalog const &
Required. The catalog to create. The |
catalog_id |
std::string const &
Required. The ID to use for the catalog, which will become the final component of the catalog's resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Catalog > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Catalog) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateCatalog(google::cloud::bigquery::biglake::v1::CreateCatalogRequest const &, Options)
Creates a new catalog.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::bigquery::biglake::v1::CreateCatalogRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Catalog > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Catalog) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteCatalog(std::string const &, Options)
Deletes an existing catalog specified by the catalog ID.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the catalog to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id} |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Catalog > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Catalog) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteCatalog(google::cloud::bigquery::biglake::v1::DeleteCatalogRequest const &, Options)
Deletes an existing catalog specified by the catalog ID.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::bigquery::biglake::v1::DeleteCatalogRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Catalog > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Catalog) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetCatalog(std::string const &, Options)
Gets the catalog specified by the resource name.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the catalog to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id} |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Catalog > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Catalog) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetCatalog(google::cloud::bigquery::biglake::v1::GetCatalogRequest const &, Options)
Gets the catalog specified by the resource name.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::bigquery::biglake::v1::GetCatalogRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Catalog > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Catalog) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListCatalogs(std::string const &, Options)
List all catalogs in a specified project.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent, which owns this collection of catalogs. Format: projects/{project_id_or_number}/locations/{location_id} |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::bigquery::biglake::v1::Catalog > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListCatalogs(google::cloud::bigquery::biglake::v1::ListCatalogsRequest, Options)
List all catalogs in a specified project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::bigquery::biglake::v1::ListCatalogsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::bigquery::biglake::v1::Catalog > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
CreateDatabase(std::string const &, google::cloud::bigquery::biglake::v1::Database const &, std::string const &, Options)
Creates a new database.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent resource where this database will be created. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id} |
database |
google::cloud::bigquery::biglake::v1::Database const &
Required. The database to create. The |
database_id |
std::string const &
Required. The ID to use for the database, which will become the final component of the database's resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Database > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Database) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateDatabase(google::cloud::bigquery::biglake::v1::CreateDatabaseRequest const &, Options)
Creates a new database.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::bigquery::biglake::v1::CreateDatabaseRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Database > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Database) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteDatabase(std::string const &, Options)
Deletes an existing database specified by the database ID.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the database to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Database > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Database) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteDatabase(google::cloud::bigquery::biglake::v1::DeleteDatabaseRequest const &, Options)
Deletes an existing database specified by the database ID.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::bigquery::biglake::v1::DeleteDatabaseRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Database > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Database) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateDatabase(google::cloud::bigquery::biglake::v1::Database const &, google::protobuf::FieldMask const &, Options)
Updates an existing database specified by the database ID.
Parameters | |
---|---|
Name | Description |
database |
google::cloud::bigquery::biglake::v1::Database const &
Required. The database to update. |
update_mask |
google::protobuf::FieldMask const &
The list of fields to update. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Database > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Database) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateDatabase(google::cloud::bigquery::biglake::v1::UpdateDatabaseRequest const &, Options)
Updates an existing database specified by the database ID.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::bigquery::biglake::v1::UpdateDatabaseRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Database > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Database) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetDatabase(std::string const &, Options)
Gets the database specified by the resource name.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the database to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Database > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Database) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetDatabase(google::cloud::bigquery::biglake::v1::GetDatabaseRequest const &, Options)
Gets the database specified by the resource name.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::bigquery::biglake::v1::GetDatabaseRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Database > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Database) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListDatabases(std::string const &, Options)
List all databases in a specified catalog.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent, which owns this collection of databases. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id} |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::bigquery::biglake::v1::Database > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListDatabases(google::cloud::bigquery::biglake::v1::ListDatabasesRequest, Options)
List all databases in a specified catalog.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::bigquery::biglake::v1::ListDatabasesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::bigquery::biglake::v1::Database > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
CreateTable(std::string const &, google::cloud::bigquery::biglake::v1::Table const &, std::string const &, Options)
Creates a new table.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
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} |
table |
google::cloud::bigquery::biglake::v1::Table const &
Required. The table to create. The |
table_id |
std::string const &
Required. The ID to use for the table, which will become the final component of the table's resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Table > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateTable(google::cloud::bigquery::biglake::v1::CreateTableRequest const &, Options)
Creates a new table.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::bigquery::biglake::v1::CreateTableRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Table > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteTable(std::string const &, Options)
Deletes an existing table specified by the table ID.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
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} |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Table > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteTable(google::cloud::bigquery::biglake::v1::DeleteTableRequest const &, Options)
Deletes an existing table specified by the table ID.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::bigquery::biglake::v1::DeleteTableRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Table > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateTable(google::cloud::bigquery::biglake::v1::Table const &, google::protobuf::FieldMask const &, Options)
Updates an existing table specified by the table ID.
Parameters | |
---|---|
Name | Description |
table |
google::cloud::bigquery::biglake::v1::Table const &
Required. The table to update. |
update_mask |
google::protobuf::FieldMask const &
The list of fields to update. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Table > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateTable(google::cloud::bigquery::biglake::v1::UpdateTableRequest const &, Options)
Updates an existing table specified by the table ID.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::bigquery::biglake::v1::UpdateTableRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Table > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
RenameTable(std::string const &, std::string const &, Options)
Renames an existing table specified by the table ID.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The table's |
new_name |
std::string const &
Required. The new |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Table > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
RenameTable(google::cloud::bigquery::biglake::v1::RenameTableRequest const &, Options)
Renames an existing table specified by the table ID.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::bigquery::biglake::v1::RenameTableRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Table > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetTable(std::string const &, Options)
Gets the table specified by the resource name.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
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} |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Table > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetTable(google::cloud::bigquery::biglake::v1::GetTableRequest const &, Options)
Gets the table specified by the resource name.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::bigquery::biglake::v1::GetTableRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::bigquery::biglake::v1::Table > |
the result of the RPC. The response message type (google.cloud.bigquery.biglake.v1.Table) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListTables(std::string const &, Options)
List all tables in a specified database.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The parent, which owns this collection of tables. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id} |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::bigquery::biglake::v1::Table > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListTables(google::cloud::bigquery::biglake::v1::ListTablesRequest, Options)
List all tables in a specified database.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::bigquery::biglake::v1::ListTablesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::bigquery::biglake::v1::Table > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |