Managed Service for ClickHouse API, gRPC: DatabaseService.Get

Written by

Updated at August 8, 2025

Returns the specified ClickHouse Database resource.

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

gRPC request

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

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.

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

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

Field	Description
name	string Name of the database.
cluster_id	string ID of the ClickHouse cluster that the database belongs to.
engine	enum DatabaseEngine Database engine. For details, see ClickHouse documentation. `DATABASE_ENGINE_UNSPECIFIED` `DATABASE_ENGINE_ATOMIC` `DATABASE_ENGINE_REPLICATED`