Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

Managed Service for PostgreSQL API, gRPC: DatabaseService.List

Written by
Updated at July 11, 2025

Retrieves the list of PostgreSQL Database resources in the specified cluster.

gRPC request

rpc List (ListDatabasesRequest) returns (ListDatabasesResponse)

ListDatabasesRequest

{
  "cluster_id": "string",
  "page_size": "int64",
  "page_token": "string"
}

Field

Description

cluster_id

string

Required field. ID of the PostgreSQL cluster to list databases in.
To get the cluster ID use a ClusterService.List request.

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.

page_token

string

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

ListDatabasesResponse

{
  "databases": [
    {
      "name": "string",
      "cluster_id": "string",
      "owner": "string",
      "lc_collate": "string",
      "lc_ctype": "string",
      "extensions": [
        {
          "name": "string",
          "version": "string"
        }
      ],
      "template_db": "string",
      "deletion_protection": "google.protobuf.BoolValue"
    }
  ],
  "next_page_token": "string"
}

Field

Description

databases[]

Database

List of PostgreSQL Database resources.

next_page_token

string

This token 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.

Database

A PostgreSQL Database resource. For more information, see
the Developer's Guide.

Field

Description

name

string

Name of the database.

cluster_id

string

ID of the PostgreSQL cluster that the database belongs to.

owner

string

Name of the user assigned as the owner of the database.

lc_collate

string

POSIX locale for string sorting order.
Can only be set at creation time.

lc_ctype

string

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

extensions[]

Extension

PostgreSQL extensions enabled for the database.

template_db

string

Name of the database template.

deletion_protection

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. The setting is deprecated and has no effect.
Previous
Get
Next
Create