Managed Service for ClickHouse API, gRPC: ClusterService.Create

Field

Description

parts_to_delay_insert

google.protobuf.Int64Value

If the number of active parts in a single partition exceeds the parts_to_delay_insert value, an INSERT artificially slows down.

Default value: 1000 for versions 25.1 and higher, 150 for versions 24.12 and lower.

For details, see ClickHouse documentation.

parts_to_throw_insert

google.protobuf.Int64Value

If the number of active parts in a single partition exceeds the parts_to_throw_insert value, an INSERT
is interrupted with the error "Too many parts (N). Merges are processing significantly slower than inserts".

Default value: 3000 for versions 25.1 and higher, 300 for versions 24.12 and lower.

For details, see ClickHouse documentation.

inactive_parts_to_delay_insert

google.protobuf.Int64Value

If the number of inactive parts in a single partition in the table exceeds the inactive_parts_to_delay_insert value,
an INSERT is artificially slowed down.

Default value: 0.

For details, see ClickHouse documentation.

inactive_parts_to_throw_insert

google.protobuf.Int64Value

If the number of inactive parts in a single partition more than the inactive_parts_to_throw_insert value,
INSERT is interrupted with an error.

Default value: 0.

For details, see ClickHouse documentation.

max_avg_part_size_for_too_many_parts

google.protobuf.Int64Value

The "Too many parts" check according to parts_to_delay_insert and parts_to_throw_insert will be active only if the average
part size (in the relevant partition) is not larger than the specified threshold. If it is larger than the specified threshold,
INSERT queries will be neither delayed or rejected. This allows to have hundreds of terabytes in a single table on a single server
if the parts are successfully merged to larger parts. This does not affect the thresholds on inactive parts or total parts.

Default value: 1073741824 (1 GiB).

For details, see ClickHouse documentation.

max_parts_in_total

google.protobuf.Int64Value

If the total number of active parts in all partitions of a table exceeds the max_parts_in_total value,
an INSERT is interrupted with the error "Too many parts (N)".

Default value: 20000 for versions 25.2 and higher, 100000 for versions 25.1 and lower.

For details, see ClickHouse documentation.

max_replicated_merges_in_queue

google.protobuf.Int64Value

How many tasks of merging and mutating parts are allowed simultaneously in ReplicatedMergeTree queue.

Default value: 16.

number_of_free_entries_in_pool_to_lower_max_size_of_merge

google.protobuf.Int64Value

When there is less than the specified number of free entries in pool (or replicated queue), start to lower maximum size of
merge to process (or to put in queue). This is to allow small merges to process - not filling the pool with long running merges.

Default value: 8.

For details, see ClickHouse documentation.

number_of_free_entries_in_pool_to_execute_mutation

google.protobuf.Int64Value

When there is less than specified number of free entries in pool, do not execute part mutations.
This is to leave free threads for regular merges and to avoid "Too many parts" errors.

Default value: 20.

For details, see ClickHouse documentation.

max_bytes_to_merge_at_min_space_in_pool

google.protobuf.Int64Value

The maximum total part size (in bytes) to be merged into one part, with the minimum available resources in the background pool.

Default value: 1048576 (1 MiB).

For details, see ClickHouse documentation.

max_bytes_to_merge_at_max_space_in_pool

google.protobuf.Int64Value

The maximum total parts size (in bytes) to be merged into one part, if there are enough resources available.
Corresponds roughly to the maximum possible part size created by an automatic background merge. 0 means merges will be disabled.

Default value: 161061273600 (150 GiB).

For details, see ClickHouse documentation.

min_bytes_for_wide_part

google.protobuf.Int64Value

Minimum number of bytes in a data part that can be stored in Wide format.

Default value: 10485760 (10 MiB).

For details, see ClickHouse documentation.

min_rows_for_wide_part

google.protobuf.Int64Value

Minimum number of rows in a data part that can be stored in Wide format.

Default value: 0.

For details, see ClickHouse documentation.

cleanup_delay_period

google.protobuf.Int64Value

Minimum period to clean old queue logs, blocks hashes and parts.

Default value: 30.

For details, see ClickHouse documentation.

max_cleanup_delay_period

google.protobuf.Int64Value

Maximum period to clean old queue logs, blocks hashes and parts.

Default value: 300 (5 minutes).

For details, see ClickHouse documentation.

merge_selecting_sleep_ms

google.protobuf.Int64Value

Minimum time to wait before trying to select parts to merge again after no parts were selected. A lower setting value will trigger
selecting tasks in background_schedule_pool frequently which result in large amount of requests to Keeper in large-scale clusters.

Default value: 5000 (5 seconds).

For details, see ClickHouse documentation.

max_merge_selecting_sleep_ms

google.protobuf.Int64Value

Maximum time to wait before trying to select parts to merge again after no parts were selected. A lower setting value will trigger
selecting tasks in background_schedule_pool frequently which result in large amount of requests to Keeper in large-scale clusters.

Default value: 60000 (1 minute).

For details, see ClickHouse documentation.

min_age_to_force_merge_seconds

google.protobuf.Int64Value

Merge parts if every part in the range is older than the specified value. 0 means disabled.

Default value: 0.

For details, see ClickHouse documentation.

min_age_to_force_merge_on_partition_only

google.protobuf.BoolValue

Whether min_age_to_force_merge_seconds should be applied only on the entire partition and not on subset.

Default value: false.

For details, see ClickHouse documentation.

merge_max_block_size

google.protobuf.Int64Value

The number of rows that are read from the merged parts into memory.

Default value: 8192.

For details, see ClickHouse documentation.

deduplicate_merge_projection_mode

enum DeduplicateMergeProjectionMode

Determines the behavior of background merges for MergeTree tables with projections.

Default value: DEDUPLICATE_MERGE_PROJECTION_MODE_THROW.

For details, see ClickHouse documentation.

• DEDUPLICATE_MERGE_PROJECTION_MODE_UNSPECIFIED
• DEDUPLICATE_MERGE_PROJECTION_MODE_IGNORE
• DEDUPLICATE_MERGE_PROJECTION_MODE_THROW
• DEDUPLICATE_MERGE_PROJECTION_MODE_DROP
• DEDUPLICATE_MERGE_PROJECTION_MODE_REBUILD

lightweight_mutation_projection_mode

enum LightweightMutationProjectionMode

Determines the behavior of lightweight deletes for MergeTree tables with projections.

Default value: LIGHTWEIGHT_MUTATION_PROJECTION_MODE_THROW.

For details, see ClickHouse documentation.

• LIGHTWEIGHT_MUTATION_PROJECTION_MODE_UNSPECIFIED
• LIGHTWEIGHT_MUTATION_PROJECTION_MODE_THROW
• LIGHTWEIGHT_MUTATION_PROJECTION_MODE_DROP
• LIGHTWEIGHT_MUTATION_PROJECTION_MODE_REBUILD

replicated_deduplication_window

google.protobuf.Int64Value

The number of most recently inserted blocks for which ClickHouse Keeper stores hash sums to check for duplicates.

Default value: 1000 for versions 23.11 and higher, 100 for versions 23.10 and lower.

For details, see ClickHouse documentation.

replicated_deduplication_window_seconds

google.protobuf.Int64Value

The number of seconds after which the hash sums of the inserted blocks are removed from ClickHouse Keeper.

Default value: 604800 (7 days).

For details, see ClickHouse documentation.

fsync_after_insert

google.protobuf.BoolValue

