Method list

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

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

ID of the folder that the ClickHouse cluster belongs to.

Creation timestamp in RFC3339 text format.

String in RFC3339 text format.

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

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

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

Deployment environment of the ClickHouse cluster.

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

Monitoring system metadata.

Name of the monitoring system.

Description of the monitoring system.

Link to the monitoring system charts for the ClickHouse cluster.

Configuration of the ClickHouse cluster.

Version of the ClickHouse server software.

Configuration and resource allocation for ClickHouse hosts.

Configuration settings of a ClickHouse server.

Required. Effective settings for a ClickHouse cluster (a combination of settings defined in userConfig and defaultConfig).

ClickHouse configuration options. Detailed description for each set of options is available in ClickHouse documentation.

Any options not listed here are not supported.

Logging level for the ClickHouse cluster. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR.

Settings for the MergeTree engine. See description in ClickHouse documentation.

Options specific to the MergeTree table engine.

Number of blocks of hashes to keep in ZooKeeper.

Period of time to keep blocks of hashes for.

If table contains at least that many active parts in single partition, artificially slow down insert into table.

If more than this number active parts in single partition, throw 'Too many parts ...' exception.

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

If there is less than specified number of free entries in background pool (or replicated queue), start to lower maximum size of merge to process.

Maximum in total size of parts to merge, when there are minimum free threads in background pool (or entries in replication queue).

Compression settings for the ClickHouse cluster. See in-depth description in ClickHouse documentation.

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

• LZ4: LZ4 compression algorithm.
• ZSTD: Zstandard compression algorithm.

Minimum size of a part of a table.

The minimum value is 1.

Minimum ratio of a part relative to the size of all the data in the table.

Configuration of external dictionaries to be used by the ClickHouse cluster. See in-depth description in ClickHouse documentation.

Required. Name of the external dictionary.

Single numeric key column for the dictionary.

Numeric key.

Required. Name of the numeric key.

Composite key for the dictionary, containing of one or more key columns. For details, see ClickHouse documentation.

Complex key.

Required. Attributes of a complex key.

Must contain at least one element.

Required. Name of the column.

Required. Type of the column.

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

Expression, describing the attribute, if applicable.

Indication of hierarchy support. Default value: false.

Indication of injective mapping "id -> attribute". Default value: false.

Field holding the beginning of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation.

Required. Name of the column.

Required. Type of the column.

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

Expression, describing the attribute, if applicable.

Indication of hierarchy support. Default value: false.

Indication of injective mapping "id -> attribute". Default value: false.

Field holding the end of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation.

Required. Name of the column.

Required. Type of the column.

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

Expression, describing the attribute, if applicable.

Indication of hierarchy support. Default value: false.

Indication of injective mapping "id -> attribute". Default value: false.

Required. Description of the fields available for database queries. For details, see ClickHouse documentation.

Must contain at least one element.

Required. Name of the column.

Required. Type of the column.

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

Expression, describing the attribute, if applicable.

Indication of hierarchy support. Default value: false.

Indication of injective mapping "id -> attribute". Default value: false.

Layout determining how to store the dictionary in memory.

Required. Layout type for an external dictionary.

• FLAT: The entire dictionary is stored in memory in the form of flat arrays. Available for all dictionary sources.
• HASHED: The entire dictionary is stored in memory in the form of a hash table. Available for all dictionary sources.
• COMPLEX_KEY_HASHED: Similar to HASHED, to be used with composite keys. Available for all dictionary sources.
• RANGE_HASHED: The entire dictionary is stored in memory in the form of a hash table, with an ordered array of ranges and their corresponding values. Available for all dictionary sources.
• CACHE: The dictionary is stored in a cache with a set number of cells. Available for MySQL, ClickHouse and HTTP dictionary sources.
• COMPLEX_KEY_CACHE: Similar to CACHE, to be used with composite keys. Available for MySQL, ClickHouse and HTTP dictionary sources.

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

Fixed interval between dictionary updates.

Minimum dictionary lifetime.

Maximum dictionary lifetime.

Required. URL of the source dictionary available over HTTP.

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

Required. Name of the MySQL database to connect to.

Required. Name of the database table to use as a ClickHouse dictionary.

Default port to use when connecting to a replica of the dictionary source.

Acceptable values are 0 to 65535, inclusive.

Name of the default user for replicas of the dictionary source.

Password of the default user for replicas of the dictionary source.

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

Must contain at least one element.

Required. MySQL host of the replica.

