ClickHouse API models

Option

Description

TYPE_INVALID

TYPE_AUTOMATED

Backup created by automated daily schedule

TYPE_MANUAL

Backup created by user request

Option

Description

CLUSTER_VIEW_INVALID

Invalid cluster view value.

CLUSTER_VIEW_BASIC

Output basic information about the cluster.

CLUSTER_VIEW_FULL

Output full information about the cluster including allocated resources and ClickHouse settings.

Option

Description

METHOD_INVALID

METHOD_LZ4

METHOD_ZSTD

METHOD_LZ4HC

Option

Description

SASL_MECHANISM_INVALID

SASL_MECHANISM_GSSAPI

SASL_MECHANISM_PLAIN

SASL_MECHANISM_SCRAM_SHA_256

SASL_MECHANISM_SCRAM_SHA_512

Option

Description

SECURITY_PROTOCOL_INVALID

SECURITY_PROTOCOL_PLAINTEXT

SECURITY_PROTOCOL_SSL

SECURITY_PROTOCOL_SASL_PLAINTEXT

SECURITY_PROTOCOL_SASL_SSL

Option

Description

LOG_LEVEL_DEFAULT

LOG_LEVEL_TRACE

LOG_LEVEL_DEBUG

LOG_LEVEL_INFORMATION

LOG_LEVEL_WARNING

LOG_LEVEL_ERROR

Option

Description

IDENTIFICATION_TYPE_INVALID

IDENTIFICATION_TYPE_SHA256_PASSWORD

IDENTIFICATION_TYPE_DOUBLE_SHA1_PASSWORD

IDENTIFICATION_TYPE_BCRYPT_PASSWORD

Option

Description

ACCESS_TYPE_INVALID

ACCESS_TYPE_SHOW_DATABASES

ACCESS_TYPE_SHOW_TABLES

ACCESS_TYPE_SHOW_COLUMNS

ACCESS_TYPE_SHOW_DICTIONARIES

ACCESS_TYPE_SHOW

ACCESS_TYPE_SHOW_FILESYSTEM_CACHES

ACCESS_TYPE_SELECT

ACCESS_TYPE_INSERT

ACCESS_TYPE_ALTER_UPDATE

ACCESS_TYPE_ALTER_DELETE

ACCESS_TYPE_ALTER_ADD_COLUMN

ACCESS_TYPE_ALTER_MODIFY_COLUMN

ACCESS_TYPE_ALTER_DROP_COLUMN

ACCESS_TYPE_ALTER_COMMENT_COLUMN

ACCESS_TYPE_ALTER_CLEAR_COLUMN

ACCESS_TYPE_ALTER_RENAME_COLUMN

ACCESS_TYPE_ALTER_MATERIALIZE_COLUMN

ACCESS_TYPE_ALTER_COLUMN

ACCESS_TYPE_ALTER_MODIFY_COMMENT

ACCESS_TYPE_ALTER_ORDER_BY

ACCESS_TYPE_ALTER_SAMPLE_BY

ACCESS_TYPE_ALTER_ADD_INDEX

ACCESS_TYPE_ALTER_DROP_INDEX

ACCESS_TYPE_ALTER_MATERIALIZE_INDEX

ACCESS_TYPE_ALTER_CLEAR_INDEX

ACCESS_TYPE_ALTER_INDEX

ACCESS_TYPE_ALTER_ADD_PROJECTION

ACCESS_TYPE_ALTER_DROP_PROJECTION

ACCESS_TYPE_ALTER_MATERIALIZE_PROJECTION

ACCESS_TYPE_ALTER_CLEAR_PROJECTION

ACCESS_TYPE_ALTER_PROJECTION

ACCESS_TYPE_ALTER_ADD_CONSTRAINT

ACCESS_TYPE_ALTER_DROP_CONSTRAINT

ACCESS_TYPE_ALTER_CONSTRAINT

ACCESS_TYPE_ALTER_TTL

ACCESS_TYPE_ALTER_MATERIALIZE_TTL

ACCESS_TYPE_ALTER_SETTINGS

ACCESS_TYPE_ALTER_MOVE_PARTITION

ACCESS_TYPE_ALTER_FETCH_PARTITION

ACCESS_TYPE_ALTER_FREEZE_PARTITION

ACCESS_TYPE_ALTER_DATABASE_SETTINGS

ACCESS_TYPE_ALTER_NAMED_COLLECTION

ACCESS_TYPE_ALTER_TABLE

ACCESS_TYPE_ALTER_DATABASE

ACCESS_TYPE_ALTER_VIEW_REFRESH

ACCESS_TYPE_ALTER_VIEW_MODIFY_QUERY

ACCESS_TYPE_ALTER_VIEW

ACCESS_TYPE_ALTER

ACCESS_TYPE_CREATE_DATABASE

ACCESS_TYPE_CREATE_TABLE

ACCESS_TYPE_CREATE_VIEW

ACCESS_TYPE_CREATE_DICTIONARY

ACCESS_TYPE_CREATE_TEMPORARY_TABLE

ACCESS_TYPE_CREATE_ARBITRARY_TEMPORARY_TABLE

ACCESS_TYPE_CREATE_FUNCTION

ACCESS_TYPE_CREATE_NAMED_COLLECTION

ACCESS_TYPE_CREATE

ACCESS_TYPE_DROP_DATABASE

ACCESS_TYPE_DROP_TABLE

ACCESS_TYPE_DROP_VIEW

ACCESS_TYPE_DROP_DICTIONARY

ACCESS_TYPE_DROP_FUNCTION

ACCESS_TYPE_DROP_NAMED_COLLECTION

ACCESS_TYPE_DROP

ACCESS_TYPE_UNDROP_TABLE

ACCESS_TYPE_TRUNCATE

ACCESS_TYPE_OPTIMIZE

ACCESS_TYPE_BACKUP

ACCESS_TYPE_KILL_QUERY

ACCESS_TYPE_KILL_TRANSACTION

ACCESS_TYPE_MOVE_PARTITION_BETWEEN_SHARDS

ACCESS_TYPE_CREATE_USER

ACCESS_TYPE_ALTER_USER

ACCESS_TYPE_DROP_USER

ACCESS_TYPE_CREATE_ROLE

ACCESS_TYPE_ALTER_ROLE

ACCESS_TYPE_DROP_ROLE

ACCESS_TYPE_ROLE_ADMIN

ACCESS_TYPE_CREATE_ROW_POLICY

ACCESS_TYPE_ALTER_ROW_POLICY

ACCESS_TYPE_DROP_ROW_POLICY

ACCESS_TYPE_CREATE_QUOTA

ACCESS_TYPE_ALTER_QUOTA

ACCESS_TYPE_DROP_QUOTA

ACCESS_TYPE_CREATE_SETTINGS_PROFILE

ACCESS_TYPE_ALTER_SETTINGS_PROFILE

ACCESS_TYPE_DROP_SETTINGS_PROFILE

ACCESS_TYPE_SHOW_USERS

ACCESS_TYPE_SHOW_ROLES

ACCESS_TYPE_SHOW_ROW_POLICIES

ACCESS_TYPE_SHOW_QUOTAS