Do fsync for every inserted part. Significantly decreases performance of inserts, not recommended to use with wide parts.

Default value: false.

For details, see ClickHouse documentation.

fsync_part_directory

google.protobuf.BoolValue

Do fsync for part directory after all part operations (writes, renames, etc.).

Default value: false.

For details, see ClickHouse documentation.

min_compressed_bytes_to_fsync_after_fetch

google.protobuf.Int64Value

Minimal number of compressed bytes to do fsync for part after fetch. 0 means disabled.

Default value: 0.

For details, see ClickHouse documentation.

min_compressed_bytes_to_fsync_after_merge

google.protobuf.Int64Value

Minimal number of compressed bytes to do fsync for part after merge. 0 means disabled.

Default value: 0.

For details, see ClickHouse documentation.

min_rows_to_fsync_after_merge

google.protobuf.Int64Value

Minimal number of rows to do fsync for part after merge. 0 means disabled.

Default value: 0.

For details, see ClickHouse documentation.

ttl_only_drop_parts

google.protobuf.BoolValue

Controls whether data parts are fully dropped in MergeTree tables when all rows in that part have expired according to their TTL settings.

• true - the entire part is dropped if all rows in that part have expired according to their TTL settings.
• false - only the rows that have expired based on their TTL settings are removed.

Default value: false.

For details, see ClickHouse documentation.

merge_with_ttl_timeout

google.protobuf.Int64Value

Minimum delay in seconds before repeating a merge with delete TTL.

Default value: 14400 (4 hours).

For details, see ClickHouse documentation.

merge_with_recompression_ttl_timeout

google.protobuf.Int64Value

Minimum delay in seconds before repeating a merge with recompression TTL.

Default value: 14400 (4 hours).

For details, see ClickHouse documentation.

max_number_of_merges_with_ttl_in_pool

google.protobuf.Int64Value

When there is more than specified number of merges with TTL entries in pool, do not assign new merge with TTL.
This is to leave free threads for regular merges and avoid "Too many parts" errors.

Default value: 2.

For details, see ClickHouse documentation.

materialize_ttl_recalculate_only

google.protobuf.BoolValue

Only recalculate ttl info when MATERIALIZE TTL.

Default value: true for versions 25.2 and higher, false for versions 25.1 and lower.

For details, see ClickHouse documentation.

check_sample_column_is_correct

google.protobuf.BoolValue

Enables the check at table creation, that the data type of a column for sampling or sampling expression is correct.
The data type must be one of unsigned integer types: UInt8, UInt16, UInt32, UInt64.

Default value: true.

For details, see ClickHouse documentation.

allow_remote_fs_zero_copy_replication

google.protobuf.BoolValue

Setting is automatically enabled if cloud storage is enabled, disabled otherwise.

Default value: true.

Field

Description

method

enum Method

Required field. Compression method to use for the specified combination of min_part_size and min_part_size_ratio.

• METHOD_UNSPECIFIED
• LZ4: LZ4 compression algorithm.
• ZSTD: ZSTD compression algorithm.
• LZ4HC: LZ4 HC (high compression) algorithm.

min_part_size

int64

The minimum size of a data part.

min_part_size_ratio

double

The ratio of the data part size to the table size.

level

google.protobuf.Int64Value

Compression level.

Field

Description

name

string

Required field. Name of the external dictionary.

structure

Structure

Required field. Structure of the external dictionary.

layout

Layout

Required field. Layout determining how to store the dictionary in memory.

For details, see https://clickhouse.com/docs/sql-reference/dictionaries#ways-to-store-dictionaries-in-memory.

fixed_lifetime

int64

Fixed interval between dictionary updates.

Includes only one of the fields fixed_lifetime, lifetime_range.

lifetime_range

Range

Range of intervals between dictionary updates for ClickHouse to choose from.

Includes only one of the fields fixed_lifetime, lifetime_range.

http_source

HttpSource

HTTP source for the dictionary.

Includes only one of the fields http_source, mysql_source, clickhouse_source, mongodb_source, postgresql_source.

mysql_source

MysqlSource

MySQL source for the dictionary.

Includes only one of the fields http_source, mysql_source, clickhouse_source, mongodb_source, postgresql_source.

clickhouse_source

ClickhouseSource

ClickHouse source for the dictionary.

Includes only one of the fields http_source, mysql_source, clickhouse_source, mongodb_source, postgresql_source.

mongodb_source

MongodbSource

MongoDB source for the dictionary.

Includes only one of the fields http_source, mysql_source, clickhouse_source, mongodb_source, postgresql_source.

postgresql_source

PostgresqlSource

PostgreSQL source for the dictionary.

Includes only one of the fields http_source, mysql_source, clickhouse_source, mongodb_source, postgresql_source.

Field

Description

id

Id

Single numeric key column for the dictionary.

key

Key

Composite key for the dictionary, containing of one or more key columns.

For details, see ClickHouse documentation.

range_min

Attribute

Field holding the beginning of the range for dictionaries with RANGE_HASHED layout.

For details, see ClickHouse documentation.

range_max

Attribute

Field holding the end of the range for dictionaries with RANGE_HASHED layout.

For details, see ClickHouse documentation.

attributes[]

Attribute

Description of the fields available for database queries.

For details, see ClickHouse documentation.

Field

Description

name

string

Required field. Name of the numeric key.

Field

Description

attributes[]

Attribute

Attributes of a complex key.

Field

Description

name

string

Required field. Name of the column.

type

string

Required field. Type of the column.

null_value

string

Default value for an element without data (for example, an empty string).

expression

string

Expression, describing the attribute, if applicable.

hierarchical

bool

Indication of hierarchy support.

Default value: false.

injective

bool

Indication of injective mapping "id -> attribute".

Default value: false.

Field

Description

type

enum Type

Required field. Layout type.

For details, see ClickHouse documentation.

• TYPE_UNSPECIFIED
• FLAT: The dictionary is completely stored in memory in the form of flat arrays.
  Applicable only for dictionaries with numeric keys of the UInt64 type.
• HASHED: The dictionary is completely stored in memory in the form of a hash table.
  Applicable only for dictionaries with numeric keys of the UInt64 type.
• COMPLEX_KEY_HASHED: The dictionary is completely stored in memory in the form of a hash table.
  Applicable for dictionaries with composite keys of arbitrary type.
• RANGE_HASHED: The dictionary is stored in memory in the form of a hash table with an ordered array of ranges and their corresponding values.
  Applicable only for dictionaries with numeric keys of the UInt64 type.
• CACHE: The dictionary is stored in a cache that has a fixed number of cells. These cells contain frequently used elements.
  Applicable only for dictionaries with numeric keys of the UInt64 type.
• COMPLEX_KEY_CACHE: The dictionary is stored in a cache that has a fixed number of cells. These cells contain frequently used elements.
  Applicable for dictionaries with composite keys of arbitrary type.
• SPARSE_HASHED: The dictionary is completely stored in memory in the form of a hash table.
  It's similar to HASHED layout type but uses less memory in favor of more CPU usage.
  Applicable only for dictionaries with numeric keys of the UInt64 type.
• COMPLEX_KEY_SPARSE_HASHED: The dictionary is completely stored in memory in the form of a hash table.
  It's similar to COMPLEX_KEY_HASHED layout type but uses less memory in favor of more CPU usage.
  Applicable for dictionaries with composite keys of arbitrary type.
• COMPLEX_KEY_RANGE_HASHED: The dictionary is stored in memory in the form of a hash table with an ordered array of ranges and their corresponding values.
  Applicable for dictionaries with composite keys of arbitrary type.
