Class MetastoreServiceClient (2.23.0-rc)

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
NameDescription
MetastoreServiceClient const &

MetastoreServiceClient(MetastoreServiceClient &&)

Copy and move support

Parameter
NameDescription
MetastoreServiceClient &&

MetastoreServiceClient(std::shared_ptr< MetastoreServiceConnection >, Options)

Parameters
NameDescription
connection std::shared_ptr< MetastoreServiceConnection >
opts Options

Operators

operator=(MetastoreServiceClient const &)

Copy and move support

Parameter
NameDescription
MetastoreServiceClient const &
Returns
TypeDescription
MetastoreServiceClient &

operator=(MetastoreServiceClient &&)

Copy and move support

Parameter
NameDescription
MetastoreServiceClient &&
Returns
TypeDescription
MetastoreServiceClient &

Functions

CreateCatalog(std::string const &, google::cloud::bigquery::biglake::v1::Catalog const &, std::string const &, Options)

Creates a new catalog.

Parameters
NameDescription
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 name field does not need to be provided.

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
TypeDescription
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 StatusOr contains the error details.

CreateCatalog(google::cloud::bigquery::biglake::v1::CreateCatalogRequest const &, Options)

Creates a new catalog.

Parameters
NameDescription
request google::cloud::bigquery::biglake::v1::CreateCatalogRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.CreateCatalogRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 StatusOr contains the error details.

DeleteCatalog(std::string const &, Options)

Deletes an existing catalog specified by the catalog ID.

Parameters
NameDescription
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
TypeDescription
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 StatusOr contains the error details.

DeleteCatalog(google::cloud::bigquery::biglake::v1::DeleteCatalogRequest const &, Options)

Deletes an existing catalog specified by the catalog ID.

Parameters
NameDescription
request google::cloud::bigquery::biglake::v1::DeleteCatalogRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.DeleteCatalogRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 StatusOr contains the error details.

GetCatalog(std::string const &, Options)

Gets the catalog specified by the resource name.

Parameters
NameDescription
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
TypeDescription
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 StatusOr contains the error details.

GetCatalog(google::cloud::bigquery::biglake::v1::GetCatalogRequest const &, Options)

Gets the catalog specified by the resource name.

Parameters
NameDescription
request google::cloud::bigquery::biglake::v1::GetCatalogRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.GetCatalogRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 StatusOr contains the error details.

ListCatalogs(std::string const &, Options)

List all catalogs in a specified project.

Parameters
NameDescription
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
TypeDescription
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.biglake.v1.Catalog, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListCatalogs(google::cloud::bigquery::biglake::v1::ListCatalogsRequest, Options)

List all catalogs in a specified project.

Parameters
NameDescription
request google::cloud::bigquery::biglake::v1::ListCatalogsRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.ListCatalogsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.biglake.v1.Catalog, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreateDatabase(std::string const &, google::cloud::bigquery::biglake::v1::Database const &, std::string const &, Options)

Creates a new database.

Parameters
NameDescription
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 name field does not need to be provided.

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
TypeDescription
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 StatusOr contains the error details.

CreateDatabase(google::cloud::bigquery::biglake::v1::CreateDatabaseRequest const &, Options)

Creates a new database.

Parameters
NameDescription
request google::cloud::bigquery::biglake::v1::CreateDatabaseRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.CreateDatabaseRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 StatusOr contains the error details.

DeleteDatabase(std::string const &, Options)

Deletes an existing database specified by the database ID.

Parameters
NameDescription
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
TypeDescription
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 StatusOr contains the error details.

DeleteDatabase(google::cloud::bigquery::biglake::v1::DeleteDatabaseRequest const &, Options)

Deletes an existing database specified by the database ID.

Parameters
NameDescription
request google::cloud::bigquery::biglake::v1::DeleteDatabaseRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.DeleteDatabaseRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 StatusOr contains the error details.

UpdateDatabase(google::cloud::bigquery::biglake::v1::Database const &, google::protobuf::FieldMask const &, Options)

Updates an existing database specified by the database ID.

Parameters
NameDescription
database google::cloud::bigquery::biglake::v1::Database const &

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}

update_mask google::protobuf::FieldMask const &

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.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 StatusOr contains the error details.

UpdateDatabase(google::cloud::bigquery::biglake::v1::UpdateDatabaseRequest const &, Options)

