Yandex Cloud
Documentation
PresentationContact UsTry it for free
© 2026 Direct Cursus Technology L.L.C.
Yandex Managed Service for ClickHouse®
  • Getting started
  • Access management
  • Inspections and recommendations
  • Pricing policy
    • API authentication
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
  • Yandex Monitoring metrics
  • Audit Trails events
  • Public materials
  • Release notes

In this article:

  • gRPC request
  • ListDatabasesRequest
  • ListDatabasesResponse
  • Database
  1. API reference
  2. gRPC
  3. Database
  4. List

Managed Service for ClickHouse API, gRPC: DatabaseService.List

Written by
Yandex Cloud
Updated at October 7, 2026
View in Markdown
  • gRPC request
  • ListDatabasesRequest
  • ListDatabasesResponse
  • Database

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

gRPC requestgRPC request

rpc List (ListDatabasesRequest) returns (ListDatabasesResponse)

ListDatabasesRequestListDatabasesRequest

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

Field

Description

cluster_id

string

Required field. ID of the ClickHouse 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.

The maximum value is 1000.

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.

The maximum string length in characters is 100.

ListDatabasesResponseListDatabasesResponse

{
  "databases": [
    {
      "name": "string",
      "cluster_id": "string",
      "engine": "DatabaseEngine",
      "deletion_protection_mode": "DeletionProtectionMode"
    }
  ],
  "next_page_token": "string"
}

Field

Description

databases[]

Database

List of ClickHouse databases.

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.

DatabaseDatabase

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

Field

Description

name

string

Required field. Name of the database.

cluster_id

string

Required field. ID of the ClickHouse cluster that the database belongs to.

engine

enum DatabaseEngine

Database engine. For details, see ClickHouse documentation.

  • DATABASE_ENGINE_ATOMIC: Atomic database engine.
  • DATABASE_ENGINE_REPLICATED: Replicated database engine.

deletion_protection_mode

enum DeletionProtectionMode

Deletion protection mode.
Default value: DELETION_PROTECTION_MODE_DISABLED.

  • DELETION_PROTECTION_MODE_DISABLED: Deletion protection is disabled.
  • DELETION_PROTECTION_MODE_ENABLED: Deletion protection is enabled.
  • DELETION_PROTECTION_MODE_INHERITED: Deletion protection mode is inherited from the cluster.

Was the article helpful?

Previous
Get
Next
Create
© 2026 Direct Cursus Technology L.L.C.