DatabaseService

A set of methods for managing SQL Server databases.

Call	Description
Get	Returns the specified SQL Server database.
List	Retrieves the list of SQL Server databases in the specified cluster.
Create	Creates a new SQL Server database in the specified cluster.
Delete	Deletes the specified SQL Server database.

Calls DatabaseService

Returns the specified SQL Server database.
To get the list of available SQL Server databases, make a List request.

Field	Description
cluster_id	string Required. ID of the SQL Server cluster the database belongs to. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
database_name	string Required. Name of the SQL Server database to return. To get the name of the database use a DatabaseService.List request. The maximum string length in characters is 63. Value must match the regular expression `[a-zA-Z0-9_-]*`.

Field	Description
name	string Name of the database.
cluster_id	string ID of the SQL Server cluster the database belongs to.

Retrieves the list of SQL Server databases in the specified cluster.

Field	Description
cluster_id	string Required. ID of the SQL Server cluster to list databases in. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than `page_size`, the service returns a ListDatabasesResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 1000, inclusive.
page_token	string Page token. To get the next page of results, Set `page_token` to the ListDatabasesResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

Field	Description
databases[]	Database List of SQL Server databases.
next_page_token	string Token that allows you to get the next page of results for list requests. If the number of results is larger than ListDatabasesRequest.page_size, use the `next_page_token` as the value for the ListDatabasesRequest.page_token parameter in the next list request. Each subsequent list request will have its own `next_page_token` to continue paging through the results.

Field	Description
name	string Name of the database.
cluster_id	string ID of the SQL Server cluster the database belongs to.

Creates a new SQL Server database in the specified cluster.

Metadata and response of Operation:

Operation.metadata:CreateDatabaseMetadata

Operation.response:Database

Field	Description
cluster_id	string Required. ID of the SQL Server cluster to create a database in. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
database_spec	DatabaseSpec Required. Configuration of the database to create.

Field	Description
name	string Required. Name of the database. The maximum string length in characters is 63. Value must match the regular expression `[a-zA-Z0-9_-]*`.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	google.protobuf.Any<CreateDatabaseMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: `error` or `response` The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<Database> if operation finished successfully.

Field	Description
cluster_id	string ID of the SQL Server cluster where the database is being created.
database_name	string Name of the SQL Server database being created.

Field	Description
name	string Name of the database.
cluster_id	string ID of the SQL Server cluster the database belongs to.

Deletes the specified SQL Server database.

Metadata and response of Operation:

Operation.metadata:DeleteDatabaseMetadata

Operation.response:google.protobuf.Empty

Field	Description
cluster_id	string Required. ID of the SQL Server cluster to delete a database in. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
database_name	string Required. Name of the database to delete. To get the name of the database, use a DatabaseService.List request. The maximum string length in characters is 63. Value must match the regular expression `[a-zA-Z0-9_-]*`.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	google.protobuf.Any<DeleteDatabaseMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: `error` or `response` The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

Field	Description
cluster_id	string ID of the SQL Server cluster where the database is being deleted.
database_name	string Name of the SQL Server database being deleted.