Contact UsGet started

Managed Service for ClickHouse API, gRPC: FormatSchemaService.Create

Written by
Updated at November 26, 2024

Adds a format schema to a cluster.

gRPC request

rpc Create (CreateFormatSchemaRequest) returns (operation.Operation)

CreateFormatSchemaRequest

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

Field

Description

cluster_id

string

Required field. ClickHouse cluster ID.

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

format_schema_name

string

Required field. Format schema name.

type

enum FormatSchemaType

Required field. Schema type. Possible values are the following:

  • FORMAT_SCHEMA_TYPE_UNSPECIFIED
  • FORMAT_SCHEMA_TYPE_PROTOBUF
  • FORMAT_SCHEMA_TYPE_CAPNPROTO

uri

string

Required field. 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.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "cluster_id": "string",
    "format_schema_name": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "name": "string",
    "cluster_id": "string",
    "type": "FormatSchemaType",
    "uri": "string"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see 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

CreateFormatSchemaMetadata

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.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, 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.

response

FormatSchema

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, 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.

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:

  • 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.
Previous
List
Next
Update