• DIRECT: The dictionary is not stored in memory and directly goes to the source during the processing of a request.
  Applicable only for dictionaries with numeric keys of the UInt64 type.
• COMPLEX_KEY_DIRECT: The dictionary is not stored in memory and directly goes to the source during the processing of a request.
  Applicable for dictionaries with composite keys of arbitrary type.
• IP_TRIE: The specialized layout type for mapping network prefixes (IP addresses) to metadata such as ASN.

size_in_cells

int64

Number of cells in the cache. Rounded up to a power of two.
Applicable only for CACHE and COMPLEX_KEY_CACHE layout types.

Default value: 1000000000.

For details, see ClickHouse documentation.

allow_read_expired_keys

google.protobuf.BoolValue

Allows to read expired keys.
Applicable only for CACHE and COMPLEX_KEY_CACHE layout types.

Default value: false.

For details, see ClickHouse documentation.

max_update_queue_size

int64

Max size of update queue.
Applicable only for CACHE and COMPLEX_KEY_CACHE layout types.

Default value: 100000.

For details, see ClickHouse documentation.

update_queue_push_timeout_milliseconds

int64

Max timeout in milliseconds for push update task into queue.
Applicable only for CACHE and COMPLEX_KEY_CACHE layout types.

Default value: 10.

For details, see ClickHouse documentation.

query_wait_timeout_milliseconds

int64

Max wait timeout in milliseconds for update task to complete.
Applicable only for CACHE and COMPLEX_KEY_CACHE layout types.

Default value: 60000 (1 minute).

For details, see ClickHouse documentation.

max_threads_for_updates

int64

Max threads for cache dictionary update.
Applicable only for CACHE and COMPLEX_KEY_CACHE layout types.

Default value: 4.

For details, see ClickHouse documentation.

initial_array_size

int64

Initial dictionary key size.
Applicable only for FLAT layout type.

Default value: 1024.

For details, see ClickHouse documentation.

max_array_size

int64

Maximum dictionary key size.
Applicable only for FLAT layout type.

Default value: 500000.

For details, see ClickHouse documentation.

access_to_key_from_attributes

google.protobuf.BoolValue

Allows to retrieve key attribute using dictGetString function.
Enabling this option increases memory usage.
Applicable only for IP_TRIE layout type.

For details, see ClickHouse documentation.

Field

Description

min

int64

Minimum dictionary lifetime.

max

int64

Maximum dictionary lifetime.

Field

Description

url

string

Required field. URL of the source dictionary available over HTTP.

format

string

Required field. The data format. Valid values are all formats supported by ClickHouse SQL dialect.

headers[]

Header

HTTP headers.

Field

Description

name

string

Required field. Header name.

value

string

Required field. Header value.

Field

Description

db

string

Required field. Database name.

table

string

Required field. Table name.

port

int64

Port to use when connecting to a replica of the dictionary source.

user

string

Required field. Name of the user for replicas of the dictionary source.

password

string

Password of the user for replicas of the dictionary source.

replicas[]

Replica

List of MySQL replicas of the database used as dictionary source.

where

string

Selection criteria for the data in the specified MySQL table.

invalidate_query

string

Query for checking the dictionary status, to pull only updated data.

close_connection

google.protobuf.BoolValue

Should a connection be closed after each request.

share_connection

google.protobuf.BoolValue

Should a connection be shared for some requests.

Field

Description

host

string

Required field. MySQL host of the replica.

priority

int64

The priority of the replica that ClickHouse takes into account when connecting.
Replica with the highest priority should have this field set to the lowest number.

port

int64

Port to use when connecting to the replica.
If a port is not specified for a replica, ClickHouse uses the port specified for the source.

user

string

Name of the MySQL database user.
If a user is not specified for a replica, ClickHouse uses the user specified for the source.

password

string

Password of the MySQL database user.
If a password is not specified for a replica, ClickHouse uses the password specified for the source.

Field

Description

db

string

Required field. Database name.

table

string

Required field. Table name.

host

string

ClickHouse host.

port

int64

Port to use when connecting to the host.

user

string

Required field. Name of the ClickHouse database user.

password

string

Password of the ClickHouse database user.

where

string

Selection criteria for the data in the specified ClickHouse table.

secure

google.protobuf.BoolValue

Determines whether to use TLS for connection.

Field

Description

db

string

Required field. Database name.

collection

string

Required field. Collection name.

host

string

Required field. MongoDB host.

port

int64

Port to use when connecting to the host.

user

string

Required field. Name of the MongoDB database user.

password

string

Password of the MongoDB database user.

options

string

Dictionary source options.

Field

Description

db

string

Required field. Database name.

table

string

Required field. Table name.

hosts[]

string

PostgreSQL hosts.

port

int64

Port to use when connecting to the PostgreSQL hosts.

user

string

Required field. Name of the PostrgreSQL database user.

password

string

Password of the PostrgreSQL database user.

invalidate_query

string

Query for checking the dictionary status, to pull only updated data.

ssl_mode

enum SslMode

Mode of SSL TCP/IP connection to the PostgreSQL host.

• SSL_MODE_UNSPECIFIED
• DISABLE: Only try a non-SSL connection.
• ALLOW: First try a non-SSL connection; if that fails, try an SSL connection.
• PREFER: First try an SSL connection; if that fails, try a non-SSL connection.
• VERIFY_CA: Only try an SSL connection, and verify that the server certificate is issued by a trusted certificate authority (CA).
• VERIFY_FULL: Only try an SSL connection, verify that the server certificate is issued by a trusted CA and that the requested server host name matches that in the certificate.

Field

Description

name

string

Required field. Name for the specified combination of settings for Graphite rollup.

patterns[]

Pattern

Pattern to use for the rollup.

path_column_name

string

The name of the column storing the metric name (Graphite sensor).

Default value: Path.

time_column_name

string

The name of the column storing the time of measuring the metric.

Default value: Time.

value_column_name

string

The name of the column storing the value of the metric at the time set in time_column_name.

Default value: Value.

version_column_name

string

The name of the column storing the version of the metric.

Default value: Timestamp.

Field

Description

regexp

string

A pattern for the metric name (a regular or DSL).

function

string

The name of the aggregating function to apply to data whose age falls within the range [age, age + precision].
Accepted functions: min, max, any, avg. The average is calculated imprecisely, like the average of the averages.

retention[]

Retention

Retention rules.

Field

Description

age

int64

The minimum age of the data in seconds.

precision

int64

Precision of determining the age of the data, in seconds. Should be a divisor for 86400 (seconds in a day).

Field

Description

security_protocol

enum SecurityProtocol

Protocol used to communicate with brokers.

Default value: SECURITY_PROTOCOL_PLAINTEXT.

• SECURITY_PROTOCOL_UNSPECIFIED
• SECURITY_PROTOCOL_PLAINTEXT
• SECURITY_PROTOCOL_SSL
• SECURITY_PROTOCOL_SASL_PLAINTEXT
• SECURITY_PROTOCOL_SASL_SSL

sasl_mechanism

enum SaslMechanism

SASL mechanism to use for authentication.

Default value: SASL_MECHANISM_GSSAPI.

• SASL_MECHANISM_UNSPECIFIED
• SASL_MECHANISM_GSSAPI
• SASL_MECHANISM_PLAIN
• SASL_MECHANISM_SCRAM_SHA_256
• SASL_MECHANISM_SCRAM_SHA_512

