Class SqlDatabasesServiceClient (2.31.0)

Version 2.31.0

• 2.34.0-rc (latest)
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

Service to manage databases.

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

SqlDatabasesServiceClient(SqlDatabasesServiceClient const &)

Copy and move support

Parameter
Name	Description
	SqlDatabasesServiceClient const &

SqlDatabasesServiceClient(SqlDatabasesServiceClient &&)

Copy and move support

Parameter
Name	Description
	SqlDatabasesServiceClient &&

SqlDatabasesServiceClient(std::shared_ptr< SqlDatabasesServiceConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< SqlDatabasesServiceConnection >
opts	Options

Operators

operator=(SqlDatabasesServiceClient const &)

Copy and move support

Parameter
Name	Description
	SqlDatabasesServiceClient const &

Returns
Type	Description
SqlDatabasesServiceClient &

operator=(SqlDatabasesServiceClient &&)

Copy and move support

Parameter
Name	Description
	SqlDatabasesServiceClient &&

Returns
Type	Description
SqlDatabasesServiceClient &

Functions

Delete(google::cloud::sql::v1::SqlDatabasesDeleteRequest const &, Options)

Deletes a database from a Cloud SQL instance.

Parameters
Name	Description
request	google::cloud::sql::v1::SqlDatabasesDeleteRequest 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.sql.v1.SqlDatabasesDeleteRequest. 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
Type	Description
StatusOr< google::cloud::sql::v1::Operation >	the result of the RPC. The response message type (google.cloud.sql.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Get(google::cloud::sql::v1::SqlDatabasesGetRequest const &, Options)

Retrieves a resource containing information about a database inside a Cloud SQL instance.

Parameters
Name	Description
request	google::cloud::sql::v1::SqlDatabasesGetRequest 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.sql.v1.SqlDatabasesGetRequest. 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
Type	Description
StatusOr< google::cloud::sql::v1::Database >	the result of the RPC. The response message type (google.cloud.sql.v1.Database) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Insert(google::cloud::sql::v1::SqlDatabasesInsertRequest const &, Options)

Inserts a resource containing information about a database inside a Cloud SQL instance.

Note: You can't modify the default character set and collation.

Parameters
Name	Description
request	google::cloud::sql::v1::SqlDatabasesInsertRequest 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.sql.v1.SqlDatabasesInsertRequest. 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
Type	Description
StatusOr< google::cloud::sql::v1::Operation >	the result of the RPC. The response message type (google.cloud.sql.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

List(google::cloud::sql::v1::SqlDatabasesListRequest const &, Options)

Lists databases in the specified Cloud SQL instance.

Parameters
Name	Description
request	google::cloud::sql::v1::SqlDatabasesListRequest 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.sql.v1.SqlDatabasesListRequest. 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
Type	Description
StatusOr< google::cloud::sql::v1::DatabasesListResponse >	the result of the RPC. The response message type (google.cloud.sql.v1.DatabasesListResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Patch(google::cloud::sql::v1::SqlDatabasesUpdateRequest const &, Options)

Partially updates a resource containing information about a database inside a Cloud SQL instance.

This method supports patch semantics.

Parameters
Name	Description
request	google::cloud::sql::v1::SqlDatabasesUpdateRequest 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.sql.v1.SqlDatabasesUpdateRequest. 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
Type	Description
StatusOr< google::cloud::sql::v1::Operation >	the result of the RPC. The response message type (google.cloud.sql.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

Update(google::cloud::sql::v1::SqlDatabasesUpdateRequest const &, Options)

Updates a resource containing information about a database inside a Cloud SQL instance.

Parameters
Name	Description
request	google::cloud::sql::v1::SqlDatabasesUpdateRequest 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.sql.v1.SqlDatabasesUpdateRequest. 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
Type	Description
StatusOr< google::cloud::sql::v1::Operation >	the result of the RPC. The response message type (google.cloud.sql.v1.Operation) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.