Skip to main content

types

Access​

dataLens : bool​

Allow to export data from the cluster to DataLens.

webSql : 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.

dataTransfer : bool​

Allow access for DataTransfer

yandexQuery : bool​

Allow access for Query

AnytimeMaintenanceWindow​

Backup​

A ClickHouse Backup resource. See the Developer's Guide for more information.

BackupType​

  • BACKUP_TYPE_UNSPECIFIED

  • AUTOMATED

    Backup created by automated daily schedule.

  • MANUAL

    Backup created by user request.

id : string​

ID of the backup.

folderId : string​

ID of the folder that the backup belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp in RFC3339 text format (i.e. when the backup operation was completed).

sourceClusterId : string​

ID of the ClickHouse cluster that the backup was created for.

sourceShardNames : string​

Names of the shards included in the backup.

startedAt : google.protobuf.Timestamp​

Time when the backup operation was started.

size : int64​

Size of backup in bytes.

type : BackupType​

How this backup was created (manual/automatic/etc...).

CloudStorage​

enabled : bool​

Whether to use Object Storage for storing ClickHouse data.

moveFactor : google.protobuf.DoubleValue​
dataCacheEnabled : google.protobuf.BoolValue​
dataCacheMaxSize : google.protobuf.Int64Value​
preferNotToMerge : google.protobuf.BoolValue​

Cluster​

A ClickHouse Cluster resource. For more information, see the Cluster section in the Developer's Guide.

Environment​

  • ENVIRONMENT_UNSPECIFIED

  • PRODUCTION

    Stable environment with a conservative update policy: only hotfixes are applied during regular maintenance.

  • PRESTABLE

    Environment with more aggressive update policy: new versions are rolled out irrespective of backward compatibility.

Health​

  • HEALTH_UNKNOWN

    State of the cluster is unknown ([Host.health][1] for every host in the cluster is UNKNOWN).

  • ALIVE

    Cluster is alive and well ([Host.health][2] for every host in the cluster is ALIVE).

  • DEAD

    Cluster is inoperable ([Host.health][3] for every host in the cluster is DEAD).

  • DEGRADED

    Cluster is working below capacity ([Host.health][4] for at least one host in the cluster is not ALIVE).

Status​

  • STATUS_UNKNOWN

    Cluster state is unknown.

  • CREATING

    Cluster is being created.

  • RUNNING

    Cluster is running normally.

  • ERROR

    Cluster encountered a problem and cannot operate.

  • UPDATING

    Cluster is being updated.

  • STOPPING

    Cluster is stopping.

  • STOPPED

    Cluster stopped.

  • STARTING

    Cluster is starting.

id : string​

ID of the ClickHouse cluster. This ID is assigned by MDB at creation time.

folderId : string​

ID of the folder that the ClickHouse cluster belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp in RFC3339 text format.

name : string​

Name of the ClickHouse cluster. The name is unique within the folder. 1-63 characters long.

description : string​

Description of the ClickHouse cluster. 0-256 characters long.

labels : string​

Custom labels for the ClickHouse cluster as key:value pairs. Maximum 64 per resource.

environment : Environment​

Deployment environment of the ClickHouse cluster.

monitoring : Monitoring​

Description of monitoring systems relevant to the ClickHouse cluster.

config : ClusterConfig​

Configuration of the ClickHouse cluster.

networkId : string​

ID of the network that the cluster belongs to.

health : Health​

Aggregated cluster health.

status : Status​

Current state of the cluster.

serviceAccountId : string​

ID of the service account used for access to Object Storage.

maintenanceWindow : MaintenanceWindow​

Maintenance window for the cluster.

plannedOperation : MaintenanceOperation​

Planned maintenance operation to be started for the cluster within the nearest maintenance_window.

securityGroupIds : string​

User security groups

deletionProtection : bool​

Deletion Protection inhibits deletion of the cluster

ClusterConfig​

Clickhouse​

config : config.ClickhouseConfigSet​

Configuration settings of a ClickHouse server.

resources : Resources​

Resources allocated to ClickHouse hosts.

Zookeeper​

resources : Resources​

Resources allocated to ZooKeeper hosts.

version : string​

Version of the ClickHouse server software.

clickhouse : Clickhouse​

Configuration and resource allocation for ClickHouse hosts.

zookeeper : Zookeeper​

Configuration and resource allocation for ZooKeeper hosts.

backupWindowStart : google.type.TimeOfDay​

Time to start the daily backup, in the UTC timezone.

access : Access​

Access policy for external services.

cloudStorage : CloudStorage​
sqlDatabaseManagement : google.protobuf.BoolValue​

Whether database management through SQL commands is enabled.

sqlUserManagement : google.protobuf.BoolValue​

Whether user management through SQL commands is enabled.

embeddedKeeper : google.protobuf.BoolValue​

Whether cluster should use embedded Keeper instead of Zookeeper.

backupRetainPeriodDays : google.protobuf.Int64Value​

Retain period of automatically created backup in days

Database​

A ClickHouse Database resource. For more information, see the Developer's Guide.

