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
  • GetDatabaseRequest
  • Database
  1. API reference
  2. gRPC
  3. Database
  4. Get

Managed Service for ClickHouse API, gRPC: DatabaseService.Get

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

Returns the specified ClickHouse Database resource.
To get the list of available ClickHouse Database resources, make a List request.

gRPC requestgRPC request

rpc Get (GetDatabaseRequest) returns (Database)

GetDatabaseRequestGetDatabaseRequest

{
  "cluster_id": "string",
  "database_name": "string"
}

Field

Description

cluster_id

string

Required field. ID of the ClickHouse cluster that the database belongs to.
To get the cluster ID, use a ClusterService.List request.

The maximum string length in characters is 50.

database_name

string

Required field. Name of the ClickHouse Database resource to return.
To get the name of the database, use a DatabaseService.List request.

The maximum string length in characters is 63.

DatabaseDatabase

{
  "name": "string",
  "cluster_id": "string",
  "engine": "DatabaseEngine",
  "deletion_protection_mode": "DeletionProtectionMode"
}

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
Overview
Next
List
© 2026 Direct Cursus Technology L.L.C.