Updates an existing database specified by the database ID.

Parameters
NameDescription
request google::cloud::bigquery::biglake::v1::UpdateDatabaseRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.UpdateDatabaseRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 StatusOr contains the error details.

GetDatabase(std::string const &, Options)

Gets the database specified by the resource name.

Parameters
NameDescription
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
TypeDescription
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 StatusOr contains the error details.

GetDatabase(google::cloud::bigquery::biglake::v1::GetDatabaseRequest const &, Options)

Gets the database specified by the resource name.

Parameters
NameDescription
request google::cloud::bigquery::biglake::v1::GetDatabaseRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.GetDatabaseRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 StatusOr contains the error details.

ListDatabases(std::string const &, Options)

List all databases in a specified catalog.

Parameters
NameDescription
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
TypeDescription
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.biglake.v1.Database, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListDatabases(google::cloud::bigquery::biglake::v1::ListDatabasesRequest, Options)

List all databases in a specified catalog.

Parameters
NameDescription
request google::cloud::bigquery::biglake::v1::ListDatabasesRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.ListDatabasesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.biglake.v1.Database, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

CreateTable(std::string const &, google::cloud::bigquery::biglake::v1::Table const &, std::string const &, Options)

Creates a new table.

Parameters
NameDescription
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 name field does not need to be provided for the table creation.

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
TypeDescription
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 StatusOr contains the error details.

CreateTable(google::cloud::bigquery::biglake::v1::CreateTableRequest const &, Options)

Creates a new table.

Parameters
NameDescription
request google::cloud::bigquery::biglake::v1::CreateTableRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.CreateTableRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 StatusOr contains the error details.

DeleteTable(std::string const &, Options)

Deletes an existing table specified by the table ID.

Parameters
NameDescription
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
TypeDescription
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 StatusOr contains the error details.

DeleteTable(google::cloud::bigquery::biglake::v1::DeleteTableRequest const &, Options)

Deletes an existing table specified by the table ID.

Parameters
NameDescription
request google::cloud::bigquery::biglake::v1::DeleteTableRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.DeleteTableRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 StatusOr contains the error details.

UpdateTable(google::cloud::bigquery::biglake::v1::Table const &, google::protobuf::FieldMask const &, Options)

Updates an existing table specified by the table ID.

Parameters
NameDescription
table google::cloud::bigquery::biglake::v1::Table const &

Required. The table to update.
The table's name field is used to identify the table to update. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}

update_mask google::protobuf::FieldMask const &

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.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 StatusOr contains the error details.

UpdateTable(google::cloud::bigquery::biglake::v1::UpdateTableRequest const &, Options)

Updates an existing table specified by the table ID.

Parameters
NameDescription
request google::cloud::bigquery::biglake::v1::UpdateTableRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.UpdateTableRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 StatusOr contains the error details.

RenameTable(std::string const &, std::string const &, Options)

Renames an existing table specified by the table ID.

Parameters
NameDescription
name std::string const &

Required. The table's name field is used to identify the table to rename. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}

new_name std::string const &

Required. The new name for the specified table, must be in the same database. 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
TypeDescription
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 StatusOr contains the error details.

RenameTable(google::cloud::bigquery::biglake::v1::RenameTableRequest const &, Options)

Renames an existing table specified by the table ID.

Parameters
NameDescription
request google::cloud::bigquery::biglake::v1::RenameTableRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.RenameTableRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 StatusOr contains the error details.

GetTable(std::string const &, Options)

Gets the table specified by the resource name.

Parameters
NameDescription
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
TypeDescription
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 StatusOr contains the error details.

GetTable(google::cloud::bigquery::biglake::v1::GetTableRequest const &, Options)

Gets the table specified by the resource name.

Parameters
NameDescription
request google::cloud::bigquery::biglake::v1::GetTableRequest const &

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.GetTableRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 StatusOr contains the error details.

ListTables(std::string const &, Options)

List all tables in a specified database.

Parameters
NameDescription
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
TypeDescription
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.biglake.v1.Table, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListTables(google::cloud::bigquery::biglake::v1::ListTablesRequest, Options)

List all tables in a specified database.

Parameters
NameDescription
request google::cloud::bigquery::biglake::v1::ListTablesRequest

Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.biglake.v1.ListTablesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
TypeDescription
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.bigquery.biglake.v1.Table, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.