The maximum string length in characters is 253.

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

Value must be greater than 0.

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.

Acceptable values are 0 to 65535, inclusive.

Name of the MySQL database user.

Password of the MySQL database user.

Selection criteria for the data in the specified MySQL table.

Query for checking the dictionary status, to pull only updated data. For more details, see ClickHouse documentation on dictionaries.

Required. Name of the ClickHouse database.

Required. Name of the table in the specified database to be used as the dictionary source.

Required. ClickHouse host of the specified database.

The maximum string length in characters is 253.

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

Required. Name of the ClickHouse database user.

Password of the ClickHouse database user.

Selection criteria for the data in the specified ClickHouse table.

Required. Name of the MongoDB database.

Required. Name of the collection in the specified database to be used as the dictionary source.

Required. MongoDB host of the specified database.

The maximum string length in characters is 253.

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

Required. Name of the MongoDB database user.

Password of the MongoDB database user.

Required. Name of the PostrgreSQL database.

Required. Name of the table in the specified database to be used as the dictionary source.

Required. Name of the PostrgreSQL host

Must contain at least one element.

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

Required. Name of the PostrgreSQL database user.

Password of the PostrgreSQL database user.

Query for checking the dictionary status, to pull only updated data. For more details, see ClickHouse documentation on dictionaries.

Mode of SSL TCP/IP connection to the PostgreSQL host. For more details, see PostgreSQL documentation.

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

Rollup settings for the GraphiteMergeTree table engine.

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

Required. Pattern to use for the rollup.

Must contain at least one element.

Pattern for metric names.

Required. Name of the aggregating function to apply to data of the age specified in retention.

Required. Age of data to use for thinning.

Must contain at least one element.

Minimum age of the data in seconds.

Value must be greater than 0.

Precision of determining the age of the data, in seconds.

Value must be greater than 0.

Required.

Required.

Maximum number of inbound connections.

The minimum value is 10.

Maximum number of simultaneously processed requests.

The minimum value is 10.

Number of milliseconds that ClickHouse waits for incoming requests before closing the connection.

Cache size (in bytes) for uncompressed data used by MergeTree tables.

Approximate size (in bytes) of the cache of "marks" used by MergeTree tables.

Value must be greater than 0.

Maximum size of the table that can be deleted using a DROP query.

Maximum size of the partition that can be deleted using a DROP query.

The setting is deprecated and has no effect.

The server's time zone to be used in DateTime fields conversions. Specified as an IANA identifier.

Address of the archive with the user geobase in Object Storage.

The maximum size that query_log can grow to before old data will be removed. If set to 0, automatic removal of query_log data based on size is disabled.

The maximum time that query_log records will be retained before removal. If set to 0, automatic removal of query_log data based on time is disabled.

Whether query_thread_log system table is enabled.

The maximum size that query_thread_log can grow to before old data will be removed. If set to 0, automatic removal of query_thread_log data based on size is disabled.

The maximum time that query_thread_log records will be retained before removal. If set to 0, automatic removal of query_thread_log data based on time is disabled.

The maximum size that part_log can grow to before old data will be removed. If set to 0, automatic removal of part_log data based on size is disabled.

The maximum time that part_log records will be retained before removal. If set to 0, automatic removal of part_log data based on time is disabled.

Whether metric_log system table is enabled.

The maximum size that metric_log can grow to before old data will be removed. If set to 0, automatic removal of metric_log data based on size is disabled.

The maximum time that metric_log records will be retained before removal. If set to 0, automatic removal of metric_log data based on time is disabled.

Whether trace_log system table is enabled.

The maximum size that trace_log can grow to before old data will be removed. If set to 0, automatic removal of trace_log data based on size is disabled.

The maximum time that trace_log records will be retained before removal. If set to 0, automatic removal of trace_log data based on time is disabled.

Whether text_log system table is enabled.

The maximum size that text_log can grow to before old data will be removed. If set to 0, automatic removal of text_log data based on size is disabled.

The maximum time that text_log records will be retained before removal. If set to 0, automatic removal of text_log data based on time is disabled.

Logging level for text_log system table. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR.

Value must be greater than 0.

Value must be greater than 0.

User-defined settings for a ClickHouse cluster.

ClickHouse configuration options. Detailed description for each set of options is available in ClickHouse documentation.

Any options not listed here are not supported.

Logging level for the ClickHouse cluster. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR.

Settings for the MergeTree engine. See description in ClickHouse documentation.

Options specific to the MergeTree table engine.

