Managed Service for PostgreSQL API, gRPC: DatabaseService.List
Retrieves the list of PostgreSQL Database resources in the specified cluster.
gRPC request
rpc List (ListDatabasesRequest) returns (ListDatabasesResponse)
ListDatabasesRequest
{
"clusterId": "string",
"pageSize": "int64",
"pageToken": "string"
}
Field |
Description |
clusterId |
string Required field. ID of the PostgreSQL cluster to list databases in. |
pageSize |
int64 The maximum number of results per page to return. If the number of available |
pageToken |
string Page token. To get the next page of results, Set |
ListDatabasesResponse
{
"databases": [
{
"name": "string",
"clusterId": "string",
"owner": "string",
"lcCollate": "string",
"lcCtype": "string",
"extensions": [
{
"name": "string",
"version": "string"
}
],
"templateDb": "string",
"deletionProtection": "google.protobuf.BoolValue"
}
],
"nextPageToken": "string"
}
Field |
Description |
databases[] |
List of PostgreSQL Database resources. |
nextPageToken |
string This token allows you to get the next page of results for list requests. If the number of results |
Database
A PostgreSQL Database resource. For more information, see
the Developer's Guide.
Field |
Description |
name |
string Name of the database. |
clusterId |
string ID of the PostgreSQL cluster that the database belongs to. |
owner |
string Name of the user assigned as the owner of the database. |
lcCollate |
string POSIX locale for string sorting order. |
lcCtype |
string POSIX locale for character classification. |
extensions[] |
PostgreSQL extensions enabled for the database. |
templateDb |
string Name of the database template. |
deletionProtection |
Deletion Protection inhibits deletion of the database Default value: |
Extension
Field |
Description |
name |
string Name of the extension, e.g. |
version |
string Version of the extension. |