sasl_username

string

SASL username for use with the PLAIN and SASL-SCRAM mechanisms.

sasl_password

string

SASL password for use with the PLAIN and SASL-SCRAM mechanisms.

enable_ssl_certificate_verification

google.protobuf.BoolValue

Enable OpenSSL's builtin broker (server) certificate verification.

Default value: true.

max_poll_interval_ms

google.protobuf.Int64Value

Maximum allowed time between calls to consume messages for high-level consumers.
If this interval is exceeded the consumer is considered failed and the group will
rebalance in order to reassign the partitions to another consumer group member.

Default value: 300000 (5 minutes).

session_timeout_ms

google.protobuf.Int64Value

Client group session and failure detection timeout. The consumer sends periodic heartbeats (heartbeat.interval.ms)
to indicate its liveness to the broker. If no hearts are received by the broker for a group member within
the session timeout, the broker will remove the consumer from the group and trigger a rebalance.

Default value: 45000 (45 seconds).

debug

enum Debug

Debug context to enable.

• DEBUG_UNSPECIFIED
• DEBUG_GENERIC
• DEBUG_BROKER
• DEBUG_TOPIC
• DEBUG_METADATA
• DEBUG_FEATURE
• DEBUG_QUEUE
• DEBUG_MSG
• DEBUG_PROTOCOL
• DEBUG_CGRP
• DEBUG_SECURITY
• DEBUG_FETCH
• DEBUG_INTERCEPTOR
• DEBUG_PLUGIN
• DEBUG_CONSUMER
• DEBUG_ADMIN
• DEBUG_EOS
• DEBUG_MOCK
• DEBUG_ASSIGNOR
• DEBUG_CONF
• DEBUG_TELEMETRY
• DEBUG_ALL

auto_offset_reset

enum AutoOffsetReset

Action to take when there is no initial offset in offset store or the desired offset is out of range.

Default value: AUTO_OFFSET_RESET_LARGEST.

• AUTO_OFFSET_RESET_UNSPECIFIED
• AUTO_OFFSET_RESET_SMALLEST
• AUTO_OFFSET_RESET_EARLIEST
• AUTO_OFFSET_RESET_BEGINNING
• AUTO_OFFSET_RESET_LARGEST
• AUTO_OFFSET_RESET_LATEST
• AUTO_OFFSET_RESET_END
• AUTO_OFFSET_RESET_ERROR

Field

Description

name

string

Required field. Kafka topic name.

settings

Kafka

Required field. Kafka topic settings.

Field

Description

username

string

RabbitMQ username.

password

string

RabbitMQ password.

vhost

string

RabbitMQ virtual host.

Field

Description

name

string

Name for the rule.

regexp

string

Required field. RE2 compatible regular expression.

replace

string

Substitution string for sensitive data.

Default value: six asterisks.

Field

Description

max_size_in_bytes

google.protobuf.Int64Value

The maximum cache size in bytes.

Default value: 1073741824 (1 GiB).

max_entries

google.protobuf.Int64Value

The maximum number of SELECT query results stored in the cache.

Default value: 1024.

max_entry_size_in_bytes

google.protobuf.Int64Value

The maximum size in bytes SELECT query results may have to be saved in the cache.

Default value: 1048576 (1 MiB).

max_entry_size_in_rows

google.protobuf.Int64Value

The maximum number of rows SELECT query results may have to be saved in the cache.

Default value: 30000000.

Field

Description

host

string

Required field. Host of jdbc bridge.

port

google.protobuf.Int64Value

Port of jdbc bridge.

Default value: 9019.

Field

Description

name

string

Required field. Name of the macro.

value

string

Required field. Value of the macro.

Field

Description

resource_preset_id

string

ID of the preset for computational resources available to a host (CPU, memory etc.).
All available presets are listed in the documentation

disk_size

int64

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

disk_type_id

string

Type of the storage environment for the host.
Possible values:

• network-hdd - network HDD drive,
• network-ssd - network SSD drive,
• local-ssd - local SSD storage.

Field

Description

planned_usage_threshold

google.protobuf.Int64Value

Amount of used storage for automatic disk scaling in the maintenance window, 0 means disabled, in percent.

emergency_usage_threshold

google.protobuf.Int64Value

Amount of used storage for immediately automatic disk scaling, 0 means disabled, in percent.

disk_size_limit

google.protobuf.Int64Value

Limit on how large the storage for database instances can automatically grow, in bytes.

Field

Description

resources

Resources

Resources allocated to ZooKeeper hosts. If not set, minimal available resources will be used.
All available resource presets can be retrieved with a ResourcePresetService.List request.

disk_size_autoscaling

DiskSizeAutoscaling

Disk size autoscaling settings.

Field

Description

data_lens

bool

Allow to export data from the cluster to DataLens.

web_sql

bool

Allow SQL queries to the cluster databases from the management console.

See SQL queries in the management console for more details.

metrika

bool

Allow to import data from Yandex Metrica and AppMetrica to the cluster.

See AppMetrica documentation for more details.

serverless

bool

Allow access to cluster for Serverless.

data_transfer

bool

Allow access for DataTransfer

yandex_query

bool

Allow access for Query

Field

Description

enabled

bool

Whether to use Object Storage for storing ClickHouse data.

move_factor

google.protobuf.DoubleValue

data_cache_enabled

google.protobuf.BoolValue

data_cache_max_size

google.protobuf.Int64Value

prefer_not_to_merge

google.protobuf.BoolValue

Field

Description

name

string

Required field. Name of the ClickHouse database. 1-63 characters long.

engine

enum DatabaseEngine

Database engine. For details, see ClickHouse documentation.

• DATABASE_ENGINE_UNSPECIFIED
• DATABASE_ENGINE_ATOMIC
• DATABASE_ENGINE_REPLICATED

Field

Description

name

string

Required field. User name.

password

string

User password.

generate_password

google.protobuf.BoolValue

Enable or disable password generation using Connection Manager.

Default value: false.

permissions[]

Permission

Set of permissions to grant to the user. If not set, it's granted permissions to access all databases.

settings

UserSettings

User settings

quotas[]

UserQuota

Quotas assigned to the user.

Field

Description

database_name

string

Name of the database that the permission grants access to.

Field

Description

readonly

google.protobuf.Int64Value

Restricts permissions for non-DDL queries. To restrict permissions for DDL queries, use allow_ddl instead.

• 0 - no restrictions.
• 1 - only read data queries are allowed.
• 2 - read data and change settings queries are allowed.

Default value: 0.

For details, see ClickHouse documentation.

allow_ddl

google.protobuf.BoolValue

Allows or denies DDL queries (e.g., CREATE, ALTER, RENAME, etc).

Default value: true.

For details, see ClickHouse documentation.

allow_introspection_functions

google.protobuf.BoolValue

Enables or disables introspection functions for query profiling.

Default value: false.

For details, see ClickHouse documentation.

connect_timeout

google.protobuf.Int64Value

Connection timeout in milliseconds.

Default value: 10000 (10 seconds).

For details, see ClickHouse documentation.

connect_timeout_with_failover

google.protobuf.Int64Value

The timeout in milliseconds for connecting to a remote server for a Distributed table engine.

Applies only if the cluster uses sharding and replication. If unsuccessful, several attempts are made to connect to various replicas.

Default value: 1000 (1 second).

For details, see ClickHouse documentation.

receive_timeout

google.protobuf.Int64Value

Receive timeout in milliseconds.

Default value: 300000 (5 minutes).

