Skip to main content

List

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

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const ListDatabasesRequest =
  cloudApi.mdb.clickhouse_database_service.ListDatabasesRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.DatabaseServiceClient);

  const result = await client.list(
    ListDatabasesRequest.fromPartial({
      clusterId: "clusterId",
      // pageSize: 0,
      // pageToken: "pageToken"
    })
  );
  console.log(result);
})();

ListDatabasesRequest​

clusterId : string​

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

pageToken : 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 : 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.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.

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​

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.