ACCESS_TYPE_SHOW_SETTINGS_PROFILES

ACCESS_TYPE_SHOW_ACCESS

ACCESS_TYPE_ACCESS_MANAGEMENT

ACCESS_TYPE_NAMED_COLLECTION

ACCESS_TYPE_SYSTEM_DROP_CACHE

ACCESS_TYPE_SYSTEM_RELOAD

ACCESS_TYPE_SYSTEM_MERGES

ACCESS_TYPE_SYSTEM_TTL_MERGES

ACCESS_TYPE_SYSTEM_FETCHES

ACCESS_TYPE_SYSTEM_MOVES

ACCESS_TYPE_SYSTEM_SENDS

ACCESS_TYPE_SYSTEM_REPLICATION_QUEUES

ACCESS_TYPE_SYSTEM_DROP_REPLICA

ACCESS_TYPE_SYSTEM_SYNC_REPLICA

ACCESS_TYPE_SYSTEM_RESTART_REPLICA

ACCESS_TYPE_SYSTEM_RESTORE_REPLICA

ACCESS_TYPE_SYSTEM_FLUSH

ACCESS_TYPE_DICT_GET

ACCESS_TYPE_INTROSPECTION

ACCESS_TYPE_URL

ACCESS_TYPE_REMOTE

ACCESS_TYPE_MONGO

ACCESS_TYPE_MYSQL

ACCESS_TYPE_POSTGRES

ACCESS_TYPE_ODBC

ACCESS_TYPE_JDBC

ACCESS_TYPE_HDFS

ACCESS_TYPE_S3

ACCESS_TYPE_ALL

Option

Description

COUNT_DISTINCT_IMPLEMENTATION_INVALID

COUNT_DISTINCT_IMPLEMENTATION_UNIQ

COUNT_DISTINCT_IMPLEMENTATION_UNIQ_COMBINED

COUNT_DISTINCT_IMPLEMENTATION_UNIQ_COMBINED_64

COUNT_DISTINCT_IMPLEMENTATION_UNIQ_HLL_12

COUNT_DISTINCT_IMPLEMENTATION_UNIQ_EXACT

Option

Description

DATE_TIME_INPUT_FORMAT_INVALID

DATE_TIME_INPUT_FORMAT_BEST_EFFORT

DATE_TIME_INPUT_FORMAT_BASIC

DATE_TIME_INPUT_FORMAT_BEST_EFFORT_US

Option

Description

DATE_TIME_OUTPUT_FORMAT_INVALID

DATE_TIME_OUTPUT_FORMAT_SIMPLE

DATE_TIME_OUTPUT_FORMAT_ISO

DATE_TIME_OUTPUT_FORMAT_UNIX_TIMESTAMP

Option

Description

DISTRIBUTED_PRODUCT_MODE_INVALID

DISTRIBUTED_PRODUCT_MODE_DENY

DISTRIBUTED_PRODUCT_MODE_LOCAL

DISTRIBUTED_PRODUCT_MODE_GLOBAL

DISTRIBUTED_PRODUCT_MODE_ALLOW

Option

Description

FORMAT_REGEXP_ESCAPING_RULE_INVALID

FORMAT_REGEXP_ESCAPING_RULE_ESCAPED

FORMAT_REGEXP_ESCAPING_RULE_QUOTED

FORMAT_REGEXP_ESCAPING_RULE_CSV

FORMAT_REGEXP_ESCAPING_RULE_JSON

FORMAT_REGEXP_ESCAPING_RULE_XML

FORMAT_REGEXP_ESCAPING_RULE_RAW

Option

Description

GROUP_BY_OVERFLOW_MODE_INVALID

GROUP_BY_OVERFLOW_MODE_THROW

GROUP_BY_OVERFLOW_MODE_BREAK

GROUP_BY_OVERFLOW_MODE_ANY

Option

Description

JOIN_ALGORITHM_INVALID

JOIN_ALGORITHM_HASH

JOIN_ALGORITHM_PARALLEL_HASH

JOIN_ALGORITHM_PARTIAL_MERGE

JOIN_ALGORITHM_DIRECT

JOIN_ALGORITHM_AUTO

JOIN_ALGORITHM_FULL_SORTING_MERGE

JOIN_ALGORITHM_PREFER_PARTIAL_MERGE

Option

Description

LOCAL_FILESYSTEM_READ_METHOD_INVALID

LOCAL_FILESYSTEM_READ_METHOD_READ

LOCAL_FILESYSTEM_READ_METHOD_PREAD_THREADPOOL

LOCAL_FILESYSTEM_READ_METHOD_PREAD

LOCAL_FILESYSTEM_READ_METHOD_NMAP

Option

Description

OVERFLOW_MODE_INVALID

OVERFLOW_MODE_THROW

OVERFLOW_MODE_BREAK

Option

Description

REMOTE_FILESYSTEM_READ_METHOD_INVALID

REMOTE_FILESYSTEM_READ_METHOD_READ

REMOTE_FILESYSTEM_READ_METHOD_THREADPOOL

Option

Description

WRITABILITY_INVALID

WRITABILITY_CONST

WRITABILITY_WRITABLE

WRITABILITY_CHANGEABLE_IN_READONLY

Field

Description

id

string Required. ID of the backup.

project_id

string ID of the project that the backup belongs to.

name

string User defined or autogenerated backup name. Contains shard name until we implement consistent multishard backups.

create_time

google.protobuf.Timestamp The time when the backup was created (i.e. when the backup operation completed).

start_time

google.protobuf.Timestamp The time when the backup operation was started.

source_cluster_id

string ID of the associated ClickHouse cluster.

size

int64 Size of backup in bytes

type

doublecloud.clickhouse.v1.Backup.Type How this backup was created (manual/automatic/etc...)

Field

Description

cluster_id

string Required. ID of the ClickHouse cluster to back up.

name

string Optional. Name of the ClickHouse cluster backup.

Field

Description

backup_id

string Required. ID of the backup to delete.

Field

Description

backup_id

string Required. ID of the backup to return.

Field

Description

project_id

string Required. ID of the project to list backups in.

paging

doublecloud.v1.Paging Paging information of the request

Field

Description

backups

list Requested list of backups.

backups[]

doublecloud.clickhouse.v1.Backup

next_page

doublecloud.v1.NextPage Pagination information of the response

Field

Description

id

string ID of the ClickHouse cluster.

project_id

string ID of the project that the ClickHouse cluster belongs to.

cloud_type

string Type of the cloud where instances should be hosted.

region_id

string ID of the region to place instances.

create_time

google.protobuf.Timestamp Creation timestamp.

name

string Name of the ClickHouse cluster. The name is unique within the project.

description

string Description of the ClickHouse cluster.

status

doublecloud.v1.ClusterStatus Current state of the cluster.

version

string Version of ClickHouse DBMS.

resources

doublecloud.clickhouse.v1.ClusterResources Resources allocated to the ClickHouse cluster.

connection_info

doublecloud.clickhouse.v1.ConnectionInfo Connection information.

access

doublecloud.v1.Access Access settings

private_connection_info

doublecloud.clickhouse.v1.PrivateConnectionInfo Private connection information.