name : string​

Name of the database.

clusterId : string​

ID of the ClickHouse cluster that the database belongs to.

DatabaseSpec​

name : string​

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

FormatSchema​

name : string​

Format schema name.

clusterId : string​

ClickHouse cluster ID.

type : FormatSchemaType​

Schema type. Possible values are the following:

uri : string​

Link to the file of a format schema in Yandex Object Storage. Managed Service for ClickHouse works only with format schemas imported to Object Storage.

Host​

Type​

  • TYPE_UNSPECIFIED

    Host type is unspecified. Default value.

  • CLICKHOUSE

    ClickHouse host.

  • ZOOKEEPER

    ZooKeeper host.

Health​

  • UNKNOWN

    Health of the host is unknown.

  • ALIVE

    The host is performing all its functions normally.

  • DEAD

    The host is inoperable, and cannot perform any of its essential functions.

  • DEGRADED

    The host is degraded, and can perform only some of its essential functions.

name : string​

Name of the ClickHouse host. The host name is assigned by MDB at creation time, and cannot be changed. 1-63 characters long.

The name is unique across all MDB hosts that exist on the platform, as it defines the FQDN of the host.

clusterId : string​

ID of the ClickHouse host. The ID is assigned by MDB at creation time.

zoneId : string​

ID of the availability zone where the ClickHouse host resides.

type : Type​

Type of the host. If the field has default value, it is not returned in the response.

resources : Resources​

Resources allocated to the ClickHouse host.

health : Health​

Aggregated health of the host. If the field has default value, it is not returned in the response.

services : Service​

Services provided by the host.

subnetId : string​

ID of the subnet that the host belongs to.

assignPublicIp : bool​

Flag showing public IP assignment status to this host.

shardName : string​

MaintenanceOperation​

A planned maintenance operation.

info : string​

Information about this maintenance operation.

delayedUntil : google.protobuf.Timestamp​

Time until which this maintenance operation is delayed.

MaintenanceWindow​

A maintenance window settings.

One of policy​

The maintenance policy in effect.

  • anytime : AnytimeMaintenanceWindow​

    Maintenance operation can be scheduled anytime.

  • weeklyMaintenanceWindow : WeeklyMaintenanceWindow​

    Maintenance operation can be scheduled on a weekly basis.

MlModel​

name : string​

Name of the the model.

clusterId : string​

ID of the ClickHouse cluster that the model belongs to.

type : MlModelType​

Type of the model.

uri : string​

Model file URL. You can only use models stored in Object Storage.

Monitoring​

Monitoring system metadata.

name : string​

Name of the monitoring system.

description : string​

Description of the monitoring system.

Link to the monitoring system charts for the ClickHouse cluster.

Permission​

databaseName : string​

Name of the database that the permission grants access to.

ResourcePreset​

A ResourcePreset resource for describing hardware configuration presets.

id : string​

ID of the ResourcePreset resource.

zoneIds : string​

IDs of availability zones where the resource preset is available.

cores : int64​

Number of CPU cores for a ClickHouse host created with the preset.

memory : int64​

RAM volume for a ClickHouse host created with the preset, in bytes.

Resources​

resourcePresetId : string​

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

diskSize : int64​

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

diskTypeId : 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.

Service​

Type​

  • TYPE_UNSPECIFIED

    Service type of the host is unspecified. Default value.

  • CLICKHOUSE

    The host is a ClickHouse server.

  • ZOOKEEPER

    The host is a ZooKeeper server.

Health​

  • UNKNOWN

    Health of the server is unknown. Default value.

  • ALIVE

    The server is working normally.

  • DEAD

    The server is dead or unresponsive.

type : Type​

Type of the service provided by the host. If the field has default value, it is not returned in the response.

health : Health​

Aggregated health of the service. If the field has default value, it is not returned in the response.

Shard​

name : string​

Name of the shard.

clusterId : string​

ID of the cluster that the shard belongs to.

config : ShardConfig​

Configuration of the shard.

ShardConfig​

Clickhouse​

config : config.ClickhouseConfigSet​

ClickHouse settings for a shard.

resources : Resources​

Computational resources for a shard.

weight : google.protobuf.Int64Value​

Relative weight of a shard considered when writing data to the cluster. For details, see ClickHouse documentation.

clickhouse : Clickhouse​

ClickHouse configuration for a shard.

ShardGroup​

name : string​

Name of the shard group.

clusterId : string​

ID of the ClickHouse cluster that the shard group belongs to.

description : string​

Description of the shard group. 0-256 characters long.

shardNames : string​

List of shard names contained in the shard group.

Shards​

shards : Shard​

User​

A ClickHouse User resource. For more information, see the Developer's guide.

name : string​

Name of the ClickHouse user.

clusterId : string​

ID of the ClickHouse cluster the user belongs to.

permissions : Permission​

Set of permissions granted to the user.

settings : UserSettings​
quotas : UserQuota​

Set of quotas assigned to the user.

UserQuota​

ClickHouse quota representation. Each quota associated with an user and limits it resource usage for an interval. See in-depth description ClickHouse documentation.

