Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Managed Service for PostgreSQL API, gRPC: DatabaseService.List

Written by
Updated at October 17, 2024

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.
To get the cluster ID use a ClusterService.List request.

pageSize

int64

The maximum number of results per page to return. If the number of available
results is larger than pageSize, the service returns a ListDatabasesResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.

pageToken

string

Page token. To get the next page of results, Set pageToken to the ListDatabasesResponse.nextPageToken
returned by the previous list request.

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[]

Database

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
is larger than ListDatabasesRequest.pageSize, use the nextPageToken as the value
for the ListDatabasesRequest.pageToken parameter in the next list request. Each subsequent
list request will have its own nextPageToken to continue paging through the 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.
Can only be set at creation time.

lcCtype

string

POSIX locale for character classification.
Can only be set at creation time.

extensions[]

Extension

PostgreSQL extensions enabled for the database.

templateDb

string

Name of the database template.

deletionProtection

google.protobuf.BoolValue

Deletion Protection inhibits deletion of the database

Default value: unspecified (inherits cluster's deletion_protection)

Extension

Field

Description

name

string

Name of the extension, e.g. pg_trgm or pg_btree.
Extensions supported by Managed Service for PostgreSQL are listed in the Developer's Guide.

version

string

Version of the extension.
Previous
Get
Next
Create