encryption

doublecloud.v1.DataEncryption DataEncryption settings

network_id

string ID of the network that the ClickHouse cluster belongs to.

clickhouse_config

doublecloud.clickhouse.v1.ClickhouseConfig ClickHouse server configuration.

maintenance_window

doublecloud.v1.MaintenanceWindow Window of maintenance operations.

maintenance_operation

doublecloud.v1.MaintenanceOperation Maintenance operation planned at nearest maintenance_window.

metrics_exporter_connection_info

doublecloud.clickhouse.v1.MetricsExporterConnectionInfo Prometheus JMX exporter endpoint HTTP basic auth information.

custom_certificate

doublecloud.clickhouse.v1.CustomCertificate Custom TLS certificate.

Field

Description

clickhouse

doublecloud.clickhouse.v1.ClusterResources.Clickhouse Resources allocated to ClickHouse hosts.

dedicated_keeper

doublecloud.clickhouse.v1.ClusterResources.Keeper Resources allocated to dedicated ClickHouse Keeper hosts.

Field

Description

resource_preset_id

string ID of the preset for computational resources available to a host (CPU, memory etc.). Means the minimal resource preset for autoscaling.

disk_size

google.protobuf.Int64Value Volume of the storage available to a host, in bytes.

replica_count

google.protobuf.Int64Value Number of hosts per shard.

shard_count

google.protobuf.Int64Value Number of shards in the cluster.

max_disk_size

google.protobuf.Int64Value Limit for automatical storage volume scale, in bytes. Autoscaling disabled if not set.

min_resource_preset_id

google.protobuf.StringValue Lower limit for automatical resource preset scale. Equal to resource_preset_id on creation if not set.

max_resource_preset_id

google.protobuf.StringValue Upper limit for automatical resource preset scale. Autoscaling disabled if not set.

Field

Description

resource_preset_id

string ID of the preset for computational resources available to a host (CPU, memory etc.). Means the minimal resource preset for autoscaling.

disk_size

google.protobuf.Int64Value Volume of the storage available to a host, in bytes.

replica_count

google.protobuf.Int64Value Number of keeper hosts.

max_disk_size

google.protobuf.Int64Value Limit for automatical storage volume scale, in bytes. Autoscaling disabled if not set.

min_resource_preset_id

google.protobuf.StringValue Lower limit for automatical resource preset scale. Equal to resource_preset_id on creation if not set.

max_resource_preset_id

google.protobuf.StringValue Upper limit for automatical resource preset scale. Autoscaling disabled if not set.

Field

Description

host

string Host to connect.

user

string ClickHouse user.

password

string Password for ClickHouse user.

https_port

google.protobuf.Int64Value Port to connect using HTTPS protocol.

tcp_port_secure

google.protobuf.Int64Value Port to connect using TCP/native protocol.

native_protocol

string Connection string for ClickHouse native protocol.

https_uri

string URI to connect using HTTPS protocol.

jdbc_uri

string URI to connect using JDBC protocol.

odbc_uri

string URI to connect using ODBC protocol.

https_port_ctls

google.protobuf.Int64Value Port to connect using HTTPS protocol with custom TLS certificate.

tcp_port_secure_ctls

google.protobuf.Int64Value Port to connect using TCP/native protocol with custom TLS certificate.

native_protocol_ctls

string Connection string for ClickHouse native protocol with custom TLS certificate.

https_uri_ctls

string URI to connect using HTTPS protocol with custom TLS certificate.

Field

Description

enabled

bool

certificate

google.protobuf.BytesValue

key

google.protobuf.BytesValue

root_ca

google.protobuf.BytesValue

Field

Description

name

string Name of the host.

cluster_id

string ID of the ClickHouse cluster.

shard_name

string Name of the shard that the host belongs to.

private_name

string Private dns name.

status

doublecloud.v1.HostStatus Aggregated host status.

Field

Description

user

string User for HTTP basic auth.

password

string Password for HTTP basic auth.

Field

Description

host

string Host to connect.

user

string ClickHouse user.

password

string Password for ClickHouse user.

https_port

google.protobuf.Int64Value Port to connect using HTTPS protocol.

tcp_port_secure

google.protobuf.Int64Value Port to connect using TCP/native protocol.

native_protocol

string Connection string for ClickHouse native protocol.

https_uri

string URI to connect using HTTPS protocol.

jdbc_uri

string URI to connect using JDBC protocol.

odbc_uri

string URI to connect using ODBC protocol.

https_port_ctls

google.protobuf.Int64Value Port to connect using HTTPS protocol with custom TLS certificate.

tcp_port_secure_ctls

google.protobuf.Int64Value Port to connect using TCP/native protocol with custom TLS certificate.

native_protocol_ctls

string Connection string for ClickHouse native protocol with custom TLS certificate.

https_uri_ctls

string URI to connect using HTTPS protocol with custom TLS certificate.

Field

Description

project_id

string ID of the project to create the ClickHouse cluster in.

cloud_type

string Type of the cloud where instances should be hosted.

region_id

string ID of the region to place instances.

name

string Name of the ClickHouse cluster. The name must be unique within the project.

description

string Description of the ClickHouse cluster.

version

string Version of ClickHouse DBMS.

resources

doublecloud.clickhouse.v1.ClusterResources Resources allocated to the ClickHouse cluster.

access

doublecloud.v1.Access Access settings

encryption

doublecloud.v1.DataEncryption DataEncryption settings

network_id

string ID of the network to create ClickHouse cluster in.

clickhouse_config

doublecloud.clickhouse.v1.ClickhouseConfig ClickHouse server configuration.

maintenance_window

doublecloud.v1.MaintenanceWindow Window of maintenance operations.

Field

Description

cluster_id

string ID of the ClickHouse cluster to delete. To get the ClickHouse cluster ID, use a [ClusterService.List] request.

Field

Description

cluster_id

string ID of the ClickHouse cluster resource to return.

sensitive

bool Whether to include sensitive data in the response. If unspecified, defaults to false.

Field

Description

cluster_id

string Required. ID of the ClickHouse cluster.

paging

doublecloud.v1.Paging Paging information of the request

Field

Description

backups

list Requested list of backups.

backups[]

doublecloud.clickhouse.v1.Backup

next_page

doublecloud.v1.NextPage Pagination information of the response

Field

Description

cluster_id

string ID of the ClickHouse cluster to list hosts in.

paging

doublecloud.v1.Paging Paging information of the request

Field

Description

hosts

list Requested list of hosts for the cluster.

hosts[]

doublecloud.clickhouse.v1.Host

next_page

doublecloud.v1.NextPage Pagination information of the response

Field

Description

cluster_id

string Required. ID of the ClickHouse cluster.

paging

doublecloud.v1.Paging Paging information of the request

Field

Description

operations

list

operations[]

doublecloud.v1.Operation

next_page

doublecloud.v1.NextPage Pagination information of the response

Field

Description

project_id

string ID of the project to list ClickHouse clusters in.

paging

doublecloud.v1.Paging Paging information of the request

view

doublecloud.clickhouse.v1.ClusterView The level of detail to be returned. If unspecified, defaults to CLUSTER_VIEW_BASIC.