Number of blocks of hashes to keep in ZooKeeper.

Period of time to keep blocks of hashes for.

If table contains at least that many active parts in single partition, artificially slow down insert into table.

If more than this number active parts in single partition, throw 'Too many parts ...' exception.

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

If there is less than specified number of free entries in background pool (or replicated queue), start to lower maximum size of merge to process.

Maximum in total size of parts to merge, when there are minimum free threads in background pool (or entries in replication queue).

Compression settings for the ClickHouse cluster. See in-depth description in ClickHouse documentation.

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

• LZ4: LZ4 compression algorithm.
• ZSTD: Zstandard compression algorithm.

Minimum size of a part of a table.

The minimum value is 1.

Minimum ratio of a part relative to the size of all the data in the table.

Configuration of external dictionaries to be used by the ClickHouse cluster. See in-depth description in ClickHouse documentation.

Required. Name of the external dictionary.

Single numeric key column for the dictionary.

Numeric key.

Required. Name of the numeric key.

Composite key for the dictionary, containing of one or more key columns. For details, see ClickHouse documentation.

Complex key.

Required. Attributes of a complex key.

Must contain at least one element.

Required. Name of the column.

Required. Type of the column.

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

Expression, describing the attribute, if applicable.

Indication of hierarchy support. Default value: false.

Indication of injective mapping "id -> attribute". Default value: false.

Field holding the beginning of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation.

Required. Name of the column.

Required. Type of the column.

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

Expression, describing the attribute, if applicable.

Indication of hierarchy support. Default value: false.

Indication of injective mapping "id -> attribute". Default value: false.

Field holding the end of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation.

Required. Name of the column.

Required. Type of the column.

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

Expression, describing the attribute, if applicable.

Indication of hierarchy support. Default value: false.

Indication of injective mapping "id -> attribute". Default value: false.

Required. Description of the fields available for database queries. For details, see ClickHouse documentation.

Must contain at least one element.

Required. Name of the column.

Required. Type of the column.

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

Expression, describing the attribute, if applicable.

Indication of hierarchy support. Default value: false.

Indication of injective mapping "id -> attribute". Default value: false.

Layout determining how to store the dictionary in memory.

Required. Layout type for an external dictionary.

• FLAT: The entire dictionary is stored in memory in the form of flat arrays. Available for all dictionary sources.
• HASHED: The entire dictionary is stored in memory in the form of a hash table. Available for all dictionary sources.
• COMPLEX_KEY_HASHED: Similar to HASHED, to be used with composite keys. Available for all dictionary sources.
• RANGE_HASHED: The entire dictionary is stored in memory in the form of a hash table, with an ordered array of ranges and their corresponding values. Available for all dictionary sources.
• CACHE: The dictionary is stored in a cache with a set number of cells. Available for MySQL, ClickHouse and HTTP dictionary sources.
• COMPLEX_KEY_CACHE: Similar to CACHE, to be used with composite keys. Available for MySQL, ClickHouse and HTTP dictionary sources.

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

Fixed interval between dictionary updates.

Minimum dictionary lifetime.

Maximum dictionary lifetime.

Required. URL of the source dictionary available over HTTP.

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

Required. Name of the MySQL database to connect to.

Required. Name of the database table to use as a ClickHouse dictionary.

Default port to use when connecting to a replica of the dictionary source.

Acceptable values are 0 to 65535, inclusive.

Name of the default user for replicas of the dictionary source.

Password of the default user for replicas of the dictionary source.

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

Must contain at least one element.

Required. MySQL host of the replica.

The maximum string length in characters is 253.

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

Value must be greater than 0.

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.

Acceptable values are 0 to 65535, inclusive.

Name of the MySQL database user.

Password of the MySQL database user.

Selection criteria for the data in the specified MySQL table.

Query for checking the dictionary status, to pull only updated data. For more details, see ClickHouse documentation on dictionaries.

Required. Name of the ClickHouse database.

Required. Name of the table in the specified database to be used as the dictionary source.

Required. ClickHouse host of the specified database.

The maximum string length in characters is 253.

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

Required. Name of the ClickHouse database user.

Password of the ClickHouse database user.

Selection criteria for the data in the specified ClickHouse table.

Required. Name of the MongoDB database.

Required. Name of the collection in the specified database to be used as the dictionary source.

Required. MongoDB host of the specified database.

The maximum string length in characters is 253.

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

Required. Name of the MongoDB database user.

Password of the MongoDB database user.