For details, see ClickHouse documentation.

send_timeout

google.protobuf.Int64Value

Send timeout in milliseconds.

Default value: 300000 (5 minutes).

For details, see ClickHouse documentation.

idle_connection_timeout

google.protobuf.Int64Value

Timeout to close idle TCP connections after specified time has elapsed, in milliseconds.

Default value: 3600000 (1 hour).

For details, see ClickHouse documentation.

timeout_before_checking_execution_speed

google.protobuf.Int64Value

Checks that the speed is not too low after the specified time has elapsed, in milliseconds. It is checked that execution speed
is not less that specified in min_execution_speed parameter.

Default value: 60000 (1 minute).

For details, see ClickHouse documentation.

insert_quorum

google.protobuf.Int64Value

Enables or disables the quorum writes. If the value is less than 2, then the quorum writes is disabled, otherwise it is enabled.

When used, write quorum guarantees that ClickHouse has written data to the quorum of insert_quorum replicas with no errors
until the insert_quorum_timeout expires. All replicas in the quorum are in the consistent state, meaning that they contain
linearized data from the previous INSERT queries. Employ write quorum, if you need the guarantees that the written data
would not be lost in case of one or more replicas failure.

You can use select_sequential_consistency setting to read the data written with write quorum.

Default value: 0.

For details, see ClickHouse documentation.

insert_quorum_timeout

google.protobuf.Int64Value

Quorum write timeout in milliseconds.

If the write quorum is enabled in the cluster, this timeout expires and some data is not written to the insert_quorum replicas,
then ClickHouse will abort the execution of INSERT query and return an error. In this case, the client must send the query again
to write the data block into the same or another replica.

Default value: 600000 (10 minutes).

For details, see ClickHouse documentation.

insert_quorum_parallel

google.protobuf.BoolValue

Enables or disables parallelism for quorum INSERT queries.

Default value: true.

For details, see ClickHouse documentation.

select_sequential_consistency

google.protobuf.BoolValue

Determines the behavior of SELECT queries from replicated tables. If enabled, ClickHouse will terminate a query with error message in case
the replica does not have a chunk written with the quorum and will not read the parts that have not yet been written with the quorum.

Default value: true.

For details, see ClickHouse documentation.

replication_alter_partitions_sync

google.protobuf.Int64Value

Wait mode for asynchronous actions in ALTER queries on replicated tables.

• 0 - do not wait for replicas.
• 1 - only wait for own execution.
• 2 - wait for all replicas.

Default value: 1.

For details, see ClickHouse documentation.

max_replica_delay_for_distributed_queries

google.protobuf.Int64Value

Max replica delay in milliseconds. If a replica lags more than the set value, this replica is not used and becomes a stale one.

Default value: 300000 (5 minutes).

For details, see ClickHouse documentation.

fallback_to_stale_replicas_for_distributed_queries

google.protobuf.BoolValue

Enables or disables query forcing to a stale replica in case the actual data is unavailable.
If enabled, ClickHouse will choose the most up-to-date replica and force the query to use the data in this replica.
This setting can be used when doing SELECT query from a distributed table that points to replicated tables.

Default value: true.

For details, see ClickHouse documentation.

distributed_product_mode

enum DistributedProductMode

Determines the behavior of distributed subqueries.

Default value: DISTRIBUTED_PRODUCT_MODE_DENY.

For details, see ClickHouse documentation.

• DISTRIBUTED_PRODUCT_MODE_UNSPECIFIED
• DISTRIBUTED_PRODUCT_MODE_DENY: Prohibits using these types of subqueries (returns the "Double-distributed in/JOIN subqueries is denied" exception).
• DISTRIBUTED_PRODUCT_MODE_LOCAL: Replaces the database and table in the subquery with local ones for the destination server (shard), leaving the normal IN/JOIN.
• DISTRIBUTED_PRODUCT_MODE_GLOBAL: Replaces the IN/JOIN query with GLOBAL IN/GLOBAL JOIN.
• DISTRIBUTED_PRODUCT_MODE_ALLOW: Allows the use of these types of subqueries.

distributed_aggregation_memory_efficient

google.protobuf.BoolValue

Enables of disables memory saving mode when doing distributed aggregation.

When ClickHouse works with a distributed query, external aggregation is done on remote servers.
Enable this setting to achieve a smaller memory footprint on the server that sourced such a distributed query.

Default value: true.

For details, see ClickHouse documentation.

distributed_ddl_task_timeout

google.protobuf.Int64Value

Timeout for DDL queries, in milliseconds.

Default value: 180000 (3 minutes).

For details, see ClickHouse documentation.

distributed_ddl_output_mode

enum DistributedDdlOutputMode

Determines the format of distributed DDL query result.

Default value: DISTRIBUTED_DDL_OUTPUT_MODE_THROW.

For details, see ClickHouse documentation.

• DISTRIBUTED_DDL_OUTPUT_MODE_UNSPECIFIED
• DISTRIBUTED_DDL_OUTPUT_MODE_THROW: Returns result set with query execution status for all hosts where query is finished. If query has failed on some hosts, then it will rethrow the first exception.
  If query is not finished yet on some hosts and distributed_ddl_task_timeout exceeded, then it throws TIMEOUT_EXCEEDED exception.
• DISTRIBUTED_DDL_OUTPUT_MODE_NONE: Like DISTRIBUTED_DDL_OUTPUT_MODE_THROW, but distributed DDL query returns no result set.
• DISTRIBUTED_DDL_OUTPUT_MODE_NULL_STATUS_ON_TIMEOUT: Returns NULL as execution status in some rows of result set instead of throwing TIMEOUT_EXCEEDED if query is not finished on the corresponding hosts.
• DISTRIBUTED_DDL_OUTPUT_MODE_NEVER_THROW: Do not throw TIMEOUT_EXCEEDED and do not rethrow exceptions if query has failed on some hosts.
• DISTRIBUTED_DDL_OUTPUT_MODE_NONE_ONLY_ACTIVE: Like DISTRIBUTED_DDL_OUTPUT_MODE_NONE, but doesn't wait for inactive replicas of the Replicated database.
  With this mode it's impossible to figure out that the query was not executed on some replica and will be executed in background.
• DISTRIBUTED_DDL_OUTPUT_MODE_NULL_STATUS_ON_TIMEOUT_ONLY_ACTIVE: Like DISTRIBUTED_DDL_OUTPUT_MODE_NULL_STATUS_ON_TIMEOUT, but doesn't wait for inactive replicas of the Replicated database.
• DISTRIBUTED_DDL_OUTPUT_MODE_THROW_ONLY_ACTIVE: Like DISTRIBUTED_DDL_OUTPUT_MODE_THROW, but doesn't wait for inactive replicas of the Replicated database.

skip_unavailable_shards

google.protobuf.BoolValue

Enables or disables silent skipping of unavailable shards.

A shard is considered unavailable if all its replicas are also unavailable.

Default value: false.

For details, see ClickHouse documentation.

use_hedged_requests

google.protobuf.BoolValue

Enables or disables hedged requests logic for remote queries.

It allows to establish many connections with different replicas for query. New connection is enabled in case existent connection(s) with replica(s)
were not established within hedged_connection_timeout or no data was received within receive_data_timeout. Query uses the first connection
which send non empty progress packet, other connections are cancelled.

Default value: true.

For details, see ClickHouse documentation.

hedged_connection_timeout_ms

google.protobuf.Int64Value

Connection timeout for establishing connection with replica for Hedged requests.