Field

Description

clusters

list List of ClickHouse cluster resources.

clusters[]

doublecloud.clickhouse.v1.Cluster

next_page

doublecloud.v1.NextPage Pagination information of the response

Field

Description

cluster_id

string Required. ID of the ClickHouse cluster to maintenance reschedule.

reschedule_type

doublecloud.v1.RescheduleType Required. The type of reschedule request.

delayed_until_time

google.protobuf.Timestamp The time for SPECIFIC_TIME reschedule. Limited by two weeks since first time scheduled.

Field

Description

cluster_id

string ID of the ClickHouse cluster to reset credentials. To get the ClickHouse cluster ID, use a [ClusterService.List] request.

Field

Description

backup_id

string Required. ID of the backup to restore from.

project_id

string ID of the project to create the ClickHouse cluster in.

region_id

string ID of the region to place instances.

name

string Name of the ClickHouse cluster. The name must be unique within the project.

description

string Description of the ClickHouse cluster.

version

string Version of ClickHouse DBMS.

resources

doublecloud.clickhouse.v1.ClusterResources Resources allocated to the ClickHouse cluster.

access

doublecloud.v1.Access Security settings

encryption

doublecloud.v1.DataEncryption DataEncryption settings

network_id

string ID of the network to create ClickHouse cluster in.

clickhouse_config

doublecloud.clickhouse.v1.ClickhouseConfig ClickHouse server configuration.

maintenance_window

doublecloud.v1.MaintenanceWindow Window of maintenance operations.

Field

Description

cluster_id

string ID of the ClickHouse cluster to start.

Field

Description

cluster_id

string ID of the ClickHouse cluster to stop.

Field

Description

cluster_id

string ID of the ClickHouse cluster resource to update. To get the ClickHouse cluster ID, use a [ClusterService.List] request.

name

string New name for the cluster.

description

string New description of the ClickHouse cluster.

version

string Version of ClickHouse DBMS.

resources

doublecloud.clickhouse.v1.ClusterResources Resources allocated to the ClickHouse cluster.

access

doublecloud.v1.Access Access settings

clickhouse_config

doublecloud.clickhouse.v1.ClickhouseConfig ClickHouse server configuration.

maintenance_window

doublecloud.v1.MaintenanceWindow Window of maintenance operations.

custom_certificate

doublecloud.clickhouse.v1.CustomCertificate Custom TLS certificate

Field

Description

log_level

doublecloud.clickhouse.v1.ClickhouseConfig.LogLevel

max_connections

google.protobuf.Int64Value

max_concurrent_queries

google.protobuf.Int64Value

keep_alive_timeout

google.protobuf.Duration

uncompressed_cache_size

google.protobuf.Int64Value

mark_cache_size

google.protobuf.Int64Value

max_table_size_to_drop

google.protobuf.Int64Value

max_partition_size_to_drop

google.protobuf.Int64Value

timezone

google.protobuf.StringValue

background_pool_size

google.protobuf.Int64Value

background_schedule_pool_size

google.protobuf.Int64Value

background_fetches_pool_size

google.protobuf.Int64Value

background_move_pool_size

google.protobuf.Int64Value

background_common_pool_size

google.protobuf.Int64Value

background_merges_mutations_concurrency_ratio

google.protobuf.Int64Value

total_memory_profiler_step

google.protobuf.Int64Value

merge_tree

doublecloud.clickhouse.v1.ClickhouseConfig.MergeTree

compression

list

compression[]

doublecloud.clickhouse.v1.ClickhouseConfig.Compression

graphite_rollup

list

graphite_rollup[]

doublecloud.clickhouse.v1.ClickhouseConfig.GraphiteRollupEntry

kafka

doublecloud.clickhouse.v1.ClickhouseConfig.Kafka

kafka_topics

list

kafka_topics[]

doublecloud.clickhouse.v1.ClickhouseConfig.KafkaTopicsEntry

rabbitmq

doublecloud.clickhouse.v1.ClickhouseConfig.Rabbitmq

total_memory_tracker_sample_probability

google.protobuf.DoubleValue

background_message_broker_schedule_pool_size

google.protobuf.Int64Value

query_log_retention_size

google.protobuf.Int64Value

query_log_retention_time

google.protobuf.Duration

query_thread_log_enabled

google.protobuf.BoolValue

query_thread_log_retention_size

google.protobuf.Int64Value

query_thread_log_retention_time

google.protobuf.Duration

query_views_log_enabled

google.protobuf.BoolValue

query_views_log_retention_size

google.protobuf.Int64Value

query_views_log_retention_time

google.protobuf.Duration

part_log_retention_size

google.protobuf.Int64Value

part_log_retention_time

google.protobuf.Duration

metric_log_enabled

google.protobuf.BoolValue

metric_log_retention_size

google.protobuf.Int64Value

metric_log_retention_time

google.protobuf.Duration

asynchronous_metric_log_enabled

google.protobuf.BoolValue

asynchronous_metric_log_retention_size

google.protobuf.Int64Value

asynchronous_metric_log_retention_time

google.protobuf.Duration

trace_log_enabled

google.protobuf.BoolValue

trace_log_retention_size

google.protobuf.Int64Value

trace_log_retention_time

google.protobuf.Duration

text_log_enabled

google.protobuf.BoolValue

text_log_retention_size

google.protobuf.Int64Value

text_log_retention_time

google.protobuf.Duration

text_log_level

doublecloud.clickhouse.v1.ClickhouseConfig.LogLevel

opentelemetry_span_log_enabled

google.protobuf.BoolValue

opentelemetry_span_log_retention_size

google.protobuf.Int64Value

opentelemetry_span_log_retention_time

google.protobuf.Duration

session_log_enabled

google.protobuf.BoolValue

session_log_retention_size

google.protobuf.Int64Value

session_log_retention_time

google.protobuf.Duration

zookeeper_log_enabled

google.protobuf.BoolValue

zookeeper_log_retention_size

google.protobuf.Int64Value

zookeeper_log_retention_time

google.protobuf.Duration

asynchronous_insert_log_enabled

google.protobuf.BoolValue

asynchronous_insert_log_retention_size

google.protobuf.Int64Value

asynchronous_insert_log_retention_time

google.protobuf.Duration

hybrid_storage

doublecloud.clickhouse.v1.ClickhouseConfig.HybridStorage

Field

Description

method

doublecloud.clickhouse.v1.ClickhouseConfig.Compression.Method

min_part_size

int64

min_part_size_ratio

double

level

google.protobuf.Int64Value

Field

Description

patterns

list

patterns[]

doublecloud.clickhouse.v1.ClickhouseConfig.GraphiteRollup.Pattern

Field

Description

regexp

google.protobuf.StringValue

function

google.protobuf.StringValue

retention

list

retention[]

doublecloud.clickhouse.v1.ClickhouseConfig.GraphiteRollup.Pattern.Retention

Field

Description

age

int64

precision

int64

Field

Description

key

string

value

doublecloud.clickhouse.v1.ClickhouseConfig.GraphiteRollup

Field

Description

prefer_not_to_merge

google.protobuf.BoolValue

max_data_part_size