Required. Name of the PostrgreSQL database.

Required. Name of the table in the specified database to be used as the dictionary source.

Required. Name of the PostrgreSQL host

Must contain at least one element.

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

Required. Name of the PostrgreSQL database user.

Password of the PostrgreSQL database user.

Query for checking the dictionary status, to pull only updated data. For more details, see ClickHouse documentation on dictionaries.

Mode of SSL TCP/IP connection to the PostgreSQL host. For more details, see PostgreSQL documentation.

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

Rollup settings for the GraphiteMergeTree table engine.

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

Required. Pattern to use for the rollup.

Must contain at least one element.

Pattern for metric names.

Required. Name of the aggregating function to apply to data of the age specified in retention.

Required. Age of data to use for thinning.

Must contain at least one element.

Minimum age of the data in seconds.

Value must be greater than 0.

Precision of determining the age of the data, in seconds.

Value must be greater than 0.

Required.

Required.

Maximum number of inbound connections.

The minimum value is 10.

Maximum number of simultaneously processed requests.

The minimum value is 10.

Number of milliseconds that ClickHouse waits for incoming requests before closing the connection.

Cache size (in bytes) for uncompressed data used by MergeTree tables.

Approximate size (in bytes) of the cache of "marks" used by MergeTree tables.

Value must be greater than 0.

Maximum size of the table that can be deleted using a DROP query.

Maximum size of the partition that can be deleted using a DROP query.

The setting is deprecated and has no effect.

The server's time zone to be used in DateTime fields conversions. Specified as an IANA identifier.

Address of the archive with the user geobase in Object Storage.

The maximum size that query_log can grow to before old data will be removed. If set to 0, automatic removal of query_log data based on size is disabled.

The maximum time that query_log records will be retained before removal. If set to 0, automatic removal of query_log data based on time is disabled.

Whether query_thread_log system table is enabled.

The maximum size that query_thread_log can grow to before old data will be removed. If set to 0, automatic removal of query_thread_log data based on size is disabled.

The maximum time that query_thread_log records will be retained before removal. If set to 0, automatic removal of query_thread_log data based on time is disabled.

The maximum size that part_log can grow to before old data will be removed. If set to 0, automatic removal of part_log data based on size is disabled.

The maximum time that part_log records will be retained before removal. If set to 0, automatic removal of part_log data based on time is disabled.

Whether metric_log system table is enabled.

The maximum size that metric_log can grow to before old data will be removed. If set to 0, automatic removal of metric_log data based on size is disabled.

The maximum time that metric_log records will be retained before removal. If set to 0, automatic removal of metric_log data based on time is disabled.

Whether trace_log system table is enabled.

The maximum size that trace_log can grow to before old data will be removed. If set to 0, automatic removal of trace_log data based on size is disabled.

The maximum time that trace_log records will be retained before removal. If set to 0, automatic removal of trace_log data based on time is disabled.

Whether text_log system table is enabled.

The maximum size that text_log can grow to before old data will be removed. If set to 0, automatic removal of text_log data based on size is disabled.

The maximum time that text_log records will be retained before removal. If set to 0, automatic removal of text_log data based on time is disabled.

Logging level for text_log system table. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR.

Value must be greater than 0.

Value must be greater than 0.

Default configuration for a ClickHouse cluster.

ClickHouse configuration options. Detailed description for each set of options is available in ClickHouse documentation.

Any options not listed here are not supported.

Logging level for the ClickHouse cluster. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR.

Settings for the MergeTree engine. See description in ClickHouse documentation.

Options specific to the MergeTree table engine.

Number of blocks of hashes to keep in ZooKeeper.

Period of time to keep blocks of hashes for.

If table contains at least that many active parts in single partition, artificially slow down insert into table.

If more than this number active parts in single partition, throw 'Too many parts ...' exception.

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

If there is less than specified number of free entries in background pool (or replicated queue), start to lower maximum size of merge to process.

Maximum in total size of parts to merge, when there are minimum free threads in background pool (or entries in replication queue).

Compression settings for the ClickHouse cluster. See in-depth description in ClickHouse documentation.

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

• LZ4: LZ4 compression algorithm.
• ZSTD: Zstandard compression algorithm.

Minimum size of a part of a table.

The minimum value is 1.

Minimum ratio of a part relative to the size of all the data in the table.

Configuration of external dictionaries to be used by the ClickHouse cluster. See in-depth description in ClickHouse documentation.

Required. Name of the external dictionary.

Single numeric key column for the dictionary.