intervalDuration : google.protobuf.Int64Value​

Duration of interval for quota in milliseconds. Minimal value is 1 second.

queries : google.protobuf.Int64Value​

The total number of queries. 0 - unlimited.

errors : google.protobuf.Int64Value​

The number of queries that threw exception. 0 - unlimited.

resultRows : google.protobuf.Int64Value​

The total number of rows given as the result.. 0 - unlimited.

readRows : google.protobuf.Int64Value​

The total number of source rows read from tables for running the query, on all remote servers. 0 - unlimited.

executionTime : google.protobuf.Int64Value​

The total query execution time, in milliseconds (wall time). 0 - unlimited.

UserSettings​

ClickHouse user settings. Supported settings are a limited subset of all settings described in ClickHouse documentation.

OverflowMode​

  • OVERFLOW_MODE_UNSPECIFIED

  • OVERFLOW_MODE_THROW

  • OVERFLOW_MODE_BREAK

GroupByOverflowMode​

  • GROUP_BY_OVERFLOW_MODE_UNSPECIFIED

  • GROUP_BY_OVERFLOW_MODE_THROW

  • GROUP_BY_OVERFLOW_MODE_BREAK

  • GROUP_BY_OVERFLOW_MODE_ANY

DistributedProductMode​

  • DISTRIBUTED_PRODUCT_MODE_UNSPECIFIED

  • DISTRIBUTED_PRODUCT_MODE_DENY

    Default value. 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.

QuotaMode​

  • QUOTA_MODE_UNSPECIFIED

  • QUOTA_MODE_DEFAULT

  • QUOTA_MODE_KEYED

  • QUOTA_MODE_KEYED_BY_IP

CountDistinctImplementation​

  • COUNT_DISTINCT_IMPLEMENTATION_UNSPECIFIED

  • 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

JoinAlgorithm​

  • JOIN_ALGORITHM_UNSPECIFIED

  • 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

FormatRegexpEscapingRule​

  • FORMAT_REGEXP_ESCAPING_RULE_UNSPECIFIED

  • 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

DateTimeInputFormat​

  • DATE_TIME_INPUT_FORMAT_UNSPECIFIED

  • DATE_TIME_INPUT_FORMAT_BEST_EFFORT

  • DATE_TIME_INPUT_FORMAT_BASIC

  • DATE_TIME_INPUT_FORMAT_BEST_EFFORT_US

DateTimeOutputFormat​

  • DATE_TIME_OUTPUT_FORMAT_UNSPECIFIED

  • DATE_TIME_OUTPUT_FORMAT_SIMPLE

  • DATE_TIME_OUTPUT_FORMAT_ISO

  • DATE_TIME_OUTPUT_FORMAT_UNIX_TIMESTAMP

LocalFilesystemReadMethod​

  • 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

RemoteFilesystemReadMethod​

  • REMOTE_FILESYSTEM_READ_METHOD_UNSPECIFIED

  • REMOTE_FILESYSTEM_READ_METHOD_READ

  • REMOTE_FILESYSTEM_READ_METHOD_THREADPOOL

LoadBalancing​

  • LOAD_BALANCING_UNSPECIFIED

  • LOAD_BALANCING_RANDOM

  • LOAD_BALANCING_NEAREST_HOSTNAME

  • LOAD_BALANCING_IN_ORDER

  • LOAD_BALANCING_FIRST_OR_RANDOM

  • LOAD_BALANCING_ROUND_ROBIN

readonly : google.protobuf.Int64Value​

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

  • 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.

allowDdl : google.protobuf.BoolValue​

Determines whether DDL queries are allowed (e.g., CREATE, ALTER, RENAME, etc).

Default value: true.

See in-depth description in ClickHouse documentation.

allowIntrospectionFunctions : google.protobuf.BoolValue​

Enables introspections functions for query profiling.

More info see in ClickHouse documentation.

connectTimeout : google.protobuf.Int64Value​

Connection timeout in milliseconds.

Value must be greater than 0 (default: 10000, 10 seconds).

connectTimeoutWithFailover : 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: 50.

More info see in ClickHouse documentation.

receiveTimeout : google.protobuf.Int64Value​

Receive timeout in milliseconds.

Value must be greater than 0 (default: 300000, 300 seconds or 5 minutes).

sendTimeout : google.protobuf.Int64Value​

Send timeout in milliseconds.

Value must be greater than 0 (default: 300000, 300 seconds or 5 minutes).

timeoutBeforeCheckingExecutionSpeed : google.protobuf.Int64Value​

Timeout (in seconds) between checks of execution speed. It is checked that execution speed is not less that specified in min_execution_speed parameter.

Default value: 10.

insertQuorum : google.protobuf.Int64Value​

Enables or disables write quorum for ClickHouse cluster. If the value is less than 2, then write quorum 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.

See in-depth description in ClickHouse documentation.

insertQuorumTimeout : 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.

Minimum value: 1000, 1 second (default: 60000, 1 minute).

insertQuorumParallel : google.protobuf.BoolValue​

