Managed Service for ClickHouse API, gRPC: FormatSchemaService.Get

Статья создана

Обновлена 15 июня 2026 г.

Returns detailed information about a given format schema.

gRPC request

{
  "cluster_id": "string",
  "format_schema_name": "string"
}

Field

Description

cluster_id

string

Required field. ClickHouse cluster ID.
To get a ClickHouse cluster ID, use the ClusterService.List method.

The maximum string length in characters is 50.

format_schema_name

string

Required field. Format schema name.
To get a format schema name, use the FormatSchemaService.List method.

The maximum string length in characters is 63.

{
  "name": "string",
  "cluster_id": "string",
  "type": "FormatSchemaType",
  "uri": "string"
}

Field	Description
name	string Format schema name.
cluster_id	string ClickHouse cluster ID.
type	enum FormatSchemaType Schema type. Possible values are the following: FORMAT_SCHEMA_TYPE_PROTOBUF - Protobuf data format (including ProtobufSingle). FORMAT_SCHEMA_TYPE_CAPNPROTO - Cap'n Proto data format. `FORMAT_SCHEMA_TYPE_PROTOBUF`: Protobuf data format (including ProtobufSingle). `FORMAT_SCHEMA_TYPE_CAPNPROTO`: Cap'n Proto data format.
uri	string Link to the file of a format schema in Yandex Object Storage. Managed Service for ClickHouse works only with format schemas imported to Object Storage.