Default value: 50.

For details, see ClickHouse documentation.

load_balancing

enum LoadBalancing

Algorithm of replicas selection that is used for distributed query processing.

Default value: LOAD_BALANCING_RANDOM.

For details, see ClickHouse documentation.

• LOAD_BALANCING_UNSPECIFIED
• LOAD_BALANCING_RANDOM
• LOAD_BALANCING_NEAREST_HOSTNAME
• LOAD_BALANCING_IN_ORDER
• LOAD_BALANCING_FIRST_OR_RANDOM
• LOAD_BALANCING_ROUND_ROBIN

prefer_localhost_replica

google.protobuf.BoolValue

Enable or disable preferable using the localhost replica when processing distributed queries.

Default value: true.

For details, see ClickHouse documentation.

compile_expressions

google.protobuf.BoolValue

Enable or disable expression compilation to native code.

If you execute a lot of queries that contain identical expressions, then enable this setting.
As a result, such queries may be executed faster due to use of compiled expressions.

Use this setting in combination with min_count_to_compile_expression setting.

Default value: true for versions 25.5 and higher, false for versions 25.4 and lower.

For details, see ClickHouse documentation.

min_count_to_compile_expression

google.protobuf.Int64Value

How many identical expressions ClickHouse has to encounter before they are compiled.

For the 0 value compilation is synchronous: a query waits for expression compilation process to complete prior to continuing execution.
It is recommended to set this value only for testing purposes.

For all other values, compilation is asynchronous: the compilation process executes in a separate thread.
When a compiled expression is ready, it will be used by ClickHouse for eligible queries, including the ones that are currently running.

Default value: 3.

For details, see ClickHouse documentation.

max_block_size

google.protobuf.Int64Value

Sets the recommended maximum number of rows to include in a single block when loading data from tables.

Blocks the size of max_block_size are not always loaded from the table: if ClickHouse determines that less data needs to be retrieved,
a smaller block is processed.

The block size should not be too small to avoid noticeable costs when processing each block. It should also not be too large to ensure that
queries with a LIMIT clause execute quickly after processing the first block. When setting max_block_size, the goal should be to avoid
consuming too much memory when extracting a large number of columns in multiple threads and to preserve at least some cache locality.

Default value: 65409.

For details, see ClickHouse documentation.

min_insert_block_size_rows

google.protobuf.Int64Value

Limits the minimum number of rows in a block to be inserted in a table by INSERT query. Blocks that are smaller than the specified value,
will be squashed together into the bigger blocks. If set to 0, block squashing is disabled.

Default value: 1048449.

For details, see ClickHouse documentation.

min_insert_block_size_bytes

google.protobuf.Int64Value

Limits the minimum number of bytes in a block to be inserted in a table by INSERT query. Blocks that are smaller than the specified value,
will be squashed together into the bigger blocks. If set to 0, block squashing is disabled.

Default value: 268402944.

For details, see ClickHouse documentation.

max_insert_block_size

google.protobuf.Int64Value

The size of blocks (in a count of rows) to form for insertion into a table.

This setting only applies in cases when the server forms the blocks. For example, for an INSERT via the HTTP interface, the server parses
the data format and forms blocks of the specified size. But when using clickhouse-client, the client parses the data itself, and
the max_insert_block_size setting on the server does not affect the size of the inserted blocks. The setting also does not have a purpose
when using INSERT SELECT, since data is inserted using the same blocks that are formed after SELECT.

Default value: 1048449.

For details, see ClickHouse documentation.

max_partitions_per_insert_block

google.protobuf.Int64Value

When inserting data, ClickHouse calculates the number of partitions in the inserted block.
If the number of partitions is more than max_partitions_per_insert_block, ClickHouse throws an exception.

Default value: 100.

For details, see ClickHouse documentation.

min_bytes_to_use_direct_io

google.protobuf.Int64Value

Limits the minimum number of bytes to enable unbuffered direct reads from disk (Direct I/O). If set to 0, Direct I/O is disabled.

By default, ClickHouse does not read data directly from disk, but relies on the filesystem and its cache instead. Such reading strategy
is effective when the data volume is small. If the amount of the data to read is huge, it is more effective to read directly from the disk,
bypassing the filesystem cache.

Default value: 0.

For details, see ClickHouse documentation.

use_uncompressed_cache

google.protobuf.BoolValue

Determines whether to use the cache of uncompressed blocks, or not.

Using this cache can significantly reduce latency and increase the throughput when a huge amount of small queries is to be processed.
Enable this setting for the users who instantiates small queries frequently.

This setting has effect only for tables of the MergeTree family.

Default value: false.

For details, see ClickHouse documentation.

merge_tree_max_rows_to_use_cache

google.protobuf.Int64Value

Limits the maximum size in rows of the request that can use the cache of uncompressed data. The cache is not used for requests larger than the specified value.

Use this setting in combination with use_uncompressed_cache setting.

Default value: 1048576.

For details, see ClickHouse documentation.

merge_tree_max_bytes_to_use_cache

google.protobuf.Int64Value

Limits the maximum size in bytes of the request that can use the cache of uncompressed data. The cache is not used for requests larger than the specified value.

Use this setting in combination with use_uncompressed_cache setting.

Default value: 2013265920 (1920 MiB).

For details, see ClickHouse documentation.

merge_tree_min_rows_for_concurrent_read

google.protobuf.Int64Value

Limits the minimum number of rows to be read from a file to enable concurrent read.
If the number of rows to be read exceeds this value, then ClickHouse will try to use a few threads to read from a file concurrently.

This setting has effect only for tables of the MergeTree family.

Default value: 163840.

For details, see ClickHouse documentation.

merge_tree_min_bytes_for_concurrent_read

google.protobuf.Int64Value

Limits the number of bytes to be read from a file to enable concurrent read.
If the number of bytes to be read exceeds this value, then ClickHouse will try to use a few threads to read from a file concurrently.

This setting has effect only for tables of the MergeTree family.

Default value: 251658240 (240 MiB).

For details, see ClickHouse documentation.

max_bytes_before_external_group_by

google.protobuf.Int64Value

Sets the threshold of RAM consumption (in bytes) after that the temporary data, collected during the GROUP BY operation,
should be flushed to disk to limit the RAM consumption. If set to 0, GROUP BY in the external memory is disabled.

By default, aggregation is done by employing hash table that resides in RAM. A query can result in aggregation of huge data
volumes that can lead to memory exhaustion and abortion of the query (see the max_memory_usage setting). For such queries,
you can use this setting to force ClickHouse to do flushing and complete aggregation successfully.

Default value: 0.

For details, see ClickHouse documentation.

max_bytes_before_external_sort

google.protobuf.Int64Value

Sets the threshold of RAM consumption (in bytes) after that the temporary data, collected during the ORDER BY operation,
should be flushed to disk to limit the RAM consumption. If set to 0, ORDER BY in the external memory is disabled.

Default value: 0.

For details, see ClickHouse documentation.

group_by_two_level_threshold

google.protobuf.Int64Value

Sets the threshold of the number of keys, after that the two-level aggregation should be used. 0 means threshold is not set.

Default value: 100000.

For details, see ClickHouse documentation.

group_by_two_level_threshold_bytes

google.protobuf.Int64Value

Sets the threshold of the number of bytes, after that the two-level aggregation should be used. 0 means threshold is not set.

Default value: 50000000.

For details, see ClickHouse documentation.

deduplicate_blocks_in_dependent_materialized_views

google.protobuf.BoolValue