See in-depth description in ClickHouse documentation.

insertNullAsDefault : google.protobuf.BoolValue​

Enables the insertion of default values instead of NULL into columns with not nullable data type.

Default value: true.

More info see in ClickHouse documentation.

selectSequentialConsistency : google.protobuf.BoolValue​

Determines the behavior of SELECT queries from the replicated table: 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: false (sequential consistency is disabled).

deduplicateBlocksInDependentMaterializedViews : google.protobuf.BoolValue​

See in-depth description in ClickHouse documentation.

replicationAlterPartitionsSync : 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 (default).
  • 2-wait for all replicas.

See in-depth description in ClickHouse documentation.

maxReplicaDelayForDistributedQueries : 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.

Minimum value: 1000, 1 second (default: 300000, 300 seconds or 5 minutes).

See in-depth description in ClickHouse documentation.

fallbackToStaleReplicasForDistributedQueries : 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 (query forcing is enabled).

See in-depth description in ClickHouse documentation.

distributedProductMode : DistributedProductMode​

Determine the behavior of distributed subqueries.

See in-depth description in ClickHouse documentation.

distributedAggregationMemoryEfficient : 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: false (memory saving mode is disabled).

See in-depth description in ClickHouse documentation.

distributedDdlTaskTimeout : google.protobuf.Int64Value​

Timeout for DDL queries, in milliseconds.

skipUnavailableShards : 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 (silent skipping is disabled).

See in-depth description in ClickHouse documentation.

compileExpressions : google.protobuf.BoolValue​

Enables or disables expression compilation. 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: false (expression compilation is disabled).

minCountToCompileExpression : google.protobuf.Int64Value​

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

Minimum value: 0 (default: 3).

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.

maxBlockSize : google.protobuf.Int64Value​

The maximum block size for reading.