Numeric key.

Required. Name of the numeric key.

Composite key for the dictionary, containing of one or more key columns. For details, see ClickHouse documentation.

Complex key.

Required. Attributes of a complex key.

Must contain at least one element.

Required. Name of the column.

Required. Type of the column.

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

Expression, describing the attribute, if applicable.

Indication of hierarchy support. Default value: false.

Indication of injective mapping "id -> attribute". Default value: false.

Field holding the beginning of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation.

Required. Name of the column.

Required. Type of the column.

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

Expression, describing the attribute, if applicable.

Indication of hierarchy support. Default value: false.

Indication of injective mapping "id -> attribute". Default value: false.

Field holding the end of the range for dictionaries with RANGE_HASHED layout. For details, see ClickHouse documentation.

Required. Name of the column.

Required. Type of the column.

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

Expression, describing the attribute, if applicable.

Indication of hierarchy support. Default value: false.

Indication of injective mapping "id -> attribute". Default value: false.

Required. Description of the fields available for database queries. For details, see ClickHouse documentation.

Must contain at least one element.

Required. Name of the column.

Required. Type of the column.

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

Expression, describing the attribute, if applicable.

Indication of hierarchy support. Default value: false.

Indication of injective mapping "id -> attribute". Default value: false.

Layout determining how to store the dictionary in memory.

Required. Layout type for an external dictionary.

• FLAT: The entire dictionary is stored in memory in the form of flat arrays. Available for all dictionary sources.
• HASHED: The entire dictionary is stored in memory in the form of a hash table. Available for all dictionary sources.
• COMPLEX_KEY_HASHED: Similar to HASHED, to be used with composite keys. Available for all dictionary sources.
• RANGE_HASHED: The entire dictionary is stored in memory in the form of a hash table, with an ordered array of ranges and their corresponding values. Available for all dictionary sources.
• CACHE: The dictionary is stored in a cache with a set number of cells. Available for MySQL, ClickHouse and HTTP dictionary sources.
• COMPLEX_KEY_CACHE: Similar to CACHE, to be used with composite keys. Available for MySQL, ClickHouse and HTTP dictionary sources.

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

Fixed interval between dictionary updates.

Minimum dictionary lifetime.

Maximum dictionary lifetime.

Required. URL of the source dictionary available over HTTP.

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

Required. Name of the MySQL database to connect to.

Required. Name of the database table to use as a ClickHouse dictionary.

Default port to use when connecting to a replica of the dictionary source.

Acceptable values are 0 to 65535, inclusive.

Name of the default user for replicas of the dictionary source.

Password of the default user for replicas of the dictionary source.

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

Must contain at least one element.

Required. MySQL host of the replica.

The maximum string length in characters is 253.

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

Value must be greater than 0.

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.

Acceptable values are 0 to 65535, inclusive.

Name of the MySQL database user.

Password of the MySQL database user.

Selection criteria for the data in the specified MySQL table.

Query for checking the dictionary status, to pull only updated data. For more details, see ClickHouse documentation on dictionaries.

Required. Name of the ClickHouse database.

Required. Name of the table in the specified database to be used as the dictionary source.

Required. ClickHouse host of the specified database.

The maximum string length in characters is 253.

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

Required. Name of the ClickHouse database user.

Password of the ClickHouse database user.

Selection criteria for the data in the specified ClickHouse table.

Required. Name of the MongoDB database.

Required. Name of the collection in the specified database to be used as the dictionary source.

Required. MongoDB host of the specified database.

The maximum string length in characters is 253.

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

Required. Name of the MongoDB database user.

Password of the MongoDB database user.

Required. Name of the PostrgreSQL database.

Required. Name of the table in the specified database to be used as the dictionary source.

Required. Name of the PostrgreSQL host

Must contain at least one element.

Port to use when connecting to the host.

Acceptable values are 0 to 65535, inclusive.

Required. Name of the PostrgreSQL database user.

Password of the PostrgreSQL database user.

Query for checking the dictionary status, to pull only updated data. For more details, see ClickHouse documentation on dictionaries.

Mode of SSL TCP/IP connection to the PostgreSQL host. For more details, see PostgreSQL documentation.

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

Rollup settings for the GraphiteMergeTree table engine.

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

Required. Pattern to use for the rollup.

Must contain at least one element.

Pattern for metric names.

Required. Name of the aggregating function to apply to data of the age specified in retention.

Required. Age of data to use for thinning.

Must contain at least one element.