google.protobuf.Int64Value

max_object_storage_data_part_size

google.protobuf.Int64Value

Field

Description

security_protocol

doublecloud.clickhouse.v1.ClickhouseConfig.Kafka.SecurityProtocol

sasl_mechanism

doublecloud.clickhouse.v1.ClickhouseConfig.Kafka.SaslMechanism

sasl_username

google.protobuf.StringValue

sasl_password

google.protobuf.StringValue

enable_ssl_certificate_verification

google.protobuf.BoolValue

max_poll_interval_ms

google.protobuf.Duration

session_timeout_ms

google.protobuf.Duration

Field

Description

key

string

value

doublecloud.clickhouse.v1.ClickhouseConfig.Kafka

Field

Description

replicated_deduplication_window

google.protobuf.Int64Value

replicated_deduplication_window_seconds

google.protobuf.Duration

parts_to_delay_insert

google.protobuf.Int64Value

parts_to_throw_insert

google.protobuf.Int64Value

max_replicated_merges_in_queue

google.protobuf.Int64Value

number_of_free_entries_in_pool_to_lower_max_size_of_merge

google.protobuf.Int64Value

max_bytes_to_merge_at_min_space_in_pool

google.protobuf.Int64Value

max_bytes_to_merge_at_max_space_in_pool

google.protobuf.Int64Value

min_bytes_for_wide_part

google.protobuf.Int64Value

min_rows_for_wide_part

google.protobuf.Int64Value

ttl_only_drop_parts

google.protobuf.BoolValue

inactive_parts_to_delay_insert

google.protobuf.Int64Value

inactive_parts_to_throw_insert

google.protobuf.Int64Value

allow_remote_fs_zero_copy_replication

google.protobuf.BoolValue

merge_with_ttl_timeout

google.protobuf.Duration

merge_with_recompression_ttl_timeout

google.protobuf.Duration

max_parts_in_total

google.protobuf.Int64Value

max_number_of_merges_with_ttl_in_pool

google.protobuf.Int64Value

cleanup_delay_period

google.protobuf.Duration

number_of_free_entries_in_pool_to_execute_mutation

google.protobuf.Int64Value

max_avg_part_size_for_too_many_parts

google.protobuf.Int64Value

min_age_to_force_merge_seconds

google.protobuf.Duration

min_age_to_force_merge_on_partition_only

google.protobuf.BoolValue

merge_selecting_sleep_ms

google.protobuf.Duration

Field

Description

username

google.protobuf.StringValue

password

google.protobuf.StringValue

vhost

google.protobuf.StringValue

Field

Description

operation_id

string Required. ID of the operation to return.

Field

Description

project_id

string ID of the project to list clusters operations in.

paging

doublecloud.v1.Paging Paging information of the request

Field

Description

operations

list List of operations.

operations[]

doublecloud.v1.Operation

next_page

doublecloud.v1.NextPage Pagination information of the response

Field

Description

roles

list List of assigned roles to the user or another role.

roles[]

string

Field

Description

type

doublecloud.clickhouse.v1.Authentication.IdentificationType Identification type. By default IDENTIFICATION_TYPE_SHA256_PASSWORD will be used.

password

google.protobuf.StringValue Password of the user. Required for SHA256_PASSWORD, DOUBLE_SHA1_PASSWORD and BCRYPT_PASSWORD identification types.

Field

Description

all

bool Shows that all granted roles set for user by default.

list

list List of granted roles provided by default.

list[]

string

except

list All the granted roles set as default excepting of the listed ones.

except[]

string

Field

Description

access_type

doublecloud.clickhouse.v1.Grant.AccessType Required. Type of the privilege access.

database

string Name of the database to which access is granted or partially revoked.

table

string Name of the table to which access is granted or partially revoked.

columns

list Name of the columns to which access is granted or partially revoked. Privilege should have COLUMN level.

columns[]

string

is_partial_revoke

bool Shows whether the privilege should be revoked or not. By default is False. False — describes a grant. True - describes a partial revoke.

grant_option

bool Permission is granted with GRANT option. Works only if it is described as a grant.

Field

Description

any

bool Shows that this user can grant privileges to anyone.

list

list List of users or roles this user can grant privileges to.

list[]

string

except

list List of users or roles this user can't grant privileges to.

except[]

string

Field

Description

grants

list List of grants.

grants[]

doublecloud.clickhouse.v1.Grant

Field

Description

names

list List of assigned quotas names.

names[]

string

Field

Description

name

string Name of the ClickHouse user.

cluster_id

string ID of the ClickHouse cluster.

privileges

doublecloud.clickhouse.v1.Privileges List of the privileges of the role.

settings

doublecloud.clickhouse.v1.Settings Settings and constraints of the role.

quota_names

doublecloud.clickhouse.v1.QuotaNames List of assigned quotas to the role.

Field

Description

readonly

doublecloud.clickhouse.v1.Settings.Int64Setting Restricts permissions for non-DDL queries. Possible values:

• 0 (default) - no restrictions.
• 1 - only read data queries are allowed.
• 2 - read data and change settings queries are allowed. See in-depth description in ClickHouse documentation.

allow_ddl

doublecloud.clickhouse.v1.Settings.BoolSetting Whether DDL queries are allowed. Default value: false. See in-depth description in ClickHouse documentation.

insert_quorum

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

insert_quorum_timeout

doublecloud.clickhouse.v1.Settings.Int64Setting Quorum write timeout in milliseconds. Default value: 60000. See in-depth description in ClickHouse documentation.

select_sequential_consistency

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

max_replica_delay_for_distributed_queries

doublecloud.clickhouse.v1.Settings.Int64Setting Max replica delay in milliseconds. If a replica lags more than the set value, this replica is not used. Default value: 300000. See in-depth description in ClickHouse documentation.

fallback_to_stale_replicas_for_distributed_queries

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

max_threads

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

max_block_size

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

max_insert_block_size

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

max_memory_usage

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

max_memory_usage_for_user

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

max_rows_to_read

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

max_bytes_to_read

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

read_overflow_mode

doublecloud.clickhouse.v1.Settings.OverflowModeSetting See in-depth description in ClickHouse documentation.

max_rows_to_group_by

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

group_by_overflow_mode

doublecloud.clickhouse.v1.Settings.GroupByOverflowModeSetting See in-depth description in ClickHouse documentation.

max_rows_to_sort

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

max_bytes_to_sort

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

sort_overflow_mode

doublecloud.clickhouse.v1.Settings.OverflowModeSetting See in-depth description in ClickHouse documentation.

max_result_rows

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

max_result_bytes

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

result_overflow_mode

doublecloud.clickhouse.v1.Settings.OverflowModeSetting See in-depth description in ClickHouse documentation.

max_rows_in_distinct

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

max_bytes_in_distinct

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

distinct_overflow_mode

doublecloud.clickhouse.v1.Settings.OverflowModeSetting See in-depth description in ClickHouse documentation.

max_rows_to_transfer

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

max_bytes_to_transfer

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

transfer_overflow_mode

doublecloud.clickhouse.v1.Settings.OverflowModeSetting See in-depth description in ClickHouse documentation.

max_execution_time