Enables or disables the deduplication check for materialized views that receive data from replicated tables.

Default value: false.

For details, see ClickHouse documentation.

local_filesystem_read_method

enum LocalFilesystemReadMethod

Method of reading data from local filesystem.

The LOCAL_FILESYSTEM_READ_METHOD_IO_URING 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.

For details, see ClickHouse documentation.

• LOCAL_FILESYSTEM_READ_METHOD_UNSPECIFIED
• LOCAL_FILESYSTEM_READ_METHOD_READ
• LOCAL_FILESYSTEM_READ_METHOD_PREAD_THREADPOOL
• LOCAL_FILESYSTEM_READ_METHOD_PREAD
• LOCAL_FILESYSTEM_READ_METHOD_NMAP
• LOCAL_FILESYSTEM_READ_METHOD_IO_URING

remote_filesystem_read_method

enum RemoteFilesystemReadMethod

Method of reading data from remote filesystem.

Default value: REMOTE_FILESYSTEM_READ_METHOD_THREADPOOL.

For details, see ClickHouse documentation.

• REMOTE_FILESYSTEM_READ_METHOD_UNSPECIFIED
• REMOTE_FILESYSTEM_READ_METHOD_READ
• REMOTE_FILESYSTEM_READ_METHOD_THREADPOOL

priority

google.protobuf.Int64Value

Sets the priority of a query.

• 0 - priorities are not used.
• 1 - the highest priority.
• and so on. The higher the number, the lower a query's priority.

If ClickHouse is working with the high-priority queries, and a low-priority query enters, then the low-priority query
is paused until higher-priority queries are completed.

Default value: 0.

For details, see ClickHouse documentation.

max_threads

google.protobuf.Int64Value

Limits the maximum number of threads to process the request. If set to 0, the number of threads is calculated automatically based on the number of available CPU cores.

The setting applies to threads that perform the same stages of the query processing pipeline in parallel. It does not take threads that read data from remote servers into account.

For details, see ClickHouse documentation.

max_insert_threads

google.protobuf.Int64Value

The maximum number of threads to execute the INSERT SELECT query.

Default value: 0.

For details, see ClickHouse documentation.

max_memory_usage

google.protobuf.Int64Value

Limits the maximum memory usage (in bytes) for processing of a single user's query on a single server. 0 means unlimited.

This limitation is enforced for any user's single query on a single server.

If you use max_bytes_before_external_group_by or max_bytes_before_external_sort setting, then it is recommended to set
their values twice as low as max_memory_usage setting value.

Default value: 0.

For details, see ClickHouse documentation.

max_memory_usage_for_user

google.protobuf.Int64Value

Limits the maximum memory usage (in bytes) for processing of user's queries on a single server. 0 means unlimited.

This limitation is enforced for all queries that belong to one user and run simultaneously on a single server.

Default value: 0.

For details, see ClickHouse documentation.

memory_overcommit_ratio_denominator

google.protobuf.Int64Value

It represents the soft memory limit when the hard limit is reached on the global level.
This value is used to compute the overcommit ratio for the query. 0 means skip the query.

Default value: 1073741824 (1 GiB).

For details, see ClickHouse documentation.

memory_overcommit_ratio_denominator_for_user

google.protobuf.Int64Value

It represents the soft memory limit when the hard limit is reached on the user level.
This value is used to compute the overcommit ratio for the user. 0 means skip the query.

Default value: 1073741824 (1 GiB).

For details, see ClickHouse documentation.

memory_usage_overcommit_max_wait_microseconds

google.protobuf.Int64Value

Maximum time thread will wait for memory to be freed in the case of memory overcommit. If the timeout is reached and memory is not freed, an exception is thrown.

Default value: 5000000 (5 seconds).

For details, see ClickHouse documentation.

max_network_bandwidth

google.protobuf.Int64Value

The maximum speed of data exchange over the network in bytes per second for a query. 0 means unlimited.

Default value: 0.

For details, see ClickHouse documentation.

max_network_bandwidth_for_user

google.protobuf.Int64Value

The maximum speed of data exchange over the network in bytes per second for all concurrently running user queries. 0 means unlimited.

Default value: 0.

For details, see ClickHouse documentation.

max_temporary_data_on_disk_size_for_query

google.protobuf.Int64Value

The maximum amount of data consumed by temporary files on disk in bytes for all concurrently running queries. 0 means unlimited.

Default value: 0.

For details, see ClickHouse documentation.

max_temporary_data_on_disk_size_for_user

google.protobuf.Int64Value

The maximum amount of data consumed by temporary files on disk in bytes for all concurrently running user queries. 0 means unlimited.

Default value: 0.

For details, see ClickHouse documentation.

max_concurrent_queries_for_user

google.protobuf.Int64Value

The maximum number of simultaneously processed queries per user. 0 means unlimited.

Default value: 0.

For details, see ClickHouse documentation.

force_index_by_date

google.protobuf.BoolValue

Disables query execution if the index cannot be used by date.

This setting has effect only for tables of the MergeTree family.

Default value: false.

For details, see ClickHouse documentation.

force_primary_key

google.protobuf.BoolValue

Disables query execution if indexing by the primary key cannot be used.

This setting has effect only for tables of the MergeTree family.

Default value: false.

For details, see ClickHouse documentation.

max_rows_to_read

google.protobuf.Int64Value

Limits the maximum number of rows that can be read from a table when running a query. 0 means unlimited.

Default value: 0.

For details, see ClickHouse documentation.

max_bytes_to_read

google.protobuf.Int64Value

Limits the maximum number of bytes (uncompressed data) that can be read from a table when running a query. 0 means unlimited.

Default value: 0.

For details, see ClickHouse documentation.

read_overflow_mode

enum OverflowMode

Determines the behavior on exceeding limits while reading the data.

Default value: OVERFLOW_MODE_THROW.

For details, see ClickHouse documentation.

• OVERFLOW_MODE_UNSPECIFIED
• OVERFLOW_MODE_THROW: Abort query execution and return an error.
• OVERFLOW_MODE_BREAK: Return a partial result.

max_rows_to_group_by

google.protobuf.Int64Value

Limits the maximum number of unique keys received from aggregation. 0 means unlimited.
This setting lets you limit RAM consumption when aggregating.

Default value: 0.

For details, see ClickHouse documentation.

group_by_overflow_mode

enum GroupByOverflowMode

Determines the behavior on exceeding limits while doing aggregation.

Default value: GROUP_BY_OVERFLOW_MODE_THROW.

For details, see ClickHouse documentation.

• GROUP_BY_OVERFLOW_MODE_UNSPECIFIED
• GROUP_BY_OVERFLOW_MODE_THROW: Abort query execution and return an error.
• GROUP_BY_OVERFLOW_MODE_BREAK: Return a partial result.
• GROUP_BY_OVERFLOW_MODE_ANY: Continuing aggregation for the keys that got into the set, but do not add new keys to the set.

max_rows_to_sort

google.protobuf.Int64Value

Limits the maximum number of rows that can be read from a table for sorting. 0 means unlimited.
This setting lets you to limit RAM consumption when sorting

Default value: 0.

For details, see ClickHouse documentation.

max_bytes_to_sort

google.protobuf.Int64Value

Limits the maximum number of bytes (uncompressed data) that can be read from a table for sorting. 0 means unlimited.
This setting lets you to limit RAM consumption when sorting

Default value: 0.

For details, see ClickHouse documentation.

sort_overflow_mode

enum OverflowMode