Data in ClickHouse is organized and processed by blocks (block is a set of columns' parts). The internal processing cycles for a single block are efficient enough, but there are noticeable expenditures on each block.

This setting is a recommendation for size of block (in a count of rows) that should be loaded from tables.

Value must be greater than 0 (default: 65536).

See in-depth description in ClickHouse documentation.

minInsertBlockSizeRows : 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.

Minimal value: 0, block squashing is disabled (default: 1048576).

minInsertBlockSizeBytes : 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.

Minimal value: 0, block squashing is disabled (default: 268435456, 256 MB).

maxInsertBlockSize : google.protobuf.Int64Value​

Allows to form blocks of the specified size (in bytes) when inserting data in a table. This setting has effect only if server is creating such blocks by itself.

Value must be greater than 0 (default: 1048576).

See in-depth description in ClickHouse documentation.

minBytesToUseDirectIo : google.protobuf.Int64Value​

Limits the minimum number of bytes to enable unbuffered direct reads from disk (Direct I/O).

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.

If the total amount of the data to read is greater than the value of this setting, then ClickHouse will fetch this data directly from the disk.

Minimal value and default value: 0, Direct I/O is disabled.

useUncompressedCache : 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 (uncompressed cache is disabled).

See in-depth description in ClickHouse documentation.

mergeTreeMaxRowsToUseCache : 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.

Value must be greater than 0 (default: 128x8192).

mergeTreeMaxBytesToUseCache : 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.

Value must be greater than 0 (default: 192x10x1024x1024).

mergeTreeMinRowsForConcurrentRead : 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.

Value must be greater than 0 (default: 20x8192).

mergeTreeMinBytesForConcurrentRead : 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.

Value must be greater than 0 (default: 24x10x1024x1024).

maxBytesBeforeExternalGroupBy : 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 comsumption.

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.

Minimal value and default value: 0, GROUP BY in the external memory is disabled.

When using aggregation in external memory, it is recommended to set the value of this setting twice as low as the max_memory_usage setting value (by default, the maximum memory usage is limited to ten gigabytes).

See in-depth description in ClickHouse documentation.

See also: the distributed_aggregation_memory_efficient setting.

maxBytesBeforeExternalSort : google.protobuf.Int64Value​

This setting is equivalent of the max_bytes_before_external_group_by setting, except for it is for sort operation (ORDER BY), not aggregation.

groupByTwoLevelThreshold : google.protobuf.Int64Value​

Sets the threshold of the number of keys, after that the two-level aggregation should be used.

Minimal value: 0, threshold is not set (default: 10000).

groupByTwoLevelThresholdBytes : google.protobuf.Int64Value​

Sets the threshold of the number of bytes, after that the two-level aggregation should be used.

Minimal value: 0, threshold is not set (default: 100000000).

priority : google.protobuf.Int64Value​

Sets the priority of a query.

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

This setting should be set up for each query individually.

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.

Minimal value and default value: 0, priority is not used.

maxThreads : google.protobuf.Int64Value​

Limits the maximum number of threads to process the request (setting does not take threads that read data from remote servers into account).

This setting applies to threads that perform the same stages of the query processing pipeline in parallel.

Minimal value and default value: 0 (the thread number is calculated automatically based on the number of physical CPU cores, no HyperThreading cores are taken into account).

See in-depth description in ClickHouse documentation.

maxMemoryUsage : google.protobuf.Int64Value​

Limits the maximum memory usage (in bytes) for processing of a single user's query on a single server. This setting does not take server's free RAM amount or total RAM amount into account.

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

Minimal value: 0, no limitation is set. Value that is set in the ClickHouse default config file: 10737418240 (10 GB).

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.

See in-depth description in ClickHouse documentation.

maxMemoryUsageForUser : google.protobuf.Int64Value​

Limits the maximum memory usage (in bytes) for processing of user's queries on a single server. This setting does not take server's free RAM amount or total RAM amount into account.

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

Minimal value and default value: 0, no limitation is set.

maxNetworkBandwidth : google.protobuf.Int64Value​

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

Minimal value and default value: 0, no limitation is set.

maxNetworkBandwidthForUser : google.protobuf.Int64Value​

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

Minimal value and default value: 0, no limitation is set.

maxPartitionsPerInsertBlock : google.protobuf.Int64Value​

See in-depth description in ClickHouse documentation.

maxConcurrentQueriesForUser : google.protobuf.Int64Value​

The maximum number of concurrent requests per user. Default value: 0 (no limit).

forceIndexByDate : google.protobuf.BoolValue​

If enabled, query is not executed if the ClickHouse can't use index by date. This setting has effect only for tables of the MergeTree family.

Default value: false (setting is disabled, query executes even if ClickHouse can't use index by date).

See in-depth description in ClickHouse documentation.

forcePrimaryKey : google.protobuf.BoolValue​

If enabled, query is not executed if the ClickHouse can't use index by primary key. This setting has effect only for tables of the MergeTree family.

Default value: false (setting is disabled, query executes even if ClickHouse can't use index by primary key).

See in-depth description in ClickHouse documentation.

maxRowsToRead : google.protobuf.Int64Value​

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

Minimal value and default value: 0, no limitation is set.

See in-depth description in ClickHouse documentation.

maxBytesToRead : google.protobuf.Int64Value​

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

Minimal value and default value: 0, no limitation is set.

readOverflowMode : OverflowMode​

Determines the behavior on exceeding limits while reading the data.

  • throw-abort query execution, return an error.
  • break-stop query execution, return partial result.
maxRowsToGroupBy : google.protobuf.Int64Value​

Limits the maximum number of unique keys received from aggregation function. This setting helps to reduce RAM consumption while doing aggregation.

Minimal value and default value: 0, no limitation is set.

groupByOverflowMode : GroupByOverflowMode​

Determines the behavior on exceeding limits while doing aggregation.

  • throw-abort query execution, return an error.
  • break-stop query execution, return partial result.
  • any-perform approximate GROUP BY operation by continuing aggregation for the keys that got into the set, but don't add new keys to the set.
maxRowsToSort : google.protobuf.Int64Value​

Limits the maximum number of rows that can be read from a table for sorting. This setting helps to reduce RAM consumption.

Minimal value and default value: 0, no limitation is set.

maxBytesToSort : google.protobuf.Int64Value​

Limits the maximum number of bytes (uncompressed data) that can be read from a table for sorting. This setting helps to reduce RAM consumption.

Minimal value and default value: 0, no limitation is set.

sortOverflowMode : OverflowMode​

Determines the behavior on exceeding limits while sorting.

  • throw-abort query execution, return an error.
  • break-stop query execution, return partial result.
maxResultRows : google.protobuf.Int64Value​

Limits the number of rows in the result. This limitation is also checked for subqueries and parts of distributed queries that run on remote servers.

Minimal value and default value: 0, no limitation is set.

maxResultBytes : google.protobuf.Int64Value​

Limits the number of bytes in the result. This limitation is also checked for subqueries and parts of distributed queries that run on remote servers.

Minimal value and default value: 0, no limitation is set.

resultOverflowMode : OverflowMode​

Determines the behavior on exceeding limits while forming result.

  • throw-abort query execution, return an error.
  • break-stop query execution, return partial result.
maxRowsInDistinct : google.protobuf.Int64Value​

Limits the maximum number of different rows when using DISTINCT.

Minimal value and default value: 0, no limitation is set.

maxBytesInDistinct : google.protobuf.Int64Value​

Limits the maximum size of a hash table in bytes (uncompressed data) when using DISTINCT.

distinctOverflowMode : OverflowMode​

Determines the behavior on exceeding limits while doing DISCTINCT.

  • throw-abort query execution, return an error.
  • break-stop query execution, return partial result.
maxRowsToTransfer : 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.

Minimal value and default value: 0, no limitation is set.

maxBytesToTransfer : 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.

Minimal value and default value: 0, no limitation is set.

transferOverflowMode : OverflowMode​

Determines the behavior on exceeding limits while doing transfers.

  • throw-abort query execution, return an error.
  • break-stop query execution, return partial result.
maxExecutionTime : google.protobuf.Int64Value​

Limits the maximum query execution time in milliseconds. At this moment, this limitation is not checked when passing one of the sorting stages, as well as merging and finalizing aggregation funictions.

Minimal value and default value: 0, no limitation is set.

timeoutOverflowMode : OverflowMode​

Determines the behavior on exceeding limits of execution time.

  • throw-abort query execution, return an error.
  • break-stop query execution, return partial result.
maxRowsInSet : google.protobuf.Int64Value​

Limit on the number of rows in the set resulting from the execution of the IN section.

maxBytesInSet : google.protobuf.Int64Value​

Limit on the number of bytes in the set resulting from the execution of the IN section.

setOverflowMode : OverflowMode​

Determine the behavior on exceeding max_rows_in_set or max_bytes_in_set limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK.

maxRowsInJoin : google.protobuf.Int64Value​

Limit on maximum size of the hash table for JOIN, in rows.

maxBytesInJoin : google.protobuf.Int64Value​

Limit on maximum size of the hash table for JOIN, in bytes.

joinOverflowMode : OverflowMode​

Determine the behavior on exceeding max_rows_in_join or max_bytes_in_join limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK.

joinAlgorithm : JoinAlgorithm​

See in-depth description in ClickHouse documentation.

anyJoinDistinctRightTableKeys : google.protobuf.BoolValue​

See in-depth description in ClickHouse documentation.

maxColumnsToRead : google.protobuf.Int64Value​

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

Minimal value and default value: 0, no limitation is set.

maxTemporaryColumns : google.protobuf.Int64Value​

Limits the maximum number of temporary columns that must be kept in RAM at the same time when running a query, including constant columns.

Minimal value and default value: 0, no limitation is set.

maxTemporaryNonConstColumns : google.protobuf.Int64Value​

Limits the maximum number of temporary columns that must be kept in RAM at the same time when running a query, excluding constant columns.

Minimal value and default value: 0, no limitation is set.

maxQuerySize : 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.

Value must be greater than 0 (default: 262144).

See in-depth description in ClickHouse documentation.

maxAstDepth : 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.

For example, the SELECT * query may result in more complex and deeper syntax tree, compared to the SELECT ... WHERE ... query, containing constraints and conditions, in the most cases. A user can be forced to construct more optimized queries, if this setting is used.

Value must be greater than 0 (default: 1000). If a too small value is set, it may render ClickHouse unable to execute even simple queries.

See in-depth description in ClickHouse documentation.

maxAstElements : 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.

Value must be greater than 0 (default: 50000). If a too small value is set, it may render ClickHouse unable to execute even simple queries.

See in-depth description in ClickHouse documentation.

maxExpandedAstElements : 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.

Value must be greater than 0 (default: 500000). If a too small value is set, it may render ClickHouse unable to execute even simple queries.

minExecutionSpeed : google.protobuf.Int64Value​

Minimal execution speed in rows per second.

minExecutionSpeedBytes : google.protobuf.Int64Value​

Minimal execution speed in bytes per second.

countDistinctImplementation : CountDistinctImplementation​

Aggregate function to use for implementation of count(DISTINCT ...).

inputFormatValuesInterpretExpressions : google.protobuf.BoolValue​

Enables or disables SQL parser if the fast stream parser cannot parse the data.

Enable this setting, if the data that you want to insert into a table contains SQL expressions.

For example, the stream parser is unable to parse a value that contains now() expression; therefore an INSERT query for this value will fail and no data will be inserted into a table. With enabled SQL parser, this expression is parsed correctly: the now() expression will be parsed as SQL function, interpreted, and the current date and time will be inserted into the table as a result.

This setting has effect only if you use Values format when inserting data.

Default value: true (SQL parser is enabled).

See in-depth description in ClickHouse documentation.

inputFormatDefaultsForOmittedFields : google.protobuf.BoolValue​

Enables or disables replacing omitted input values with default values of the respective columns when performing INSERT queries.

Default value: true (replacing is enabled).

inputFormatNullAsDefault : google.protobuf.BoolValue​

See in-depth description in ClickHouse documentation.

dateTimeInputFormat : DateTimeInputFormat​

See in-depth description in ClickHouse documentation.

inputFormatWithNamesUseHeader : google.protobuf.BoolValue​

See in-depth description in ClickHouse documentation.

outputFormatJsonQuote_64bitIntegers : google.protobuf.BoolValue​

Enables quoting of 64-bit integers in JSON output format.

If this setting is enabled, then 64-bit integers (UInt64 and Int64) will be quoted when written to JSON output in order to maintain compatibility with the most of the JavaScript engines. Otherwise, such integers will not be quoted.

Default value: false (quoting 64-bit integers is disabled).

outputFormatJsonQuoteDenormals : google.protobuf.BoolValue​

Enables special floating-point values (+nan, -nan, +inf and -inf) in JSON output format.

Default value: false (special values do not present in output).

dateTimeOutputFormat : DateTimeOutputFormat​

See in-depth description in ClickHouse documentation.

lowCardinalityAllowInNativeFormat : google.protobuf.BoolValue​

Determines whether to use LowCardinality type in Native format.

  • true (default)-yes, use.
  • false-convert LowCardinality columns to regular columns when doing SELECT, and convert regular columns to LowCardinality when doing INSERT.

LowCardinality columns (aka sparse columns) store data in more effective way, compared to regular columns, by using hash tables. If data to insert suits this storage format, ClickHouse will place them into LowCardinality column.

If you use a third-party ClickHouse client that can't work with LowCardinality columns, then this client will not be able to correctly interpret the result of the query that asks for data stored in LowCardinality column. Disable this setting to convert LowCardinality column to regular column when creating the result, so such clients will be able to process the result.

Official ClickHouse client works with LowCardinality columns out-of-the-box.

Default value: true (LowCardinality columns are used in Native format).

allowSuspiciousLowCardinalityTypes : google.protobuf.BoolValue​

Allows specifying LowCardinality modifier for types of small fixed size (8 or less) in CREATE TABLE statements. Enabling this may increase merge times and memory consumption.

More info see in ClickHouse documentation.

emptyResultForAggregationByEmptySet : google.protobuf.BoolValue​

Enables returning of empty result when aggregating without keys (with GROUP BY operation absent) on empty set (e.g., SELECT count(*) FROM table WHERE 0).

  • true-ClickHouse will return an empty result for such queries.
  • false (default)-ClickHouse will return a single-line result consisting of NULL values for aggregation functions, in accordance with SQL standard.
httpConnectionTimeout : google.protobuf.Int64Value​

HTTP connection timeout, in milliseconds.

Value must be greater than 0 (default: 1000, 1 second).

httpReceiveTimeout : google.protobuf.Int64Value​

HTTP receive timeout, in milliseconds.

Value must be greater than 0 (default: 1800000, 1800 seconds, 30 minutes).

httpSendTimeout : google.protobuf.Int64Value​

HTTP send timeout, in milliseconds.

Value must be greater than 0 (default: 1800000, 1800 seconds, 30 minutes).

enableHttpCompression : google.protobuf.BoolValue​

Enables or disables data compression in HTTP responses.

By default, ClickHouse stores data compressed. When executing a query, its result is uncompressed. Use this setting to command ClickHouse to compress the result when sending it via HTTP.

Enable this setting and add the Accept-Encoding: <compression method> HTTP header in a HTTP request to force compression of HTTP response from ClickHouse.

ClickHouse support the following compression methods: gzip, br and deflate.

Default value: false (compression is disabled).

See in-depth description in ClickHouse documentation.

sendProgressInHttpHeaders : google.protobuf.BoolValue​

Enables progress notifications using X-ClickHouse-Progress HTTP header.

Default value: false (notifications disabled).

httpHeadersProgressInterval : google.protobuf.Int64Value​

Minimum interval between progress notifications with X-ClickHouse-Progress HTTP header, in milliseconds.

Value must be greater than 0 (default: 100).

addHttpCorsHeader : google.protobuf.BoolValue​

Adds CORS header in HTTP responses.

Default value: false (header is not added).

cancelHttpReadonlyQueriesOnClientClose : google.protobuf.BoolValue​

Cancels HTTP read-only queries (e.g. SELECT) when a client closes the connection without waiting for the response.

Default value: false.

More info see in ClickHouse documentation.

maxHttpGetRedirects : google.protobuf.Int64Value​

Limits the maximum number of HTTP GET redirect hops for URL-engine tables.

If the parameter is set to 0 (default), no hops is allowed.

More info see in ClickHouse documentation.

joinedSubqueryRequiresAlias : google.protobuf.BoolValue​
joinUseNulls : google.protobuf.BoolValue​
transformNullIn : google.protobuf.BoolValue​
quotaMode : QuotaMode​

Quota accounting mode. Possible values: QUOTA_MODE_DEFAULT, QUOTA_MODE_KEYED and QUOTA_MODE_KEYED_BY_IP.

flattenNested : google.protobuf.BoolValue​

Sets the data format of a nested columns.

More info see in ClickHouse documentation.

formatRegexp : string​

Regular expression (for Regexp format)

formatRegexpEscapingRule : FormatRegexpEscapingRule​

See in-depth description in ClickHouse documentation.

formatRegexpSkipUnmatched : google.protobuf.BoolValue​

See in-depth description in ClickHouse documentation.

asyncInsert : google.protobuf.BoolValue​

Enables asynchronous inserts.

Disabled by default.

More info see in ClickHouse documentation.

asyncInsertThreads : google.protobuf.Int64Value​

The maximum number of threads for background data parsing and insertion.

If the parameter is set to 0, asynchronous insertions are disabled. Default value: 16.

More info see in ClickHouse documentation.

waitForAsyncInsert : google.protobuf.BoolValue​

Enables waiting for processing of asynchronous insertion. If enabled, server returns OK only after the data is inserted.

More info see in ClickHouse documentation.

waitForAsyncInsertTimeout : google.protobuf.Int64Value​

The timeout (in seconds) for waiting for processing of asynchronous insertion.

Default value: 120.

More info see in ClickHouse documentation.

asyncInsertMaxDataSize : google.protobuf.Int64Value​

The maximum size of the unparsed data in bytes collected per query before being inserted.

If the parameter is set to 0, asynchronous insertions are disabled. Default value: 100000.

More info see in ClickHouse documentation.

asyncInsertBusyTimeout : google.protobuf.Int64Value​

The maximum timeout in milliseconds since the first INSERT query before inserting collected data.

If the parameter is set to 0, the timeout is disabled. Default value: 200.

More info see in ClickHouse documentation.

asyncInsertStaleTimeout : google.protobuf.Int64Value​

The maximum timeout in milliseconds since the last INSERT query before dumping collected data. If enabled, the settings prolongs the async_insert_busy_timeout with every INSERT query as long as async_insert_max_data_size is not exceeded.

More info see in ClickHouse documentation.

memoryProfilerStep : google.protobuf.Int64Value​

Memory profiler step (in bytes).

If the next query step requires more memory than this parameter specifies, the memory profiler collects the allocating stack trace. Values lower than a few megabytes slow down query processing.

Default value: 4194304 (4 MB). Zero means disabled memory profiler.

memoryProfilerSampleProbability : google.protobuf.DoubleValue​

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.

Possible values: from 0 to 1. Default: 0.

maxFinalThreads : google.protobuf.Int64Value​

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.

inputFormatParallelParsing : google.protobuf.BoolValue​

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

inputFormatImportNestedJson : google.protobuf.BoolValue​

Enables or disables the insertion of JSON data with nested objects. See in-depth description in ClickHouse documentation

localFilesystemReadMethod : LocalFilesystemReadMethod​

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.

maxReadBufferSize : google.protobuf.Int64Value​

The maximum size of the buffer to read from the filesystem. See in-depth description in ClickHouse documentation

insertKeeperMaxRetries : google.protobuf.Int64Value​

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

maxTemporaryDataOnDiskSizeForUser : google.protobuf.Int64Value​

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

maxTemporaryDataOnDiskSizeForQuery : google.protobuf.Int64Value​

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

maxParserDepth : google.protobuf.Int64Value​

Limits maximum recursion depth in the recursive descent parser. Allows controlling the stack size. Default: 1000 Special: 0 - unlimited See in-depth description in ClickHouse documentation

remoteFilesystemReadMethod : RemoteFilesystemReadMethod​

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

memoryOvercommitRatioDenominator : google.protobuf.Int64Value​

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

memoryOvercommitRatioDenominatorForUser : google.protobuf.Int64Value​

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

memoryUsageOvercommitMaxWaitMicroseconds : google.protobuf.Int64Value​

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

logQueryThreads : google.protobuf.BoolValue​

Setting up query threads logging. Query threads log into the system.query_thread_log table. This setting has effect only when log_queries is true. Queries threads run by ClickHouse with this setup are logged according to the rules in the query_thread_log server configuration parameter. Default: true See in-depth description in ClickHouse documentation

maxInsertThreads : google.protobuf.Int64Value​

The maximum number of threads to execute the INSERT SELECT query. Default: 0 See in-depth description in ClickHouse documentation

useHedgedRequests : google.protobuf.BoolValue​

Enables 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 (or data packet, if allow_changing_replica_until_first_data_packet); other connections are cancelled. Queries with max_parallel_replicas > 1 are supported. Default: true See in-depth description in ClickHouse documentation

idleConnectionTimeout : google.protobuf.Int64Value​

Timeout to close idle TCP connections after specified number of milliseconds. Default: 360000 (3600 seconds) See in-depth description in ClickHouse documentation

hedgedConnectionTimeoutMs : google.protobuf.Int64Value​

Connection timeout for establishing connection with replica for Hedged requests. Default: 50 See in-depth description in ClickHouse GitHub

loadBalancing : LoadBalancing​

Specifies the algorithm of replicas selection that is used for distributed query processing, one of: random, nearest_hostname, in_order, first_or_random, round_robin. Default: random See in-depth description in ClickHouse documentation

preferLocalhostReplica : google.protobuf.BoolValue​

Enables/disables preferable using the localhost replica when processing distributed queries. Default: true See in-depth description in ClickHouse documentation

compile : google.protobuf.BoolValue​

The setting is deprecated and has no effect.

minCountToCompile : google.protobuf.Int64Value​

The setting is deprecated and has no effect.

UserSpec​

name : string​

Name of the ClickHouse user.

password : string​

Password of the ClickHouse user.

permissions : Permission​

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

settings : UserSettings​
quotas : UserQuota​

Set of quotas assigned to the user.

Version​

id : string​

ID of the version.

name : string​

Name of the version.

deprecated : bool​

Whether version is deprecated.

updatableTo : string​

List of versions that can be updated from current.

WeeklyMaintenanceWindow​

Weelky maintenance window settings.

WeekDay​

  • WEEK_DAY_UNSPECIFIED

  • MON

  • TUE

  • WED

  • THU

  • FRI

  • SAT

  • SUN

day : WeekDay​

Day of the week (in DDD format).

hour : int64​

Hour of the day in UTC (in HH format).