doublecloud.clickhouse.v1.Settings.Int64Setting Maximum query execution time in milliseconds. See in-depth description in ClickHouse documentation.

timeout_overflow_mode

doublecloud.clickhouse.v1.Settings.OverflowModeSetting See in-depth description in ClickHouse documentation.

max_columns_to_read

doublecloud.clickhouse.v1.Settings.Int64Setting Maximum number of columns that can be read from a table in a single query. See in-depth description in ClickHouse documentation.

max_temporary_columns

doublecloud.clickhouse.v1.Settings.Int64Setting Maximum number of temporary columns that must be kept in RAM at the same time when running a query, including constant columns. See in-depth description in ClickHouse documentation.

max_temporary_non_const_columns

doublecloud.clickhouse.v1.Settings.Int64Setting Maximum number of temporary columns that must be kept in RAM at the same time when running a query, excluding constant columns. See in-depth description in ClickHouse documentation.

max_query_size

doublecloud.clickhouse.v1.Settings.Int64Setting The maximum part of a query that can be taken to RAM for parsing with the SQL parser, in bytes. Default value: 262144. See in-depth description in ClickHouse documentation.

max_ast_depth

doublecloud.clickhouse.v1.Settings.Int64Setting Maximum depth of query syntax tree. Default value: 1000. See in-depth description in ClickHouse documentation.

max_ast_elements

doublecloud.clickhouse.v1.Settings.Int64Setting Maximum size of query syntax tree in number of nodes. Default value: 50000. See in-depth description in ClickHouse documentation.

max_expanded_ast_elements

doublecloud.clickhouse.v1.Settings.Int64Setting Maximum size of query syntax tree in number of nodes after expansion of aliases and the asterisk. Default value: 500000.

connect_timeout

doublecloud.clickhouse.v1.Settings.Int64Setting Connection timeout in milliseconds. See in-depth description in ClickHouse documentation.

receive_timeout

doublecloud.clickhouse.v1.Settings.Int64Setting Receive timeout in milliseconds. See in-depth description in ClickHouse documentation.

send_timeout

doublecloud.clickhouse.v1.Settings.Int64Setting Send timeout in milliseconds. See in-depth description in ClickHouse documentation.

replication_alter_partitions_sync

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

distributed_product_mode

doublecloud.clickhouse.v1.Settings.DistributedProductModeSetting See in-depth description in ClickHouse documentation.

compile_expressions

doublecloud.clickhouse.v1.Settings.BoolSetting Whether expression compilation is enabled.

min_count_to_compile_expression

doublecloud.clickhouse.v1.Settings.Int64Setting The number of identical expressions before they are compiled.

min_insert_block_size_rows

doublecloud.clickhouse.v1.Settings.Int64Setting Squash blocks passed to INSERT query to specified size in rows, if blocks are not big enough. If set to 0, blocks will never be squashed.

min_insert_block_size_bytes

doublecloud.clickhouse.v1.Settings.Int64Setting Squash blocks passed to INSERT query to specified size in bytes, if blocks are not big enough. If set to 0, blocks will never be squashed.

min_bytes_to_use_direct_io

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

use_uncompressed_cache

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

merge_tree_max_rows_to_use_cache

doublecloud.clickhouse.v1.Settings.Int64Setting The maximum request size in rows to use the cache of uncompressed data. The cache is not used for requests larger than the specified value. See in-depth description in ClickHouse documentation.

merge_tree_max_bytes_to_use_cache

doublecloud.clickhouse.v1.Settings.Int64Setting The maximum request size in bytes to use the cache of uncompressed data. The cache is not used for requests larger than the specified value.

merge_tree_min_rows_for_concurrent_read

doublecloud.clickhouse.v1.Settings.Int64Setting The minimum number of rows to be read from a file to enable concurrent read. See in-depth description in ClickHouse documentation.

merge_tree_min_bytes_for_concurrent_read

doublecloud.clickhouse.v1.Settings.Int64Setting The minimum number of bytes to be read from a file to enable concurrent read.

priority

doublecloud.clickhouse.v1.Settings.Int64Setting Priority of the query.

max_network_bandwidth

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

max_network_bandwidth_for_user

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

force_index_by_date

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

force_primary_key

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

input_format_values_interpret_expressions

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

input_format_defaults_for_omitted_fields

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

output_format_json_quote_64bit_integers

doublecloud.clickhouse.v1.Settings.BoolSetting Whether quoting of 64-bit integers is enabled in JSON output format. See in-depth description in ClickHouse documentation.

output_format_json_quote_denormals

doublecloud.clickhouse.v1.Settings.BoolSetting Whether output of special floating-point values (+nan, -nan, +inf and -inf) is enabled in JSON output format.

http_connection_timeout

doublecloud.clickhouse.v1.Settings.Int64Setting HTTP connection timeout, in milliseconds.

http_receive_timeout

doublecloud.clickhouse.v1.Settings.Int64Setting HTTP receive timeout, in milliseconds.

http_send_timeout

doublecloud.clickhouse.v1.Settings.Int64Setting HTTP send timeout, in milliseconds.

enable_http_compression

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

send_progress_in_http_headers

doublecloud.clickhouse.v1.Settings.BoolSetting Whether progress notifications using X-ClickHouse-Progress headers are enabled. Default value: false. See in-depth description in ClickHouse documentation.

http_headers_progress_interval

doublecloud.clickhouse.v1.Settings.Int64Setting Minimum interval between progress notifications, in milliseconds. Default value: 100.

add_http_cors_header

doublecloud.clickhouse.v1.Settings.BoolSetting Whether CORS header in HTTP responses is enabled. Default value: false.

distributed_aggregation_memory_efficient

doublecloud.clickhouse.v1.Settings.BoolSetting Whether the memory-saving mode of distributed aggregation is enabled.

distributed_ddl_task_timeout

doublecloud.clickhouse.v1.Settings.Int64Setting Timeout for DDL queries, in milliseconds.

max_bytes_before_external_group_by

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

max_bytes_before_external_sort

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

group_by_two_level_threshold

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

group_by_two_level_threshold_bytes

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

low_cardinality_allow_in_native_format

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

empty_result_for_aggregation_by_empty_set

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

skip_unavailable_shards

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

min_execution_speed

doublecloud.clickhouse.v1.Settings.Int64Setting Minimal execution speed in rows per second.

min_execution_speed_bytes

doublecloud.clickhouse.v1.Settings.Int64Setting Minimal execution speed in bytes per second.

count_distinct_implementation

doublecloud.clickhouse.v1.Settings.CountDistinctImplementationSetting Aggregate function to use for implementation of count(DISTINCT ...).

max_rows_in_set

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

max_bytes_in_set

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

set_overflow_mode

doublecloud.clickhouse.v1.Settings.OverflowModeSetting See in-depth description in ClickHouse documentation.

max_rows_in_join

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

max_bytes_in_join

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

join_overflow_mode

doublecloud.clickhouse.v1.Settings.OverflowModeSetting See in-depth description in ClickHouse documentation.

joined_subquery_requires_alias

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

join_use_nulls

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

transform_null_in

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

allow_introspection_functions

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

connect_timeout_with_failover