Determines the behavior on exceeding limits while sorting.

Default value: OVERFLOW_MODE_THROW.

For details, see ClickHouse documentation.

• OVERFLOW_MODE_UNSPECIFIED
• OVERFLOW_MODE_THROW: Abort query execution and return an error.
• OVERFLOW_MODE_BREAK: Return a partial result.

max_result_rows

google.protobuf.Int64Value

Limits the number of rows in the result. 0 means unlimited.

This limitation is also checked for subqueries and parts of distributed queries that run on remote servers.

Default value: 0.

For details, see ClickHouse documentation.

max_result_bytes

google.protobuf.Int64Value

Limits the result size in bytes (uncompressed data). 0 means unlimited.

Default value: 0.

For details, see ClickHouse documentation.

result_overflow_mode

enum OverflowMode

Determines the behavior on exceeding limits while forming result.

Default value: OVERFLOW_MODE_THROW.

For details, see ClickHouse documentation.

• OVERFLOW_MODE_UNSPECIFIED
• OVERFLOW_MODE_THROW: Abort query execution and return an error.
• OVERFLOW_MODE_BREAK: Return a partial result.

max_rows_in_distinct

google.protobuf.Int64Value

Limits the maximum number of different rows in the state, which is used for performing DISTINCT. 0 means unlimited.

Default value: 0.

For details, see ClickHouse documentation.

max_bytes_in_distinct

google.protobuf.Int64Value

Limits the maximum number of bytes (uncompressed data) in the state, which is used for performing DISTINCT. 0 means unlimited.

Default value: 0.

For details, see ClickHouse documentation.

distinct_overflow_mode

enum OverflowMode

Determines the behavior on exceeding limits while performing DISTINCT.

Default value: OVERFLOW_MODE_THROW.

For details, see ClickHouse documentation.

• OVERFLOW_MODE_UNSPECIFIED
• OVERFLOW_MODE_THROW: Abort query execution and return an error.
• OVERFLOW_MODE_BREAK: Return a partial result.

max_rows_to_transfer

google.protobuf.Int64Value

Limits the maximum number of rows that can be passed to a remote server or saved in a temporary table when using GLOBAL IN|JOIN. 0 means unlimited.

Default value: 0.

For details, see ClickHouse documentation.

max_bytes_to_transfer

google.protobuf.Int64Value

Limits the maximum number of bytes (uncompressed data) that can be passed to a remote server or saved in a temporary table when using GLOBAL IN|JOIN.
0 means unlimited.

Default value: 0.

For details, see ClickHouse documentation.

transfer_overflow_mode

enum OverflowMode

Determines the behavior on exceeding limits while transfering data.

Default value: OVERFLOW_MODE_THROW.

For details, see ClickHouse documentation.

• OVERFLOW_MODE_UNSPECIFIED
• OVERFLOW_MODE_THROW: Abort query execution and return an error.
• OVERFLOW_MODE_BREAK: Return a partial result.

max_execution_time

google.protobuf.Int64Value

Limits the maximum query execution time in milliseconds. 0 means unlimited.

The timeout is checked and the query can stop only in designated places during data processing.

Default value: 0.

For details, see ClickHouse documentation.

timeout_overflow_mode

enum OverflowMode

Determines the behavior on exceeding limits of execution time.

Default value: OVERFLOW_MODE_THROW.

For details, see ClickHouse documentation.

• OVERFLOW_MODE_UNSPECIFIED
• OVERFLOW_MODE_THROW: Abort query execution and return an error.
• OVERFLOW_MODE_BREAK: Return a partial result.

max_rows_in_set

google.protobuf.Int64Value

Limits on the maximum number of rows in the set resulting from the execution of the IN section. 0 means unlimited.

Default value: 0.

For details, see ClickHouse documentation.

max_bytes_in_set

google.protobuf.Int64Value

Limits on the maximum number of bytes (uncompressed data) in the set resulting from the execution of the IN section. 0 means unlimited.

Default value: 0.

For details, see ClickHouse documentation.

set_overflow_mode

enum OverflowMode

Determines the behavior on exceeding max_rows_in_set or max_bytes_in_set limit.

Default value: OVERFLOW_MODE_THROW.

For details, see ClickHouse documentation.

• OVERFLOW_MODE_UNSPECIFIED
• OVERFLOW_MODE_THROW: Abort query execution and return an error.
• OVERFLOW_MODE_BREAK: Return a partial result.

max_rows_in_join

google.protobuf.Int64Value

Limits the maximum number of rows in the hash table that is used when joining tables. 0 means unlimited.

Default value: 0.

For details, see ClickHouse documentation.

max_bytes_in_join

google.protobuf.Int64Value

Limits the maximum number of bytes in the hash table that is used when joining tables. 0 means unlimited.

Default value: 0.

For details, see ClickHouse documentation.

join_overflow_mode

enum OverflowMode

Determines the behavior on exceeding max_rows_in_join or max_bytes_in_join limit.

Default value: OVERFLOW_MODE_THROW.

For details, see ClickHouse documentation.

• OVERFLOW_MODE_UNSPECIFIED
• OVERFLOW_MODE_THROW: Abort query execution and return an error.
• OVERFLOW_MODE_BREAK: Return a partial result.

max_columns_to_read

google.protobuf.Int64Value

Limits the maximum number of columns that can be read from a table in a single query. 0 means unlimited.
If the query requires to read more columns to complete, then it will be aborted.

Default value: 0.

For details, see ClickHouse documentation.

max_temporary_columns

google.protobuf.Int64Value

Limits the maximum number of temporary columns that must be kept in RAM simultaneously when running a query, including constant columns. 0 means unlimited.
If the query generates more than the specified number of temporary columns in memory as a result of intermediate calculation, then it will be aborted.

Default value: 0.

For details, see ClickHouse documentation.

max_temporary_non_const_columns

google.protobuf.Int64Value

Limits the maximum number of temporary columns that must be kept in RAM simultaneously when running a query, not including constant columns. 0 means unlimited.
If the query generates more than the specified number of temporary columns in memory as a result of intermediate calculation, then it will be aborted.

Default value: 0.

For details, see ClickHouse documentation.

max_query_size

google.protobuf.Int64Value

Limits the size of the part of a query that can be transferred to RAM for parsing with the SQL parser, in bytes.

Data in the VALUES clause of INSERT queries is processed by a separate stream parser (that consumes O(1) RAM) and not affected by this restriction.

Default value: 262144 (256 KiB).

For details, see ClickHouse documentation.

max_ast_depth

google.protobuf.Int64Value

Limits the maximum depth of query syntax tree.

Executing a big and complex query may result in building a syntax tree of enormous depth.
By using this setting, you can prohibit execution of over-sized or non-optimized queries for huge tables.

Default value: 1000.

For details, see ClickHouse documentation.

max_ast_elements

google.protobuf.Int64Value

Limits the maximum size of query syntax tree in number of nodes.

Executing a big and complex query may result in building a syntax tree of enormous size.
By using this setting, you can prohibit execution of over-sized or non-optimized queries for huge tables.

Default value: 50000.

For details, see ClickHouse documentation.

max_expanded_ast_elements

google.protobuf.Int64Value

Limits the maximum size of query syntax tree in number of nodes after expansion of aliases and the asterisk values.

Executing a big and complex query may result in building a syntax tree of enormous size.
By using this setting, you can prohibit execution of over-sized or non-optimized queries for huge tables.

Default value: 500000.

For details, see ClickHouse documentation.