Managed Service for ClickHouse API, gRPC: FormatSchemaService.List

Field

Description

cluster_id

string

Required field. ClickHouse cluster ID.

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

page_size

int64

The maximum number of results per page to return. If the number of the results is larger than page_size, the service returns ListFormatSchemasResponse.next_page_token. You can use it to get the next page of the results in subsequent requests of a format schema list.

page_token

string

Page token. To get the next page of results, set page_token to the ListFormatSchemasResponse.next_page_token returned by the previous format schema list request.

Field

Description

format_schemas[]

FormatSchema

List of format schemas.

next_page_token

string

This token allows you to get the next page of results when requesting the format schema list. If the number of the results is larger than ListFormatSchemasRequest.page_size, use the next_page_token as the value for the ListFormatSchemasRequest.page_token parameter in the next request. Each subsequent request will have its own next_page_token to continue paging through the results.

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_UNSPECIFIED
• FORMAT_SCHEMA_TYPE_PROTOBUF
• FORMAT_SCHEMA_TYPE_CAPNPROTO

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.