doublecloud.clickhouse.v1.Settings.Int64Setting Connection timeout with failover in milliseconds. See in-depth description in ClickHouse documentation.

timeout_before_checking_execution_speed

doublecloud.clickhouse.v1.Settings.Int64Setting Check that the speed is not too low after the specified time has elapsed.

insert_quorum_parallel

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

insert_null_as_default

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

deduplicate_blocks_in_dependent_materialized_views

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

max_partitions_per_insert_block

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

max_concurrent_queries_for_user

doublecloud.clickhouse.v1.Settings.Int64Setting The maximum number of concurrent requests per user.

join_algorithm

doublecloud.clickhouse.v1.Settings.JoinAlgorithmSetting See in-depth description in ClickHouse documentation.

any_join_distinct_right_table_keys

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

input_format_null_as_default

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

date_time_input_format

doublecloud.clickhouse.v1.Settings.DateTimeInputFormatSetting See in-depth description in ClickHouse documentation.

input_format_with_names_use_header

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

date_time_output_format

doublecloud.clickhouse.v1.Settings.DateTimeOutputFormatSetting See in-depth description in ClickHouse documentation.

allow_suspicious_low_cardinality_types

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

cancel_http_readonly_queries_on_client_close

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

max_http_get_redirects

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

flatten_nested

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

format_regexp

doublecloud.clickhouse.v1.Settings.StringSetting Regular expression (for Regexp format)

format_regexp_escaping_rule

doublecloud.clickhouse.v1.Settings.FormatRegexpEscapingRuleSetting See in-depth description in ClickHouse documentation.

format_regexp_skip_unmatched

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

async_insert

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

async_insert_threads

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

wait_for_async_insert

doublecloud.clickhouse.v1.Settings.BoolSetting See in-depth description in ClickHouse documentation.

wait_for_async_insert_timeout

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

async_insert_max_data_size

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

async_insert_busy_timeout

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

async_insert_stale_timeout

doublecloud.clickhouse.v1.Settings.Int64Setting See in-depth description in ClickHouse documentation.

memory_profiler_step

doublecloud.clickhouse.v1.Settings.Int64Setting Whenever query memory usage becomes larger than every next step in number of bytes the memory profiler will collect the allocating stack trace. Zero means disabled memory profiler.

memory_profiler_sample_probability

doublecloud.clickhouse.v1.Settings.DoubleSetting Collect random allocations and deallocations and write them into system.trace_log with 'MemorySample' trace_type. The probability is for every alloc/free regardless to the size of the allocation.

max_final_threads

doublecloud.clickhouse.v1.Settings.Int64Setting Sets the maximum number of parallel threads for the SELECT query data read phase with the FINAL modifier. See in-depth description in ClickHouse documentation.

input_format_parallel_parsing

doublecloud.clickhouse.v1.Settings.BoolSetting Enables or disables order-preserving parallel parsing of data formats. Supported only for TSV, TKSV, CSV and JSONEachRow formats. See in-depth description in ClickHouse documentation

input_format_import_nested_json

doublecloud.clickhouse.v1.Settings.BoolSetting Enables or disables the insertion of JSON data with nested objects. See in-depth description in ClickHouse documentation

local_filesystem_read_method

doublecloud.clickhouse.v1.Settings.LocalFilesystemReadMethodSetting Method of reading data from local filesystem, one of: read, pread, mmap, io_uring, pread_threadpool. The 'io_uring' method is experimental and does not work for Log, TinyLog, StripeLog, File, Set and Join, and other tables with append-able files in presence of concurrent reads and writes.

max_read_buffer_size

doublecloud.clickhouse.v1.Settings.Int64Setting The maximum size of the buffer to read from the filesystem. See in-depth description in ClickHouse documentation

insert_keeper_max_retries

doublecloud.clickhouse.v1.Settings.Int64Setting The setting sets the maximum number of retries for ClickHouse Keeper (or ZooKeeper) requests during insert into replicated MergeTree. Only Keeper requests which failed due to network error, Keeper session timeout, or request timeout are considered for retries. Default: 20 from 23.2, 0(disabled) before Min_version: 22.11 See in-depth description in ClickHouse documentation

max_temporary_data_on_disk_size_for_user

doublecloud.clickhouse.v1.Settings.Int64Setting The maximum amount of data consumed by temporary files on disk in bytes for all concurrently running user queries. Zero means unlimited. Default: 0 - unlimited Min_version: 22.10 See in-depth description in ClickHouse documentation

max_temporary_data_on_disk_size_for_query

doublecloud.clickhouse.v1.Settings.Int64Setting The maximum amount of data consumed by temporary files on disk in bytes for all concurrently running queries. Zero means unlimited. Default: 0 - unlimited Min_version: 22.10 See in-depth description in ClickHouse documentation

max_parser_depth

doublecloud.clickhouse.v1.Settings.Int64Setting Limits maximum recursion depth in the recursive descent parser. Allows controlling the stack size. Default: 1000 Min_version: 20.4 Special: 0 - unlimited See in-depth description in ClickHouse documentation

remote_filesystem_read_method

doublecloud.clickhouse.v1.Settings.RemoteFilesystemReadMethodSetting Method of reading data from remote filesystem, one of: read, threadpool. Default: read Min_version: 21.11 See in-depth description in ClickHouse GitHub

memory_overcommit_ratio_denominator

doublecloud.clickhouse.v1.Settings.Int64Setting It represents soft memory limit in case when hard limit is reached on user level. This value is used to compute overcommit ratio for the query. Zero means skip the query. Default: 1GiB Min_version: 22.5 See in-depth description in ClickHouse documentation

memory_overcommit_ratio_denominator_for_user

doublecloud.clickhouse.v1.Settings.Int64Setting It represents soft memory limit in case when hard limit is reached on global level. This value is used to compute overcommit ratio for the query. Zero means skip the query. Default: 1GiB Min_version: 22.5 See in-depth description in ClickHouse documentation

memory_usage_overcommit_max_wait_microseconds

doublecloud.clickhouse.v1.Settings.Int64Setting Maximum time thread will wait for memory to be freed in the case of memory overcommit on a user level. If the timeout is reached and memory is not freed, an exception is thrown. Default: 5000000 Min_version: 22.5 See in-depth description in ClickHouse documentation

Field

Description

value

google.protobuf.BoolValue Setting value.

writability

doublecloud.clickhouse.v1.Settings.WritabilityConstraint Writability constraint specifies how the user can change this setting.

Field

Description

value

doublecloud.clickhouse.v1.Settings.CountDistinctImplementation Setting value.

writability

doublecloud.clickhouse.v1.Settings.WritabilityConstraint Writability constraint specifies how the user can change this setting.

Field

Description

value

doublecloud.clickhouse.v1.Settings.DateTimeInputFormat Setting value.

writability

doublecloud.clickhouse.v1.Settings.WritabilityConstraint Writability constraint specifies how the user can change this setting.

Field

Description

value

doublecloud.clickhouse.v1.Settings.DateTimeOutputFormat Setting value.

writability

doublecloud.clickhouse.v1.Settings.WritabilityConstraint Writability constraint specifies how the user can change this setting.

Field