Minimum age of the data in seconds.

Value must be greater than 0.

Precision of determining the age of the data, in seconds.

Value must be greater than 0.

Required.

Required.

Maximum number of inbound connections.

The minimum value is 10.

Maximum number of simultaneously processed requests.

The minimum value is 10.

Number of milliseconds that ClickHouse waits for incoming requests before closing the connection.

Cache size (in bytes) for uncompressed data used by MergeTree tables.

Approximate size (in bytes) of the cache of "marks" used by MergeTree tables.

Value must be greater than 0.

Maximum size of the table that can be deleted using a DROP query.

Maximum size of the partition that can be deleted using a DROP query.

The setting is deprecated and has no effect.

The server's time zone to be used in DateTime fields conversions. Specified as an IANA identifier.

Address of the archive with the user geobase in Object Storage.

The maximum size that query_log can grow to before old data will be removed. If set to 0, automatic removal of query_log data based on size is disabled.

The maximum time that query_log records will be retained before removal. If set to 0, automatic removal of query_log data based on time is disabled.

Whether query_thread_log system table is enabled.

The maximum size that query_thread_log can grow to before old data will be removed. If set to 0, automatic removal of query_thread_log data based on size is disabled.

The maximum time that query_thread_log records will be retained before removal. If set to 0, automatic removal of query_thread_log data based on time is disabled.

The maximum size that part_log can grow to before old data will be removed. If set to 0, automatic removal of part_log data based on size is disabled.

The maximum time that part_log records will be retained before removal. If set to 0, automatic removal of part_log data based on time is disabled.

Whether metric_log system table is enabled.

The maximum size that metric_log can grow to before old data will be removed. If set to 0, automatic removal of metric_log data based on size is disabled.

The maximum time that metric_log records will be retained before removal. If set to 0, automatic removal of metric_log data based on time is disabled.

Whether trace_log system table is enabled.

The maximum size that trace_log can grow to before old data will be removed. If set to 0, automatic removal of trace_log data based on size is disabled.

The maximum time that trace_log records will be retained before removal. If set to 0, automatic removal of trace_log data based on time is disabled.

Whether text_log system table is enabled.

The maximum size that text_log can grow to before old data will be removed. If set to 0, automatic removal of text_log data based on size is disabled.

The maximum time that text_log records will be retained before removal. If set to 0, automatic removal of text_log data based on time is disabled.

Logging level for text_log system table. Possible values: TRACE, DEBUG, INFORMATION, WARNING, ERROR.

Value must be greater than 0.

Value must be greater than 0.

Resources allocated to ClickHouse hosts.

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

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

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.

Configuration and resource allocation for ZooKeeper hosts.

Resources allocated to ZooKeeper hosts.

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

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

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.

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

Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and google.protobuf.Timestamp.

Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.

Minutes of hour of day. Must be from 0 to 59.

Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.

Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.

Access policy for external services.

Allow to export data from the cluster to Yandex DataLens.

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

See SQL queries in the management console for more details.

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

See Export data to Yandex Cloud for more details.

Allow access to cluster for Serverless.

Allow access for DataTransfer

Allow access for YandexQuery

Whether to use Yandex Object Storage for storing ClickHouse data.

Whether database management through SQL commands is enabled.

Whether user management through SQL commands is enabled.

Whether cluster should use embedded Keeper instead of Zookeeper.

ID of the network that the cluster belongs to.

Aggregated cluster health.

• HEALTH_UNKNOWN: State of the cluster is unknown (health for every host in the cluster is UNKNOWN).
• ALIVE: Cluster is alive and well (health for every host in the cluster is ALIVE).
• DEAD: Cluster is inoperable (health for every host in the cluster is DEAD).
• DEGRADED: Cluster is working below capacity (health for at least one host in the cluster is not ALIVE).

Current state of the cluster.

• 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 of the service account used for access to Yandex Object Storage.

Maintenance window for the cluster.

A maintenance window settings.

Weelky maintenance window settings.

Day of the week (in DDD format).

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

Acceptable values are 1 to 24, inclusive.

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

A planned maintenance operation.

Information about this maintenance operation.

The maximum string length in characters is 256.

Time until which this maintenance operation is delayed.

String in RFC3339 text format.

User security groups

Deletion Protection inhibits deletion of the cluster

This token allows you to get the next page of results for list requests. If the number of results is larger than pageSize, use the nextPageToken as the value for the pageToken parameter in the next list request. Each subsequent list request will have its own nextPageToken to continue paging through the results.