Managed Service for ClickHouse API, gRPC: FormatSchemaService
A set of methods for managing format schemas
Call | Description |
---|---|
Get | Returns detailed information about a given format schema. |
List | Returns a list of format schemas in a cluster. |
Create | Adds a format schema to a cluster. |
Update | Changes a format schema. |
Delete | Deletes a format schema from a cluster. |
Calls FormatSchemaService
Get
Returns detailed information about a given format schema.
rpc Get (GetFormatSchemaRequest) returns (FormatSchema)
GetFormatSchemaRequest
Field | Description |
---|---|
cluster_id | string Required. 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. Format schema name. To get a format schema name, use the FormatSchemaService.List method. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
FormatSchema
Field | Description |
---|---|
name | string Format schema name. |
cluster_id | string ClickHouse cluster ID. |
type | enum FormatSchemaType Schema type. Possible values are the following:
|
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. |
List
Returns a list of format schemas in a cluster.
rpc List (ListFormatSchemasRequest) returns (ListFormatSchemasResponse)
ListFormatSchemasRequest
Field | Description |
---|---|
cluster_id | string Required. ClickHouse cluster ID. To get a ClickHouse cluster ID, use the ClusterService.List method. The maximum string length in characters is 50. |
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. The maximum value is 1000. |
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. The maximum string length in characters is 100. |
ListFormatSchemasResponse
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. |
FormatSchema
Field | Description |
---|---|
name | string Format schema name. |
cluster_id | string ClickHouse cluster ID. |
type | enum FormatSchemaType Schema type. Possible values are the following:
|
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. |
Create
Adds a format schema to a cluster.
rpc Create (CreateFormatSchemaRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateFormatSchemaMetadata
Operation.response:FormatSchema
CreateFormatSchemaRequest
Field | Description |
---|---|
cluster_id | string Required. 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. Format schema name. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
type | enum FormatSchemaType Required. Schema type. Possible values are the following:
|
uri | string Required. 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. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
CreateFormatSchemaMetadata
Field | Description |
---|---|
cluster_id | string ClickHouse cluster ID. |
format_schema_name | string Format schema name. |
FormatSchema
Field | Description |
---|---|
name | string Format schema name. |
cluster_id | string ClickHouse cluster ID. |
type | enum FormatSchemaType Schema type. Possible values are the following:
|
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. |
Update
Changes a format schema.
rpc Update (UpdateFormatSchemaRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateFormatSchemaMetadata
Operation.response:FormatSchema
UpdateFormatSchemaRequest
Field | Description |
---|---|
cluster_id | string Required. 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. Format schema name. To get a format schema name, use the FormatSchemaService.List method. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
update_mask | google.protobuf.FieldMask |
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. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateFormatSchemaMetadata
Field | Description |
---|---|
cluster_id | string ClickHouse cluster ID. |
format_schema_name | string Format schema name. |
FormatSchema
Field | Description |
---|---|
name | string Format schema name. |
cluster_id | string ClickHouse cluster ID. |
type | enum FormatSchemaType Schema type. Possible values are the following:
|
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. |
Delete
Deletes a format schema from a cluster.
rpc Delete (DeleteFormatSchemaRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteFormatSchemaMetadata
Operation.response:google.protobuf.Empty
DeleteFormatSchemaRequest
Field | Description |
---|---|
cluster_id | string Required. 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. Format schema name. To get a format schema name, use the FormatSchemaService.List method. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]* . |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool If the value is false , it means the operation is still in progress. If true , the operation is completed, and either error or response is available. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteFormatSchemaMetadata
Field | Description |
---|---|
cluster_id | string ClickHouse cluster ID. |
format_schema_name | string Format schema name. |