Description

value

doublecloud.clickhouse.v1.Settings.DistributedProductMode Setting value.

writability

doublecloud.clickhouse.v1.Settings.WritabilityConstraint Writability constraint specifies how the user can change this setting.

Field

Description

value

google.protobuf.DoubleValue Setting value.

min

google.protobuf.DoubleValue Min constraint specifies lower boundary for a numeric setting.

max

google.protobuf.DoubleValue Max constraint specifies upper boundary for a numeric setting.

writability

doublecloud.clickhouse.v1.Settings.WritabilityConstraint Writability constraint specifies how the user can change this setting.

Field

Description

value

doublecloud.clickhouse.v1.Settings.FormatRegexpEscapingRule Setting value.

writability

doublecloud.clickhouse.v1.Settings.WritabilityConstraint Writability constraint specifies how the user can change this setting.

Field

Description

value

doublecloud.clickhouse.v1.Settings.GroupByOverflowMode Setting value.

writability

doublecloud.clickhouse.v1.Settings.WritabilityConstraint Writability constraint specifies how the user can change this setting.

Field

Description

value

google.protobuf.Int64Value Setting value.

min

google.protobuf.Int64Value Min constraint specifies lower boundary for a numeric setting.

max

google.protobuf.Int64Value Max constraint specifies upper boundary for a numeric setting.

writability

doublecloud.clickhouse.v1.Settings.WritabilityConstraint Writability constraint specifies how the user can change this setting.

Field

Description

value

list Setting value.

value[]

doublecloud.clickhouse.v1.Settings.JoinAlgorithm

writability

doublecloud.clickhouse.v1.Settings.WritabilityConstraint Writability constraint specifies how the user can change this setting.

Field

Description

value

doublecloud.clickhouse.v1.Settings.LocalFilesystemReadMethod Setting value.

writability

doublecloud.clickhouse.v1.Settings.WritabilityConstraint Writability constraint specifies how the user can change this setting.

Field

Description

value

doublecloud.clickhouse.v1.Settings.OverflowMode Setting value.

writability

doublecloud.clickhouse.v1.Settings.WritabilityConstraint Writability constraint specifies how the user can change this setting.

Field

Description

value

doublecloud.clickhouse.v1.Settings.RemoteFilesystemReadMethod Setting value.

writability

doublecloud.clickhouse.v1.Settings.WritabilityConstraint Writability constraint specifies how the user can change this setting.

Field

Description

value

google.protobuf.StringValue Setting value.

writability

doublecloud.clickhouse.v1.Settings.WritabilityConstraint Writability constraint specifies how the user can change this setting.

Field

Description

value

doublecloud.clickhouse.v1.Settings.Writability Writability value.

Field

Description

name

string Name of the ClickHouse user.

cluster_id

string ID of the ClickHouse cluster.

default_roles

doublecloud.clickhouse.v1.DefaultRoles Default role settigns.

grantees

doublecloud.clickhouse.v1.Grantees Grantees settings.

privileges

doublecloud.clickhouse.v1.Privileges List of the privileges of the user.

settings

doublecloud.clickhouse.v1.Settings Settings and constraints of the user.

quota_names

doublecloud.clickhouse.v1.QuotaNames List of assigned quotas to the user.

assigned_roles

doublecloud.clickhouse.v1.AssignedRoles List of assigned roles to the user.

Field

Description

cluster_id

string Required. ID of the ClickHouse cluster.

role_name

string Required. Name of the role.

privileges

doublecloud.clickhouse.v1.Privileges List of the privileges that define the scope of queries the a user with that role can execute.

settings

doublecloud.clickhouse.v1.Settings Settings and constraints.

quota_names

doublecloud.clickhouse.v1.QuotaNames List of assigned quotas to the role.

Field

Description

cluster_id

string Required. ID of the ClickHouse cluster.

user_name

string Required. Name of the user.

authentication

doublecloud.clickhouse.v1.Authentication Authentication params of the user.

default_roles

doublecloud.clickhouse.v1.DefaultRoles Default role settigns.

grantees

doublecloud.clickhouse.v1.Grantees Grantees settings.

privileges

doublecloud.clickhouse.v1.Privileges List of the privileges that define the scope of queries the a user can execute.

settings

doublecloud.clickhouse.v1.Settings Settings and constraints.

quota_names

doublecloud.clickhouse.v1.QuotaNames List of assigned quotas to the user.

assigned_roles

doublecloud.clickhouse.v1.AssignedRoles List of assigned roles to the user.

Field

Description

cluster_id

string Required. ID of the ClickHouse cluster.

role_name

string Required. Name of the role to delete.

Field

Description

cluster_id

string Required. ID of the ClickHouse cluster.

user_name

string Required. Name of the user to delete.

Field

Description

cluster_id

string Required. ID of the ClickHouse cluster.

role_name

string Required. Name of the role.

Field

Description

cluster_id

string Required. ID of the ClickHouse cluster.

user_name

string Required. Name of the user.

Field

Description

cluster_id

string Required. ID of the ClickHouse cluster.

paging

doublecloud.v1.Paging Paging information of the request.

Field

Description

roles

list Requested list of ClickHouse roles.

roles[]

doublecloud.clickhouse.v1.Role

next_page

doublecloud.v1.NextPage Paging information of the response.

Field

Description

cluster_id

string Required. ID of the ClickHouse cluster.

paging

doublecloud.v1.Paging Paging information of the request.

Field

Description

users

list Requested list of ClickHouse users.

users[]

doublecloud.clickhouse.v1.User

next_page

doublecloud.v1.NextPage Paging information of the response.

Field

Description

cluster_id

string Required. ID of the ClickHouse cluster.

role_name

string Required. Name of the role.

privileges

doublecloud.clickhouse.v1.Privileges List of the privileges that define the scope of queries the a user with that role can execute.

settings

doublecloud.clickhouse.v1.Settings Settings and constraints.

quota_names

doublecloud.clickhouse.v1.QuotaNames List of assigned quotas to the role.

Field

Description

cluster_id

string Required. ID of the ClickHouse cluster.

user_name

string Required. Name of the user.

authentication

doublecloud.clickhouse.v1.Authentication Authentication params of the user.

default_roles

doublecloud.clickhouse.v1.DefaultRoles Default role settigns.

grantees

doublecloud.clickhouse.v1.Grantees Grantees settings.

privileges

doublecloud.clickhouse.v1.Privileges List of the privileges that define the scope of queries the a user can execute.

settings

doublecloud.clickhouse.v1.Settings Settings and constraints.

quota_names

doublecloud.clickhouse.v1.QuotaNames List of assigned quotas to the user.

assigned_roles

doublecloud.clickhouse.v1.AssignedRoles List of assigned roles to the user.

Field

Description

id

string ID of the version.

name

string Name of the version.

deprecated

bool Whether version is deprecated.

updatable_to

list List of versions that can be updated from current.

updatable_to[]

string

Field

Description

paging

doublecloud.v1.Paging Paging information of the request

Field

Description

versions

list Requested list of available versions.

versions[]

doublecloud.clickhouse.v1.Version

next_page

doublecloud.v1.NextPage Pagination information of the response