UserService

A set of methods for managing ClickHouse User resources.
NOTE: these methods are available only if user management through SQL is disabled.

Call	Description
Get	Returns the specified ClickHouse User resource.
List	Retrieves the list of ClickHouse User resources in the specified cluster.
Create	Creates a ClickHouse user in the specified cluster.
Update	Updates the specified ClickHouse user.
Delete	Deletes the specified ClickHouse user.
GrantPermission	Grants a permission to the specified ClickHouse user.
RevokePermission	Revokes a permission from the specified ClickHouse user.

Calls UserService

Get

Returns the specified ClickHouse User resource.
To get the list of available ClickHouse User resources, make a List request.

rpc Get (GetUserRequest) returns (User)

GetUserRequest

Field	Description
cluster_id	string Required. ID of the ClickHouse cluster the user belongs to. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
user_name	string Required. Name of the ClickHouse User resource to return. To get the name of the user, use a UserService.List request. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_]*.

User

Field	Description
name	string Name of the ClickHouse user.
cluster_id	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.

Permission

Field	Description
database_name	string Name of the database that the permission grants access to.

UserSettings

Field	Description
readonly	google.protobuf.Int64Value 0 (default)—no restrictions. 1—only read data queries are allowed. 2—read data and change settings queries are allowed. Acceptable values are 0 to 2, inclusive.
allow_ddl	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.
insert_quorum	google.protobuf.Int64Value replicas with no errors until the insert_quorum_timeout expires. queries. The minimum value is 0.
connect_timeout	google.protobuf.Int64Value (default: 10000, 10 seconds). Value must be greater than 0.
receive_timeout	google.protobuf.Int64Value (default: 300000, 300 seconds or 5 minutes). Value must be greater than 0.
send_timeout	google.protobuf.Int64Value (default: 300000, 300 seconds or 5 minutes). Value must be greater than 0.
insert_quorum_timeout	google.protobuf.Int64Value query and return an error. The minimum value is 1000.
select_sequential_consistency	google.protobuf.BoolValue 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. (sequential consistency is disabled).
max_replica_delay_for_distributed_queries	google.protobuf.Int64Value Max replica delay in milliseconds. If a replica lags more than the set value, this replica is not used and becomes a stale one. Minimum value: 1000, 1 second (default: 300000, 300 seconds or 5 minutes). See in-depth description in ClickHouse documentation. The minimum value is 1000.
fallback_to_stale_replicas_for_distributed_queries	google.protobuf.BoolValue query from a distributed table that points to replicated tables. (query forcing is enabled).
replication_alter_partitions_sync	google.protobuf.Int64Value queries on replicated tables: 0—do not wait for replicas. 1—only wait for own execution (default). 2—wait for all replicas. Acceptable values are 0 to 2, inclusive.
distributed_product_mode	enum DistributedProductMode Determine the behavior of distributed subqueries. See in-depth description in ClickHouse documentation. 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.
distributed_aggregation_memory_efficient	google.protobuf.BoolValue (memory saving mode is disabled).
distributed_ddl_task_timeout	google.protobuf.Int64Value Timeout for DDL queries, in milliseconds.
skip_unavailable_shards	google.protobuf.BoolValue (silent skipping is disabled).
compile	google.protobuf.BoolValue (compilation is disabled).
min_count_to_compile	google.protobuf.Int64Value (default: 3). value compilation is synchronous: a query waits for compilation process to complete prior to continuing execution. The minimum value is 0.
compile_expressions	google.protobuf.BoolValue (expression compilation is disabled).
min_count_to_compile_expression	google.protobuf.Int64Value (default: 3). value compilation is synchronous: a query waits for expression compilation process to complete prior to continuing execution. The minimum value is 0.
max_block_size	google.protobuf.Int64Value (default: 65536). Value must be greater than 0.
min_insert_block_size_rows	google.protobuf.Int64Value query. The minimum value is 0.
min_insert_block_size_bytes	google.protobuf.Int64Value query. The minimum value is 0.
max_insert_block_size	google.protobuf.Int64Value (default: 1048576). Value must be greater than 0.
min_bytes_to_use_direct_io	google.protobuf.Int64Value Limits the minimum number of bytes to enable unbuffered direct reads from disk (Direct I/O). 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. The minimum value is 0.
use_uncompressed_cache	google.protobuf.BoolValue (uncompressed cache is disabled).
merge_tree_max_rows_to_use_cache	google.protobuf.Int64Value (default: 128x8192). Value must be greater than 0.
merge_tree_max_bytes_to_use_cache	google.protobuf.Int64Value (default: 192x10x1024x1024). Value must be greater than 0.
merge_tree_min_rows_for_concurrent_read	google.protobuf.Int64Value (default: 20x8192). Value must be greater than 0.
merge_tree_min_bytes_for_concurrent_read	google.protobuf.Int64Value (default: 24x10x1024x1024). Value must be greater than 0.
max_bytes_before_external_group_by	google.protobuf.Int64Value operation, should be flushed to disk to limit the RAM comsumption. in the external memory is disabled.
max_bytes_before_external_sort	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.
group_by_two_level_threshold	google.protobuf.Int64Value Sets the threshold of the number of keys, after that the two-level aggregation should be used. Minimal value: 0, threshold is not set (default: 10000‬‬).
group_by_two_level_threshold_bytes	google.protobuf.Int64Value Sets the threshold of the number of bytes, after that the two-level aggregation should be used. Minimal value: 0, threshold is not set (default: 100000000‬‬).
priority	google.protobuf.Int64Value 0—priority is not used. 1—the highest priority. and so on. The higher the number, the lower a query's priority. The minimum value is 0.
max_threads	google.protobuf.Int64Value (the thread number is calculated automatically based on the number of physical CPU cores, no HyperThreading cores are taken into account). Value must be greater than 0.
max_memory_usage	google.protobuf.Int64Value (10 GB). The minimum value is 0.
max_memory_usage_for_user	google.protobuf.Int64Value Limits the maximum memory usage (in bytes) for processing of user's queries on a single server. 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. The minimum value is 0.
max_network_bandwidth	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.
max_network_bandwidth_for_user	google.protobuf.Int64Value The maximum speed of data exchange over the network in bytes per second for all concurrently running user queries. Minimal value and default value: 0, no limitation is set.
force_index_by_date	google.protobuf.BoolValue (setting is disabled, query executes even if ClickHouse can't use index by date).
force_primary_key	google.protobuf.BoolValue (setting is disabled, query executes even if ClickHouse can't use index by primary key).
max_rows_to_read	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. The minimum value is 0.
max_bytes_to_read	google.protobuf.Int64Value Limits the maximum number of bytes (uncompressed data) that can be read from a table when running a query. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
read_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_to_group_by	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. The minimum value is 0.
group_by_overflow_mode	enum GroupByOverflowMode 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.
max_rows_to_sort	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. The minimum value is 0.
max_bytes_to_sort	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. The minimum value is 0.
sort_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_result_rows	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. The minimum value is 0.
max_result_bytes	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. The minimum value is 0.
result_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_in_distinct	google.protobuf.Int64Value Limits the maximum number of different rows when using DISTINCT. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
max_bytes_in_distinct	google.protobuf.Int64Value Limits the maximum size of a hash table in bytes (uncompressed data) when using DISTINCT. The minimum value is 0.
distinct_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_to_transfer	google.protobuf.Int64Value Limits the maximum number of rows that can be passed to a remote server or saved in a temporary table when using GLOBAL IN. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
max_bytes_to_transfer	google.protobuf.Int64Value Limits the maximum number of bytes (uncompressed data) that can be passed to a remote server or saved in a temporary table when using GLOBAL IN. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
transfer_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_execution_time	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. The minimum value is 0.
timeout_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_in_set	google.protobuf.Int64Value Limit on the number of rows in the set resulting from the execution of the IN section. The minimum value is 0.
max_bytes_in_set	google.protobuf.Int64Value Limit on the number of bytes in the set resulting from the execution of the IN section. The minimum value is 0.
set_overflow_mode	enum OverflowMode Determine the behavior on exceeding max_rows_in_set or max_bytes_in_set limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK.
max_rows_in_join	google.protobuf.Int64Value Limit on maximum size of the hash table for JOIN, in rows. The minimum value is 0.
max_bytes_in_join	google.protobuf.Int64Value Limit on maximum size of the hash table for JOIN, in bytes. The minimum value is 0.
join_overflow_mode	enum OverflowMode Determine the behavior on exceeding max_rows_in_join or max_bytes_in_join limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK.
max_columns_to_read	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. The minimum value is 0.
max_temporary_columns	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. The minimum value is 0.
max_temporary_non_const_columns	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. The minimum value is 0.
max_query_size	google.protobuf.Int64Value (default: 262144). Value must be greater than 0.
max_ast_depth	google.protobuf.Int64Value query may result in more complex and deeper syntax tree, compared to the SELECT ... WHERE ... query, containing constraints and conditions, in the most cases. (default: 1000). Value must be greater than 0.
max_ast_elements	google.protobuf.Int64Value (default: 50000). Value must be greater than 0.
max_expanded_ast_elements	google.protobuf.Int64Value (default: 500000). Value must be greater than 0.
min_execution_speed	google.protobuf.Int64Value Minimal execution speed in rows per second. The minimum value is 0.
min_execution_speed_bytes	google.protobuf.Int64Value Minimal execution speed in bytes per second. The minimum value is 0.
count_distinct_implementation	enum CountDistinctImplementation Aggregate function to use for implementation of count(DISTINCT ...).
input_format_values_interpret_expressions	google.protobuf.BoolValue expression; therefore an INSERT query for this value will fail and no data will be inserted into a table. expression will be parsed as SQL function, interpreted, and the current date and time will be inserted into the table as a result. (SQL parser is enabled).
input_format_defaults_for_omitted_fields	google.protobuf.BoolValue queries. (replacing is enabled).
output_format_json_quote_64bit_integers	google.protobuf.BoolValue and Int64) will be quoted when written to JSON output in order to maintain compatibility with the most of the JavaScript engines. (quoting 64-bit integers is disabled).
output_format_json_quote_denormals	google.protobuf.BoolValue and -inf) in JSON output format. (special values do not present in output).
low_cardinality_allow_in_native_format	google.protobuf.BoolValue 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 are used in Native format).
empty_result_for_aggregation_by_empty_set	google.protobuf.BoolValue 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.
joined_subquery_requires_alias	google.protobuf.BoolValue
join_use_nulls	google.protobuf.BoolValue
transform_null_in	google.protobuf.BoolValue
http_connection_timeout	google.protobuf.Int64Value (default: 1000, 1 second).
http_receive_timeout	google.protobuf.Int64Value (default: 1800000, 1800 seconds, 30 minutes).
http_send_timeout	google.protobuf.Int64Value (default: 1800000, 1800 seconds, 30 minutes).
enable_http_compression	google.protobuf.BoolValue HTTP header in a HTTP request to force compression of HTTP response from ClickHouse. and deflate. (compression is disabled).
send_progress_in_http_headers	google.protobuf.BoolValue HTTP header. (notifications disabled).
http_headers_progress_interval	google.protobuf.Int64Value HTTP header, in milliseconds. (default: 100).
add_http_cors_header	google.protobuf.BoolValue (header is not added).
quota_mode	enum QuotaMode Quota accounting mode. Possible values: QUOTA_MODE_DEFAULT, QUOTA_MODE_KEYED and QUOTA_MODE_KEYED_BY_IP.

UserQuota

Field	Description
interval_duration	google.protobuf.Int64Value Duration of interval for quota in milliseconds. Minimal value is 1 second. The minimum value is 1000.
queries	google.protobuf.Int64Value The total number of queries. 0 - unlimited. The minimum value is 0.
errors	google.protobuf.Int64Value The number of queries that threw exception. 0 - unlimited. The minimum value is 0.
result_rows	google.protobuf.Int64Value The total number of rows given as the result.. 0 - unlimited. The minimum value is 0.
read_rows	google.protobuf.Int64Value The total number of source rows read from tables for running the query, on all remote servers. 0 - unlimited. The minimum value is 0.
execution_time	google.protobuf.Int64Value The total query execution time, in milliseconds (wall time). 0 - unlimited. The minimum value is 0.

List

Retrieves the list of ClickHouse User resources in the specified cluster.

rpc List (ListUsersRequest) returns (ListUsersResponse)

ListUsersRequest

Field	Description
cluster_id	string Required. ID of the cluster to list ClickHouse users in. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
page_size	int64 The maximum number of results per page to return. If the number of available results is larger than page_size, the service returns a ListUsersResponse.next_page_token that can be used to get the next page of results in subsequent list requests. The maximum value is 1000.
page_token	string Page token. To get the next page of results, set page_token to the ListUsersResponse.next_page_token returned by a previous list request. The maximum string length in characters is 100.

ListUsersResponse

Field	Description
users[]	User List of ClickHouse User resources.
next_page_token	string This token allows you to get the next page of results for list requests. If the number of results is larger than ListUsersRequest.page_size, use the next_page_token as the value for the ListUsersRequest.page_token parameter in the next list request. Each subsequent list request will have its own next_page_token to continue paging through the results.

User

Field	Description
name	string Name of the ClickHouse user.
cluster_id	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.

Permission

Field	Description
database_name	string Name of the database that the permission grants access to.

UserSettings

Field	Description
readonly	google.protobuf.Int64Value 0 (default)—no restrictions. 1—only read data queries are allowed. 2—read data and change settings queries are allowed. Acceptable values are 0 to 2, inclusive.
allow_ddl	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.
insert_quorum	google.protobuf.Int64Value replicas with no errors until the insert_quorum_timeout expires. queries. The minimum value is 0.
connect_timeout	google.protobuf.Int64Value (default: 10000, 10 seconds). Value must be greater than 0.
receive_timeout	google.protobuf.Int64Value (default: 300000, 300 seconds or 5 minutes). Value must be greater than 0.
send_timeout	google.protobuf.Int64Value (default: 300000, 300 seconds or 5 minutes). Value must be greater than 0.
insert_quorum_timeout	google.protobuf.Int64Value query and return an error. The minimum value is 1000.
select_sequential_consistency	google.protobuf.BoolValue 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. (sequential consistency is disabled).
max_replica_delay_for_distributed_queries	google.protobuf.Int64Value Max replica delay in milliseconds. If a replica lags more than the set value, this replica is not used and becomes a stale one. Minimum value: 1000, 1 second (default: 300000, 300 seconds or 5 minutes). See in-depth description in ClickHouse documentation. The minimum value is 1000.
fallback_to_stale_replicas_for_distributed_queries	google.protobuf.BoolValue query from a distributed table that points to replicated tables. (query forcing is enabled).
replication_alter_partitions_sync	google.protobuf.Int64Value queries on replicated tables: 0—do not wait for replicas. 1—only wait for own execution (default). 2—wait for all replicas. Acceptable values are 0 to 2, inclusive.
distributed_product_mode	enum DistributedProductMode Determine the behavior of distributed subqueries. See in-depth description in ClickHouse documentation. 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.
distributed_aggregation_memory_efficient	google.protobuf.BoolValue (memory saving mode is disabled).
distributed_ddl_task_timeout	google.protobuf.Int64Value Timeout for DDL queries, in milliseconds.
skip_unavailable_shards	google.protobuf.BoolValue (silent skipping is disabled).
compile	google.protobuf.BoolValue (compilation is disabled).
min_count_to_compile	google.protobuf.Int64Value (default: 3). value compilation is synchronous: a query waits for compilation process to complete prior to continuing execution. The minimum value is 0.
compile_expressions	google.protobuf.BoolValue (expression compilation is disabled).
min_count_to_compile_expression	google.protobuf.Int64Value (default: 3). value compilation is synchronous: a query waits for expression compilation process to complete prior to continuing execution. The minimum value is 0.
max_block_size	google.protobuf.Int64Value (default: 65536). Value must be greater than 0.
min_insert_block_size_rows	google.protobuf.Int64Value query. The minimum value is 0.
min_insert_block_size_bytes	google.protobuf.Int64Value query. The minimum value is 0.
max_insert_block_size	google.protobuf.Int64Value (default: 1048576). Value must be greater than 0.
min_bytes_to_use_direct_io	google.protobuf.Int64Value Limits the minimum number of bytes to enable unbuffered direct reads from disk (Direct I/O). 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. The minimum value is 0.
use_uncompressed_cache	google.protobuf.BoolValue (uncompressed cache is disabled).
merge_tree_max_rows_to_use_cache	google.protobuf.Int64Value (default: 128x8192). Value must be greater than 0.
merge_tree_max_bytes_to_use_cache	google.protobuf.Int64Value (default: 192x10x1024x1024). Value must be greater than 0.
merge_tree_min_rows_for_concurrent_read	google.protobuf.Int64Value (default: 20x8192). Value must be greater than 0.
merge_tree_min_bytes_for_concurrent_read	google.protobuf.Int64Value (default: 24x10x1024x1024). Value must be greater than 0.
max_bytes_before_external_group_by	google.protobuf.Int64Value operation, should be flushed to disk to limit the RAM comsumption. in the external memory is disabled.
max_bytes_before_external_sort	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.
group_by_two_level_threshold	google.protobuf.Int64Value Sets the threshold of the number of keys, after that the two-level aggregation should be used. Minimal value: 0, threshold is not set (default: 10000‬‬).
group_by_two_level_threshold_bytes	google.protobuf.Int64Value Sets the threshold of the number of bytes, after that the two-level aggregation should be used. Minimal value: 0, threshold is not set (default: 100000000‬‬).
priority	google.protobuf.Int64Value 0—priority is not used. 1—the highest priority. and so on. The higher the number, the lower a query's priority. The minimum value is 0.
max_threads	google.protobuf.Int64Value (the thread number is calculated automatically based on the number of physical CPU cores, no HyperThreading cores are taken into account). Value must be greater than 0.
max_memory_usage	google.protobuf.Int64Value (10 GB). The minimum value is 0.
max_memory_usage_for_user	google.protobuf.Int64Value Limits the maximum memory usage (in bytes) for processing of user's queries on a single server. 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. The minimum value is 0.
max_network_bandwidth	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.
max_network_bandwidth_for_user	google.protobuf.Int64Value The maximum speed of data exchange over the network in bytes per second for all concurrently running user queries. Minimal value and default value: 0, no limitation is set.
force_index_by_date	google.protobuf.BoolValue (setting is disabled, query executes even if ClickHouse can't use index by date).
force_primary_key	google.protobuf.BoolValue (setting is disabled, query executes even if ClickHouse can't use index by primary key).
max_rows_to_read	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. The minimum value is 0.
max_bytes_to_read	google.protobuf.Int64Value Limits the maximum number of bytes (uncompressed data) that can be read from a table when running a query. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
read_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_to_group_by	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. The minimum value is 0.
group_by_overflow_mode	enum GroupByOverflowMode 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.
max_rows_to_sort	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. The minimum value is 0.
max_bytes_to_sort	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. The minimum value is 0.
sort_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_result_rows	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. The minimum value is 0.
max_result_bytes	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. The minimum value is 0.
result_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_in_distinct	google.protobuf.Int64Value Limits the maximum number of different rows when using DISTINCT. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
max_bytes_in_distinct	google.protobuf.Int64Value Limits the maximum size of a hash table in bytes (uncompressed data) when using DISTINCT. The minimum value is 0.
distinct_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_to_transfer	google.protobuf.Int64Value Limits the maximum number of rows that can be passed to a remote server or saved in a temporary table when using GLOBAL IN. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
max_bytes_to_transfer	google.protobuf.Int64Value Limits the maximum number of bytes (uncompressed data) that can be passed to a remote server or saved in a temporary table when using GLOBAL IN. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
transfer_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_execution_time	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. The minimum value is 0.
timeout_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_in_set	google.protobuf.Int64Value Limit on the number of rows in the set resulting from the execution of the IN section. The minimum value is 0.
max_bytes_in_set	google.protobuf.Int64Value Limit on the number of bytes in the set resulting from the execution of the IN section. The minimum value is 0.
set_overflow_mode	enum OverflowMode Determine the behavior on exceeding max_rows_in_set or max_bytes_in_set limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK.
max_rows_in_join	google.protobuf.Int64Value Limit on maximum size of the hash table for JOIN, in rows. The minimum value is 0.
max_bytes_in_join	google.protobuf.Int64Value Limit on maximum size of the hash table for JOIN, in bytes. The minimum value is 0.
join_overflow_mode	enum OverflowMode Determine the behavior on exceeding max_rows_in_join or max_bytes_in_join limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK.
max_columns_to_read	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. The minimum value is 0.
max_temporary_columns	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. The minimum value is 0.
max_temporary_non_const_columns	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. The minimum value is 0.
max_query_size	google.protobuf.Int64Value (default: 262144). Value must be greater than 0.
max_ast_depth	google.protobuf.Int64Value query may result in more complex and deeper syntax tree, compared to the SELECT ... WHERE ... query, containing constraints and conditions, in the most cases. (default: 1000). Value must be greater than 0.
max_ast_elements	google.protobuf.Int64Value (default: 50000). Value must be greater than 0.
max_expanded_ast_elements	google.protobuf.Int64Value (default: 500000). Value must be greater than 0.
min_execution_speed	google.protobuf.Int64Value Minimal execution speed in rows per second. The minimum value is 0.
min_execution_speed_bytes	google.protobuf.Int64Value Minimal execution speed in bytes per second. The minimum value is 0.
count_distinct_implementation	enum CountDistinctImplementation Aggregate function to use for implementation of count(DISTINCT ...).
input_format_values_interpret_expressions	google.protobuf.BoolValue expression; therefore an INSERT query for this value will fail and no data will be inserted into a table. expression will be parsed as SQL function, interpreted, and the current date and time will be inserted into the table as a result. (SQL parser is enabled).
input_format_defaults_for_omitted_fields	google.protobuf.BoolValue queries. (replacing is enabled).
output_format_json_quote_64bit_integers	google.protobuf.BoolValue and Int64) will be quoted when written to JSON output in order to maintain compatibility with the most of the JavaScript engines. (quoting 64-bit integers is disabled).
output_format_json_quote_denormals	google.protobuf.BoolValue and -inf) in JSON output format. (special values do not present in output).
low_cardinality_allow_in_native_format	google.protobuf.BoolValue 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 are used in Native format).
empty_result_for_aggregation_by_empty_set	google.protobuf.BoolValue 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.
joined_subquery_requires_alias	google.protobuf.BoolValue
join_use_nulls	google.protobuf.BoolValue
transform_null_in	google.protobuf.BoolValue
http_connection_timeout	google.protobuf.Int64Value (default: 1000, 1 second).
http_receive_timeout	google.protobuf.Int64Value (default: 1800000, 1800 seconds, 30 minutes).
http_send_timeout	google.protobuf.Int64Value (default: 1800000, 1800 seconds, 30 minutes).
enable_http_compression	google.protobuf.BoolValue HTTP header in a HTTP request to force compression of HTTP response from ClickHouse. and deflate. (compression is disabled).
send_progress_in_http_headers	google.protobuf.BoolValue HTTP header. (notifications disabled).
http_headers_progress_interval	google.protobuf.Int64Value HTTP header, in milliseconds. (default: 100).
add_http_cors_header	google.protobuf.BoolValue (header is not added).
quota_mode	enum QuotaMode Quota accounting mode. Possible values: QUOTA_MODE_DEFAULT, QUOTA_MODE_KEYED and QUOTA_MODE_KEYED_BY_IP.

UserQuota

Field	Description
interval_duration	google.protobuf.Int64Value Duration of interval for quota in milliseconds. Minimal value is 1 second. The minimum value is 1000.
queries	google.protobuf.Int64Value The total number of queries. 0 - unlimited. The minimum value is 0.
errors	google.protobuf.Int64Value The number of queries that threw exception. 0 - unlimited. The minimum value is 0.
result_rows	google.protobuf.Int64Value The total number of rows given as the result.. 0 - unlimited. The minimum value is 0.
read_rows	google.protobuf.Int64Value The total number of source rows read from tables for running the query, on all remote servers. 0 - unlimited. The minimum value is 0.
execution_time	google.protobuf.Int64Value The total query execution time, in milliseconds (wall time). 0 - unlimited. The minimum value is 0.

Create

Creates a ClickHouse user in the specified cluster.

rpc Create (CreateUserRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:CreateUserMetadata

    Operation.response:User

CreateUserRequest

Field	Description
cluster_id	string Required. ID of the ClickHouse cluster to create a user in. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
user_spec	UserSpec Required. Properties of the user to be created.

UserSpec

Field	Description
name	string Required. Name of the ClickHouse user. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_]*.
password	string Required. Password of the ClickHouse user. The string length in characters must be 8-128.
permissions[]	Permission Set of permissions to grant to the user.
settings	UserSettings
quotas[]	UserQuota Set of quotas assigned to the user.

Permission

Field	Description
database_name	string Name of the database that the permission grants access to.

UserSettings

Field	Description
readonly	google.protobuf.Int64Value 0 (default)—no restrictions. 1—only read data queries are allowed. 2—read data and change settings queries are allowed. Acceptable values are 0 to 2, inclusive.
allow_ddl	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.
insert_quorum	google.protobuf.Int64Value replicas with no errors until the insert_quorum_timeout expires. queries. The minimum value is 0.
connect_timeout	google.protobuf.Int64Value (default: 10000, 10 seconds). Value must be greater than 0.
receive_timeout	google.protobuf.Int64Value (default: 300000, 300 seconds or 5 minutes). Value must be greater than 0.
send_timeout	google.protobuf.Int64Value (default: 300000, 300 seconds or 5 minutes). Value must be greater than 0.
insert_quorum_timeout	google.protobuf.Int64Value query and return an error. The minimum value is 1000.
select_sequential_consistency	google.protobuf.BoolValue 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. (sequential consistency is disabled).
max_replica_delay_for_distributed_queries	google.protobuf.Int64Value Max replica delay in milliseconds. If a replica lags more than the set value, this replica is not used and becomes a stale one. Minimum value: 1000, 1 second (default: 300000, 300 seconds or 5 minutes). See in-depth description in ClickHouse documentation. The minimum value is 1000.
fallback_to_stale_replicas_for_distributed_queries	google.protobuf.BoolValue query from a distributed table that points to replicated tables. (query forcing is enabled).
replication_alter_partitions_sync	google.protobuf.Int64Value queries on replicated tables: 0—do not wait for replicas. 1—only wait for own execution (default). 2—wait for all replicas. Acceptable values are 0 to 2, inclusive.
distributed_product_mode	enum DistributedProductMode Determine the behavior of distributed subqueries. See in-depth description in ClickHouse documentation. 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.
distributed_aggregation_memory_efficient	google.protobuf.BoolValue (memory saving mode is disabled).
distributed_ddl_task_timeout	google.protobuf.Int64Value Timeout for DDL queries, in milliseconds.
skip_unavailable_shards	google.protobuf.BoolValue (silent skipping is disabled).
compile	google.protobuf.BoolValue (compilation is disabled).
min_count_to_compile	google.protobuf.Int64Value (default: 3). value compilation is synchronous: a query waits for compilation process to complete prior to continuing execution. The minimum value is 0.
compile_expressions	google.protobuf.BoolValue (expression compilation is disabled).
min_count_to_compile_expression	google.protobuf.Int64Value (default: 3). value compilation is synchronous: a query waits for expression compilation process to complete prior to continuing execution. The minimum value is 0.
max_block_size	google.protobuf.Int64Value (default: 65536). Value must be greater than 0.
min_insert_block_size_rows	google.protobuf.Int64Value query. The minimum value is 0.
min_insert_block_size_bytes	google.protobuf.Int64Value query. The minimum value is 0.
max_insert_block_size	google.protobuf.Int64Value (default: 1048576). Value must be greater than 0.
min_bytes_to_use_direct_io	google.protobuf.Int64Value Limits the minimum number of bytes to enable unbuffered direct reads from disk (Direct I/O). 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. The minimum value is 0.
use_uncompressed_cache	google.protobuf.BoolValue (uncompressed cache is disabled).
merge_tree_max_rows_to_use_cache	google.protobuf.Int64Value (default: 128x8192). Value must be greater than 0.
merge_tree_max_bytes_to_use_cache	google.protobuf.Int64Value (default: 192x10x1024x1024). Value must be greater than 0.
merge_tree_min_rows_for_concurrent_read	google.protobuf.Int64Value (default: 20x8192). Value must be greater than 0.
merge_tree_min_bytes_for_concurrent_read	google.protobuf.Int64Value (default: 24x10x1024x1024). Value must be greater than 0.
max_bytes_before_external_group_by	google.protobuf.Int64Value operation, should be flushed to disk to limit the RAM comsumption. in the external memory is disabled.
max_bytes_before_external_sort	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.
group_by_two_level_threshold	google.protobuf.Int64Value Sets the threshold of the number of keys, after that the two-level aggregation should be used. Minimal value: 0, threshold is not set (default: 10000‬‬).
group_by_two_level_threshold_bytes	google.protobuf.Int64Value Sets the threshold of the number of bytes, after that the two-level aggregation should be used. Minimal value: 0, threshold is not set (default: 100000000‬‬).
priority	google.protobuf.Int64Value 0—priority is not used. 1—the highest priority. and so on. The higher the number, the lower a query's priority. The minimum value is 0.
max_threads	google.protobuf.Int64Value (the thread number is calculated automatically based on the number of physical CPU cores, no HyperThreading cores are taken into account). Value must be greater than 0.
max_memory_usage	google.protobuf.Int64Value (10 GB). The minimum value is 0.
max_memory_usage_for_user	google.protobuf.Int64Value Limits the maximum memory usage (in bytes) for processing of user's queries on a single server. 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. The minimum value is 0.
max_network_bandwidth	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.
max_network_bandwidth_for_user	google.protobuf.Int64Value The maximum speed of data exchange over the network in bytes per second for all concurrently running user queries. Minimal value and default value: 0, no limitation is set.
force_index_by_date	google.protobuf.BoolValue (setting is disabled, query executes even if ClickHouse can't use index by date).
force_primary_key	google.protobuf.BoolValue (setting is disabled, query executes even if ClickHouse can't use index by primary key).
max_rows_to_read	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. The minimum value is 0.
max_bytes_to_read	google.protobuf.Int64Value Limits the maximum number of bytes (uncompressed data) that can be read from a table when running a query. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
read_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_to_group_by	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. The minimum value is 0.
group_by_overflow_mode	enum GroupByOverflowMode 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.
max_rows_to_sort	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. The minimum value is 0.
max_bytes_to_sort	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. The minimum value is 0.
sort_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_result_rows	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. The minimum value is 0.
max_result_bytes	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. The minimum value is 0.
result_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_in_distinct	google.protobuf.Int64Value Limits the maximum number of different rows when using DISTINCT. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
max_bytes_in_distinct	google.protobuf.Int64Value Limits the maximum size of a hash table in bytes (uncompressed data) when using DISTINCT. The minimum value is 0.
distinct_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_to_transfer	google.protobuf.Int64Value Limits the maximum number of rows that can be passed to a remote server or saved in a temporary table when using GLOBAL IN. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
max_bytes_to_transfer	google.protobuf.Int64Value Limits the maximum number of bytes (uncompressed data) that can be passed to a remote server or saved in a temporary table when using GLOBAL IN. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
transfer_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_execution_time	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. The minimum value is 0.
timeout_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_in_set	google.protobuf.Int64Value Limit on the number of rows in the set resulting from the execution of the IN section. The minimum value is 0.
max_bytes_in_set	google.protobuf.Int64Value Limit on the number of bytes in the set resulting from the execution of the IN section. The minimum value is 0.
set_overflow_mode	enum OverflowMode Determine the behavior on exceeding max_rows_in_set or max_bytes_in_set limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK.
max_rows_in_join	google.protobuf.Int64Value Limit on maximum size of the hash table for JOIN, in rows. The minimum value is 0.
max_bytes_in_join	google.protobuf.Int64Value Limit on maximum size of the hash table for JOIN, in bytes. The minimum value is 0.
join_overflow_mode	enum OverflowMode Determine the behavior on exceeding max_rows_in_join or max_bytes_in_join limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK.
max_columns_to_read	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. The minimum value is 0.
max_temporary_columns	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. The minimum value is 0.
max_temporary_non_const_columns	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. The minimum value is 0.
max_query_size	google.protobuf.Int64Value (default: 262144). Value must be greater than 0.
max_ast_depth	google.protobuf.Int64Value query may result in more complex and deeper syntax tree, compared to the SELECT ... WHERE ... query, containing constraints and conditions, in the most cases. (default: 1000). Value must be greater than 0.
max_ast_elements	google.protobuf.Int64Value (default: 50000). Value must be greater than 0.
max_expanded_ast_elements	google.protobuf.Int64Value (default: 500000). Value must be greater than 0.
min_execution_speed	google.protobuf.Int64Value Minimal execution speed in rows per second. The minimum value is 0.
min_execution_speed_bytes	google.protobuf.Int64Value Minimal execution speed in bytes per second. The minimum value is 0.
count_distinct_implementation	enum CountDistinctImplementation Aggregate function to use for implementation of count(DISTINCT ...).
input_format_values_interpret_expressions	google.protobuf.BoolValue expression; therefore an INSERT query for this value will fail and no data will be inserted into a table. expression will be parsed as SQL function, interpreted, and the current date and time will be inserted into the table as a result. (SQL parser is enabled).
input_format_defaults_for_omitted_fields	google.protobuf.BoolValue queries. (replacing is enabled).
output_format_json_quote_64bit_integers	google.protobuf.BoolValue and Int64) will be quoted when written to JSON output in order to maintain compatibility with the most of the JavaScript engines. (quoting 64-bit integers is disabled).
output_format_json_quote_denormals	google.protobuf.BoolValue and -inf) in JSON output format. (special values do not present in output).
low_cardinality_allow_in_native_format	google.protobuf.BoolValue 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 are used in Native format).
empty_result_for_aggregation_by_empty_set	google.protobuf.BoolValue 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.
joined_subquery_requires_alias	google.protobuf.BoolValue
join_use_nulls	google.protobuf.BoolValue
transform_null_in	google.protobuf.BoolValue
http_connection_timeout	google.protobuf.Int64Value (default: 1000, 1 second).
http_receive_timeout	google.protobuf.Int64Value (default: 1800000, 1800 seconds, 30 minutes).
http_send_timeout	google.protobuf.Int64Value (default: 1800000, 1800 seconds, 30 minutes).
enable_http_compression	google.protobuf.BoolValue HTTP header in a HTTP request to force compression of HTTP response from ClickHouse. and deflate. (compression is disabled).
send_progress_in_http_headers	google.protobuf.BoolValue HTTP header. (notifications disabled).
http_headers_progress_interval	google.protobuf.Int64Value HTTP header, in milliseconds. (default: 100).
add_http_cors_header	google.protobuf.BoolValue (header is not added).
quota_mode	enum QuotaMode Quota accounting mode. Possible values: QUOTA_MODE_DEFAULT, QUOTA_MODE_KEYED and QUOTA_MODE_KEYED_BY_IP.

UserQuota

Field	Description
interval_duration	google.protobuf.Int64Value Duration of interval for quota in milliseconds. Minimal value is 1 second. The minimum value is 1000.
queries	google.protobuf.Int64Value The total number of queries. 0 - unlimited. The minimum value is 0.
errors	google.protobuf.Int64Value The number of queries that threw exception. 0 - unlimited. The minimum value is 0.
result_rows	google.protobuf.Int64Value The total number of rows given as the result.. 0 - unlimited. The minimum value is 0.
read_rows	google.protobuf.Int64Value The total number of source rows read from tables for running the query, on all remote servers. 0 - unlimited. The minimum value is 0.
execution_time	google.protobuf.Int64Value The total query execution time, in milliseconds (wall time). 0 - unlimited. The minimum value is 0.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<CreateUserMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<User> if operation finished successfully.

CreateUserMetadata

Field	Description
cluster_id	string ID of the ClickHouse cluster the user is being created in.
user_name	string Name of the user that is being created.

User

Field	Description
name	string Name of the ClickHouse user.
cluster_id	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.

Permission

Field	Description
database_name	string Name of the database that the permission grants access to.

UserSettings

Field	Description
readonly	google.protobuf.Int64Value 0 (default)—no restrictions. 1—only read data queries are allowed. 2—read data and change settings queries are allowed. Acceptable values are 0 to 2, inclusive.
allow_ddl	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.
insert_quorum	google.protobuf.Int64Value replicas with no errors until the insert_quorum_timeout expires. queries. The minimum value is 0.
connect_timeout	google.protobuf.Int64Value (default: 10000, 10 seconds). Value must be greater than 0.
receive_timeout	google.protobuf.Int64Value (default: 300000, 300 seconds or 5 minutes). Value must be greater than 0.
send_timeout	google.protobuf.Int64Value (default: 300000, 300 seconds or 5 minutes). Value must be greater than 0.
insert_quorum_timeout	google.protobuf.Int64Value query and return an error. The minimum value is 1000.
select_sequential_consistency	google.protobuf.BoolValue 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. (sequential consistency is disabled).
max_replica_delay_for_distributed_queries	google.protobuf.Int64Value Max replica delay in milliseconds. If a replica lags more than the set value, this replica is not used and becomes a stale one. Minimum value: 1000, 1 second (default: 300000, 300 seconds or 5 minutes). See in-depth description in ClickHouse documentation. The minimum value is 1000.
fallback_to_stale_replicas_for_distributed_queries	google.protobuf.BoolValue query from a distributed table that points to replicated tables. (query forcing is enabled).
replication_alter_partitions_sync	google.protobuf.Int64Value queries on replicated tables: 0—do not wait for replicas. 1—only wait for own execution (default). 2—wait for all replicas. Acceptable values are 0 to 2, inclusive.
distributed_product_mode	enum DistributedProductMode Determine the behavior of distributed subqueries. See in-depth description in ClickHouse documentation. 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.
distributed_aggregation_memory_efficient	google.protobuf.BoolValue (memory saving mode is disabled).
distributed_ddl_task_timeout	google.protobuf.Int64Value Timeout for DDL queries, in milliseconds.
skip_unavailable_shards	google.protobuf.BoolValue (silent skipping is disabled).
compile	google.protobuf.BoolValue (compilation is disabled).
min_count_to_compile	google.protobuf.Int64Value (default: 3). value compilation is synchronous: a query waits for compilation process to complete prior to continuing execution. The minimum value is 0.
compile_expressions	google.protobuf.BoolValue (expression compilation is disabled).
min_count_to_compile_expression	google.protobuf.Int64Value (default: 3). value compilation is synchronous: a query waits for expression compilation process to complete prior to continuing execution. The minimum value is 0.
max_block_size	google.protobuf.Int64Value (default: 65536). Value must be greater than 0.
min_insert_block_size_rows	google.protobuf.Int64Value query. The minimum value is 0.
min_insert_block_size_bytes	google.protobuf.Int64Value query. The minimum value is 0.
max_insert_block_size	google.protobuf.Int64Value (default: 1048576). Value must be greater than 0.
min_bytes_to_use_direct_io	google.protobuf.Int64Value Limits the minimum number of bytes to enable unbuffered direct reads from disk (Direct I/O). 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. The minimum value is 0.
use_uncompressed_cache	google.protobuf.BoolValue (uncompressed cache is disabled).
merge_tree_max_rows_to_use_cache	google.protobuf.Int64Value (default: 128x8192). Value must be greater than 0.
merge_tree_max_bytes_to_use_cache	google.protobuf.Int64Value (default: 192x10x1024x1024). Value must be greater than 0.
merge_tree_min_rows_for_concurrent_read	google.protobuf.Int64Value (default: 20x8192). Value must be greater than 0.
merge_tree_min_bytes_for_concurrent_read	google.protobuf.Int64Value (default: 24x10x1024x1024). Value must be greater than 0.
max_bytes_before_external_group_by	google.protobuf.Int64Value operation, should be flushed to disk to limit the RAM comsumption. in the external memory is disabled.
max_bytes_before_external_sort	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.
group_by_two_level_threshold	google.protobuf.Int64Value Sets the threshold of the number of keys, after that the two-level aggregation should be used. Minimal value: 0, threshold is not set (default: 10000‬‬).
group_by_two_level_threshold_bytes	google.protobuf.Int64Value Sets the threshold of the number of bytes, after that the two-level aggregation should be used. Minimal value: 0, threshold is not set (default: 100000000‬‬).
priority	google.protobuf.Int64Value 0—priority is not used. 1—the highest priority. and so on. The higher the number, the lower a query's priority. The minimum value is 0.
max_threads	google.protobuf.Int64Value (the thread number is calculated automatically based on the number of physical CPU cores, no HyperThreading cores are taken into account). Value must be greater than 0.
max_memory_usage	google.protobuf.Int64Value (10 GB). The minimum value is 0.
max_memory_usage_for_user	google.protobuf.Int64Value Limits the maximum memory usage (in bytes) for processing of user's queries on a single server. 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. The minimum value is 0.
max_network_bandwidth	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.
max_network_bandwidth_for_user	google.protobuf.Int64Value The maximum speed of data exchange over the network in bytes per second for all concurrently running user queries. Minimal value and default value: 0, no limitation is set.
force_index_by_date	google.protobuf.BoolValue (setting is disabled, query executes even if ClickHouse can't use index by date).
force_primary_key	google.protobuf.BoolValue (setting is disabled, query executes even if ClickHouse can't use index by primary key).
max_rows_to_read	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. The minimum value is 0.
max_bytes_to_read	google.protobuf.Int64Value Limits the maximum number of bytes (uncompressed data) that can be read from a table when running a query. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
read_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_to_group_by	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. The minimum value is 0.
group_by_overflow_mode	enum GroupByOverflowMode 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.
max_rows_to_sort	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. The minimum value is 0.
max_bytes_to_sort	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. The minimum value is 0.
sort_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_result_rows	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. The minimum value is 0.
max_result_bytes	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. The minimum value is 0.
result_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_in_distinct	google.protobuf.Int64Value Limits the maximum number of different rows when using DISTINCT. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
max_bytes_in_distinct	google.protobuf.Int64Value Limits the maximum size of a hash table in bytes (uncompressed data) when using DISTINCT. The minimum value is 0.
distinct_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_to_transfer	google.protobuf.Int64Value Limits the maximum number of rows that can be passed to a remote server or saved in a temporary table when using GLOBAL IN. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
max_bytes_to_transfer	google.protobuf.Int64Value Limits the maximum number of bytes (uncompressed data) that can be passed to a remote server or saved in a temporary table when using GLOBAL IN. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
transfer_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_execution_time	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. The minimum value is 0.
timeout_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_in_set	google.protobuf.Int64Value Limit on the number of rows in the set resulting from the execution of the IN section. The minimum value is 0.
max_bytes_in_set	google.protobuf.Int64Value Limit on the number of bytes in the set resulting from the execution of the IN section. The minimum value is 0.
set_overflow_mode	enum OverflowMode Determine the behavior on exceeding max_rows_in_set or max_bytes_in_set limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK.
max_rows_in_join	google.protobuf.Int64Value Limit on maximum size of the hash table for JOIN, in rows. The minimum value is 0.
max_bytes_in_join	google.protobuf.Int64Value Limit on maximum size of the hash table for JOIN, in bytes. The minimum value is 0.
join_overflow_mode	enum OverflowMode Determine the behavior on exceeding max_rows_in_join or max_bytes_in_join limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK.
max_columns_to_read	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. The minimum value is 0.
max_temporary_columns	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. The minimum value is 0.
max_temporary_non_const_columns	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. The minimum value is 0.
max_query_size	google.protobuf.Int64Value (default: 262144). Value must be greater than 0.
max_ast_depth	google.protobuf.Int64Value query may result in more complex and deeper syntax tree, compared to the SELECT ... WHERE ... query, containing constraints and conditions, in the most cases. (default: 1000). Value must be greater than 0.
max_ast_elements	google.protobuf.Int64Value (default: 50000). Value must be greater than 0.
max_expanded_ast_elements	google.protobuf.Int64Value (default: 500000). Value must be greater than 0.
min_execution_speed	google.protobuf.Int64Value Minimal execution speed in rows per second. The minimum value is 0.
min_execution_speed_bytes	google.protobuf.Int64Value Minimal execution speed in bytes per second. The minimum value is 0.
count_distinct_implementation	enum CountDistinctImplementation Aggregate function to use for implementation of count(DISTINCT ...).
input_format_values_interpret_expressions	google.protobuf.BoolValue expression; therefore an INSERT query for this value will fail and no data will be inserted into a table. expression will be parsed as SQL function, interpreted, and the current date and time will be inserted into the table as a result. (SQL parser is enabled).
input_format_defaults_for_omitted_fields	google.protobuf.BoolValue queries. (replacing is enabled).
output_format_json_quote_64bit_integers	google.protobuf.BoolValue and Int64) will be quoted when written to JSON output in order to maintain compatibility with the most of the JavaScript engines. (quoting 64-bit integers is disabled).
output_format_json_quote_denormals	google.protobuf.BoolValue and -inf) in JSON output format. (special values do not present in output).
low_cardinality_allow_in_native_format	google.protobuf.BoolValue 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 are used in Native format).
empty_result_for_aggregation_by_empty_set	google.protobuf.BoolValue 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.
joined_subquery_requires_alias	google.protobuf.BoolValue
join_use_nulls	google.protobuf.BoolValue
transform_null_in	google.protobuf.BoolValue
http_connection_timeout	google.protobuf.Int64Value (default: 1000, 1 second).
http_receive_timeout	google.protobuf.Int64Value (default: 1800000, 1800 seconds, 30 minutes).
http_send_timeout	google.protobuf.Int64Value (default: 1800000, 1800 seconds, 30 minutes).
enable_http_compression	google.protobuf.BoolValue HTTP header in a HTTP request to force compression of HTTP response from ClickHouse. and deflate. (compression is disabled).
send_progress_in_http_headers	google.protobuf.BoolValue HTTP header. (notifications disabled).
http_headers_progress_interval	google.protobuf.Int64Value HTTP header, in milliseconds. (default: 100).
add_http_cors_header	google.protobuf.BoolValue (header is not added).
quota_mode	enum QuotaMode Quota accounting mode. Possible values: QUOTA_MODE_DEFAULT, QUOTA_MODE_KEYED and QUOTA_MODE_KEYED_BY_IP.

UserQuota

Field	Description
interval_duration	google.protobuf.Int64Value Duration of interval for quota in milliseconds. Minimal value is 1 second. The minimum value is 1000.
queries	google.protobuf.Int64Value The total number of queries. 0 - unlimited. The minimum value is 0.
errors	google.protobuf.Int64Value The number of queries that threw exception. 0 - unlimited. The minimum value is 0.
result_rows	google.protobuf.Int64Value The total number of rows given as the result.. 0 - unlimited. The minimum value is 0.
read_rows	google.protobuf.Int64Value The total number of source rows read from tables for running the query, on all remote servers. 0 - unlimited. The minimum value is 0.
execution_time	google.protobuf.Int64Value The total query execution time, in milliseconds (wall time). 0 - unlimited. The minimum value is 0.

Update

Updates the specified ClickHouse user.

rpc Update (UpdateUserRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:UpdateUserMetadata

    Operation.response:User

UpdateUserRequest

Field	Description
cluster_id	string Required. ID of the ClickHouse cluster the user belongs to. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
user_name	string Required. Name of the user to be updated. To get the name of the user, use a UserService.List request. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_]*.
update_mask	google.protobuf.FieldMask Field mask that specifies which attributes of the ClickHouse user should be updated.
password	string New password for the user. The string length in characters must be 8-128.
permissions[]	Permission New set of permissions for the user.
settings	UserSettings
quotas[]	UserQuota

Permission

Field	Description
database_name	string Name of the database that the permission grants access to.

UserSettings

Field	Description
readonly	google.protobuf.Int64Value 0 (default)—no restrictions. 1—only read data queries are allowed. 2—read data and change settings queries are allowed. Acceptable values are 0 to 2, inclusive.
allow_ddl	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.
insert_quorum	google.protobuf.Int64Value replicas with no errors until the insert_quorum_timeout expires. queries. The minimum value is 0.
connect_timeout	google.protobuf.Int64Value (default: 10000, 10 seconds). Value must be greater than 0.
receive_timeout	google.protobuf.Int64Value (default: 300000, 300 seconds or 5 minutes). Value must be greater than 0.
send_timeout	google.protobuf.Int64Value (default: 300000, 300 seconds or 5 minutes). Value must be greater than 0.
insert_quorum_timeout	google.protobuf.Int64Value query and return an error. The minimum value is 1000.
select_sequential_consistency	google.protobuf.BoolValue 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. (sequential consistency is disabled).
max_replica_delay_for_distributed_queries	google.protobuf.Int64Value Max replica delay in milliseconds. If a replica lags more than the set value, this replica is not used and becomes a stale one. Minimum value: 1000, 1 second (default: 300000, 300 seconds or 5 minutes). See in-depth description in ClickHouse documentation. The minimum value is 1000.
fallback_to_stale_replicas_for_distributed_queries	google.protobuf.BoolValue query from a distributed table that points to replicated tables. (query forcing is enabled).
replication_alter_partitions_sync	google.protobuf.Int64Value queries on replicated tables: 0—do not wait for replicas. 1—only wait for own execution (default). 2—wait for all replicas. Acceptable values are 0 to 2, inclusive.
distributed_product_mode	enum DistributedProductMode Determine the behavior of distributed subqueries. See in-depth description in ClickHouse documentation. 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.
distributed_aggregation_memory_efficient	google.protobuf.BoolValue (memory saving mode is disabled).
distributed_ddl_task_timeout	google.protobuf.Int64Value Timeout for DDL queries, in milliseconds.
skip_unavailable_shards	google.protobuf.BoolValue (silent skipping is disabled).
compile	google.protobuf.BoolValue (compilation is disabled).
min_count_to_compile	google.protobuf.Int64Value (default: 3). value compilation is synchronous: a query waits for compilation process to complete prior to continuing execution. The minimum value is 0.
compile_expressions	google.protobuf.BoolValue (expression compilation is disabled).
min_count_to_compile_expression	google.protobuf.Int64Value (default: 3). value compilation is synchronous: a query waits for expression compilation process to complete prior to continuing execution. The minimum value is 0.
max_block_size	google.protobuf.Int64Value (default: 65536). Value must be greater than 0.
min_insert_block_size_rows	google.protobuf.Int64Value query. The minimum value is 0.
min_insert_block_size_bytes	google.protobuf.Int64Value query. The minimum value is 0.
max_insert_block_size	google.protobuf.Int64Value (default: 1048576). Value must be greater than 0.
min_bytes_to_use_direct_io	google.protobuf.Int64Value Limits the minimum number of bytes to enable unbuffered direct reads from disk (Direct I/O). 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. The minimum value is 0.
use_uncompressed_cache	google.protobuf.BoolValue (uncompressed cache is disabled).
merge_tree_max_rows_to_use_cache	google.protobuf.Int64Value (default: 128x8192). Value must be greater than 0.
merge_tree_max_bytes_to_use_cache	google.protobuf.Int64Value (default: 192x10x1024x1024). Value must be greater than 0.
merge_tree_min_rows_for_concurrent_read	google.protobuf.Int64Value (default: 20x8192). Value must be greater than 0.
merge_tree_min_bytes_for_concurrent_read	google.protobuf.Int64Value (default: 24x10x1024x1024). Value must be greater than 0.
max_bytes_before_external_group_by	google.protobuf.Int64Value operation, should be flushed to disk to limit the RAM comsumption. in the external memory is disabled.
max_bytes_before_external_sort	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.
group_by_two_level_threshold	google.protobuf.Int64Value Sets the threshold of the number of keys, after that the two-level aggregation should be used. Minimal value: 0, threshold is not set (default: 10000‬‬).
group_by_two_level_threshold_bytes	google.protobuf.Int64Value Sets the threshold of the number of bytes, after that the two-level aggregation should be used. Minimal value: 0, threshold is not set (default: 100000000‬‬).
priority	google.protobuf.Int64Value 0—priority is not used. 1—the highest priority. and so on. The higher the number, the lower a query's priority. The minimum value is 0.
max_threads	google.protobuf.Int64Value (the thread number is calculated automatically based on the number of physical CPU cores, no HyperThreading cores are taken into account). Value must be greater than 0.
max_memory_usage	google.protobuf.Int64Value (10 GB). The minimum value is 0.
max_memory_usage_for_user	google.protobuf.Int64Value Limits the maximum memory usage (in bytes) for processing of user's queries on a single server. 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. The minimum value is 0.
max_network_bandwidth	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.
max_network_bandwidth_for_user	google.protobuf.Int64Value The maximum speed of data exchange over the network in bytes per second for all concurrently running user queries. Minimal value and default value: 0, no limitation is set.
force_index_by_date	google.protobuf.BoolValue (setting is disabled, query executes even if ClickHouse can't use index by date).
force_primary_key	google.protobuf.BoolValue (setting is disabled, query executes even if ClickHouse can't use index by primary key).
max_rows_to_read	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. The minimum value is 0.
max_bytes_to_read	google.protobuf.Int64Value Limits the maximum number of bytes (uncompressed data) that can be read from a table when running a query. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
read_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_to_group_by	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. The minimum value is 0.
group_by_overflow_mode	enum GroupByOverflowMode 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.
max_rows_to_sort	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. The minimum value is 0.
max_bytes_to_sort	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. The minimum value is 0.
sort_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_result_rows	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. The minimum value is 0.
max_result_bytes	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. The minimum value is 0.
result_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_in_distinct	google.protobuf.Int64Value Limits the maximum number of different rows when using DISTINCT. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
max_bytes_in_distinct	google.protobuf.Int64Value Limits the maximum size of a hash table in bytes (uncompressed data) when using DISTINCT. The minimum value is 0.
distinct_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_to_transfer	google.protobuf.Int64Value Limits the maximum number of rows that can be passed to a remote server or saved in a temporary table when using GLOBAL IN. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
max_bytes_to_transfer	google.protobuf.Int64Value Limits the maximum number of bytes (uncompressed data) that can be passed to a remote server or saved in a temporary table when using GLOBAL IN. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
transfer_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_execution_time	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. The minimum value is 0.
timeout_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_in_set	google.protobuf.Int64Value Limit on the number of rows in the set resulting from the execution of the IN section. The minimum value is 0.
max_bytes_in_set	google.protobuf.Int64Value Limit on the number of bytes in the set resulting from the execution of the IN section. The minimum value is 0.
set_overflow_mode	enum OverflowMode Determine the behavior on exceeding max_rows_in_set or max_bytes_in_set limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK.
max_rows_in_join	google.protobuf.Int64Value Limit on maximum size of the hash table for JOIN, in rows. The minimum value is 0.
max_bytes_in_join	google.protobuf.Int64Value Limit on maximum size of the hash table for JOIN, in bytes. The minimum value is 0.
join_overflow_mode	enum OverflowMode Determine the behavior on exceeding max_rows_in_join or max_bytes_in_join limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK.
max_columns_to_read	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. The minimum value is 0.
max_temporary_columns	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. The minimum value is 0.
max_temporary_non_const_columns	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. The minimum value is 0.
max_query_size	google.protobuf.Int64Value (default: 262144). Value must be greater than 0.
max_ast_depth	google.protobuf.Int64Value query may result in more complex and deeper syntax tree, compared to the SELECT ... WHERE ... query, containing constraints and conditions, in the most cases. (default: 1000). Value must be greater than 0.
max_ast_elements	google.protobuf.Int64Value (default: 50000). Value must be greater than 0.
max_expanded_ast_elements	google.protobuf.Int64Value (default: 500000). Value must be greater than 0.
min_execution_speed	google.protobuf.Int64Value Minimal execution speed in rows per second. The minimum value is 0.
min_execution_speed_bytes	google.protobuf.Int64Value Minimal execution speed in bytes per second. The minimum value is 0.
count_distinct_implementation	enum CountDistinctImplementation Aggregate function to use for implementation of count(DISTINCT ...).
input_format_values_interpret_expressions	google.protobuf.BoolValue expression; therefore an INSERT query for this value will fail and no data will be inserted into a table. expression will be parsed as SQL function, interpreted, and the current date and time will be inserted into the table as a result. (SQL parser is enabled).
input_format_defaults_for_omitted_fields	google.protobuf.BoolValue queries. (replacing is enabled).
output_format_json_quote_64bit_integers	google.protobuf.BoolValue and Int64) will be quoted when written to JSON output in order to maintain compatibility with the most of the JavaScript engines. (quoting 64-bit integers is disabled).
output_format_json_quote_denormals	google.protobuf.BoolValue and -inf) in JSON output format. (special values do not present in output).
low_cardinality_allow_in_native_format	google.protobuf.BoolValue 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 are used in Native format).
empty_result_for_aggregation_by_empty_set	google.protobuf.BoolValue 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.
joined_subquery_requires_alias	google.protobuf.BoolValue
join_use_nulls	google.protobuf.BoolValue
transform_null_in	google.protobuf.BoolValue
http_connection_timeout	google.protobuf.Int64Value (default: 1000, 1 second).
http_receive_timeout	google.protobuf.Int64Value (default: 1800000, 1800 seconds, 30 minutes).
http_send_timeout	google.protobuf.Int64Value (default: 1800000, 1800 seconds, 30 minutes).
enable_http_compression	google.protobuf.BoolValue HTTP header in a HTTP request to force compression of HTTP response from ClickHouse. and deflate. (compression is disabled).
send_progress_in_http_headers	google.protobuf.BoolValue HTTP header. (notifications disabled).
http_headers_progress_interval	google.protobuf.Int64Value HTTP header, in milliseconds. (default: 100).
add_http_cors_header	google.protobuf.BoolValue (header is not added).
quota_mode	enum QuotaMode Quota accounting mode. Possible values: QUOTA_MODE_DEFAULT, QUOTA_MODE_KEYED and QUOTA_MODE_KEYED_BY_IP.

UserQuota

Field	Description
interval_duration	google.protobuf.Int64Value Duration of interval for quota in milliseconds. Minimal value is 1 second. The minimum value is 1000.
queries	google.protobuf.Int64Value The total number of queries. 0 - unlimited. The minimum value is 0.
errors	google.protobuf.Int64Value The number of queries that threw exception. 0 - unlimited. The minimum value is 0.
result_rows	google.protobuf.Int64Value The total number of rows given as the result.. 0 - unlimited. The minimum value is 0.
read_rows	google.protobuf.Int64Value The total number of source rows read from tables for running the query, on all remote servers. 0 - unlimited. The minimum value is 0.
execution_time	google.protobuf.Int64Value The total query execution time, in milliseconds (wall time). 0 - unlimited. The minimum value is 0.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<UpdateUserMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<User> if operation finished successfully.

UpdateUserMetadata

Field	Description
cluster_id	string ID of the ClickHouse cluster the user belongs to.
user_name	string Name of the user that is being updated.

User

Field	Description
name	string Name of the ClickHouse user.
cluster_id	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.

Permission

Field	Description
database_name	string Name of the database that the permission grants access to.

UserSettings

Field	Description
readonly	google.protobuf.Int64Value 0 (default)—no restrictions. 1—only read data queries are allowed. 2—read data and change settings queries are allowed. Acceptable values are 0 to 2, inclusive.
allow_ddl	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.
insert_quorum	google.protobuf.Int64Value replicas with no errors until the insert_quorum_timeout expires. queries. The minimum value is 0.
connect_timeout	google.protobuf.Int64Value (default: 10000, 10 seconds). Value must be greater than 0.
receive_timeout	google.protobuf.Int64Value (default: 300000, 300 seconds or 5 minutes). Value must be greater than 0.
send_timeout	google.protobuf.Int64Value (default: 300000, 300 seconds or 5 minutes). Value must be greater than 0.
insert_quorum_timeout	google.protobuf.Int64Value query and return an error. The minimum value is 1000.
select_sequential_consistency	google.protobuf.BoolValue 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. (sequential consistency is disabled).
max_replica_delay_for_distributed_queries	google.protobuf.Int64Value Max replica delay in milliseconds. If a replica lags more than the set value, this replica is not used and becomes a stale one. Minimum value: 1000, 1 second (default: 300000, 300 seconds or 5 minutes). See in-depth description in ClickHouse documentation. The minimum value is 1000.
fallback_to_stale_replicas_for_distributed_queries	google.protobuf.BoolValue query from a distributed table that points to replicated tables. (query forcing is enabled).
replication_alter_partitions_sync	google.protobuf.Int64Value queries on replicated tables: 0—do not wait for replicas. 1—only wait for own execution (default). 2—wait for all replicas. Acceptable values are 0 to 2, inclusive.
distributed_product_mode	enum DistributedProductMode Determine the behavior of distributed subqueries. See in-depth description in ClickHouse documentation. 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.
distributed_aggregation_memory_efficient	google.protobuf.BoolValue (memory saving mode is disabled).
distributed_ddl_task_timeout	google.protobuf.Int64Value Timeout for DDL queries, in milliseconds.
skip_unavailable_shards	google.protobuf.BoolValue (silent skipping is disabled).
compile	google.protobuf.BoolValue (compilation is disabled).
min_count_to_compile	google.protobuf.Int64Value (default: 3). value compilation is synchronous: a query waits for compilation process to complete prior to continuing execution. The minimum value is 0.
compile_expressions	google.protobuf.BoolValue (expression compilation is disabled).
min_count_to_compile_expression	google.protobuf.Int64Value (default: 3). value compilation is synchronous: a query waits for expression compilation process to complete prior to continuing execution. The minimum value is 0.
max_block_size	google.protobuf.Int64Value (default: 65536). Value must be greater than 0.
min_insert_block_size_rows	google.protobuf.Int64Value query. The minimum value is 0.
min_insert_block_size_bytes	google.protobuf.Int64Value query. The minimum value is 0.
max_insert_block_size	google.protobuf.Int64Value (default: 1048576). Value must be greater than 0.
min_bytes_to_use_direct_io	google.protobuf.Int64Value Limits the minimum number of bytes to enable unbuffered direct reads from disk (Direct I/O). 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. The minimum value is 0.
use_uncompressed_cache	google.protobuf.BoolValue (uncompressed cache is disabled).
merge_tree_max_rows_to_use_cache	google.protobuf.Int64Value (default: 128x8192). Value must be greater than 0.
merge_tree_max_bytes_to_use_cache	google.protobuf.Int64Value (default: 192x10x1024x1024). Value must be greater than 0.
merge_tree_min_rows_for_concurrent_read	google.protobuf.Int64Value (default: 20x8192). Value must be greater than 0.
merge_tree_min_bytes_for_concurrent_read	google.protobuf.Int64Value (default: 24x10x1024x1024). Value must be greater than 0.
max_bytes_before_external_group_by	google.protobuf.Int64Value operation, should be flushed to disk to limit the RAM comsumption. in the external memory is disabled.
max_bytes_before_external_sort	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.
group_by_two_level_threshold	google.protobuf.Int64Value Sets the threshold of the number of keys, after that the two-level aggregation should be used. Minimal value: 0, threshold is not set (default: 10000‬‬).
group_by_two_level_threshold_bytes	google.protobuf.Int64Value Sets the threshold of the number of bytes, after that the two-level aggregation should be used. Minimal value: 0, threshold is not set (default: 100000000‬‬).
priority	google.protobuf.Int64Value 0—priority is not used. 1—the highest priority. and so on. The higher the number, the lower a query's priority. The minimum value is 0.
max_threads	google.protobuf.Int64Value (the thread number is calculated automatically based on the number of physical CPU cores, no HyperThreading cores are taken into account). Value must be greater than 0.
max_memory_usage	google.protobuf.Int64Value (10 GB). The minimum value is 0.
max_memory_usage_for_user	google.protobuf.Int64Value Limits the maximum memory usage (in bytes) for processing of user's queries on a single server. 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. The minimum value is 0.
max_network_bandwidth	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.
max_network_bandwidth_for_user	google.protobuf.Int64Value The maximum speed of data exchange over the network in bytes per second for all concurrently running user queries. Minimal value and default value: 0, no limitation is set.
force_index_by_date	google.protobuf.BoolValue (setting is disabled, query executes even if ClickHouse can't use index by date).
force_primary_key	google.protobuf.BoolValue (setting is disabled, query executes even if ClickHouse can't use index by primary key).
max_rows_to_read	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. The minimum value is 0.
max_bytes_to_read	google.protobuf.Int64Value Limits the maximum number of bytes (uncompressed data) that can be read from a table when running a query. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
read_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_to_group_by	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. The minimum value is 0.
group_by_overflow_mode	enum GroupByOverflowMode 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.
max_rows_to_sort	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. The minimum value is 0.
max_bytes_to_sort	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. The minimum value is 0.
sort_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_result_rows	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. The minimum value is 0.
max_result_bytes	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. The minimum value is 0.
result_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_in_distinct	google.protobuf.Int64Value Limits the maximum number of different rows when using DISTINCT. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
max_bytes_in_distinct	google.protobuf.Int64Value Limits the maximum size of a hash table in bytes (uncompressed data) when using DISTINCT. The minimum value is 0.
distinct_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_to_transfer	google.protobuf.Int64Value Limits the maximum number of rows that can be passed to a remote server or saved in a temporary table when using GLOBAL IN. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
max_bytes_to_transfer	google.protobuf.Int64Value Limits the maximum number of bytes (uncompressed data) that can be passed to a remote server or saved in a temporary table when using GLOBAL IN. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
transfer_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_execution_time	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. The minimum value is 0.
timeout_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_in_set	google.protobuf.Int64Value Limit on the number of rows in the set resulting from the execution of the IN section. The minimum value is 0.
max_bytes_in_set	google.protobuf.Int64Value Limit on the number of bytes in the set resulting from the execution of the IN section. The minimum value is 0.
set_overflow_mode	enum OverflowMode Determine the behavior on exceeding max_rows_in_set or max_bytes_in_set limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK.
max_rows_in_join	google.protobuf.Int64Value Limit on maximum size of the hash table for JOIN, in rows. The minimum value is 0.
max_bytes_in_join	google.protobuf.Int64Value Limit on maximum size of the hash table for JOIN, in bytes. The minimum value is 0.
join_overflow_mode	enum OverflowMode Determine the behavior on exceeding max_rows_in_join or max_bytes_in_join limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK.
max_columns_to_read	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. The minimum value is 0.
max_temporary_columns	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. The minimum value is 0.
max_temporary_non_const_columns	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. The minimum value is 0.
max_query_size	google.protobuf.Int64Value (default: 262144). Value must be greater than 0.
max_ast_depth	google.protobuf.Int64Value query may result in more complex and deeper syntax tree, compared to the SELECT ... WHERE ... query, containing constraints and conditions, in the most cases. (default: 1000). Value must be greater than 0.
max_ast_elements	google.protobuf.Int64Value (default: 50000). Value must be greater than 0.
max_expanded_ast_elements	google.protobuf.Int64Value (default: 500000). Value must be greater than 0.
min_execution_speed	google.protobuf.Int64Value Minimal execution speed in rows per second. The minimum value is 0.
min_execution_speed_bytes	google.protobuf.Int64Value Minimal execution speed in bytes per second. The minimum value is 0.
count_distinct_implementation	enum CountDistinctImplementation Aggregate function to use for implementation of count(DISTINCT ...).
input_format_values_interpret_expressions	google.protobuf.BoolValue expression; therefore an INSERT query for this value will fail and no data will be inserted into a table. expression will be parsed as SQL function, interpreted, and the current date and time will be inserted into the table as a result. (SQL parser is enabled).
input_format_defaults_for_omitted_fields	google.protobuf.BoolValue queries. (replacing is enabled).
output_format_json_quote_64bit_integers	google.protobuf.BoolValue and Int64) will be quoted when written to JSON output in order to maintain compatibility with the most of the JavaScript engines. (quoting 64-bit integers is disabled).
output_format_json_quote_denormals	google.protobuf.BoolValue and -inf) in JSON output format. (special values do not present in output).
low_cardinality_allow_in_native_format	google.protobuf.BoolValue 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 are used in Native format).
empty_result_for_aggregation_by_empty_set	google.protobuf.BoolValue 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.
joined_subquery_requires_alias	google.protobuf.BoolValue
join_use_nulls	google.protobuf.BoolValue
transform_null_in	google.protobuf.BoolValue
http_connection_timeout	google.protobuf.Int64Value (default: 1000, 1 second).
http_receive_timeout	google.protobuf.Int64Value (default: 1800000, 1800 seconds, 30 minutes).
http_send_timeout	google.protobuf.Int64Value (default: 1800000, 1800 seconds, 30 minutes).
enable_http_compression	google.protobuf.BoolValue HTTP header in a HTTP request to force compression of HTTP response from ClickHouse. and deflate. (compression is disabled).
send_progress_in_http_headers	google.protobuf.BoolValue HTTP header. (notifications disabled).
http_headers_progress_interval	google.protobuf.Int64Value HTTP header, in milliseconds. (default: 100).
add_http_cors_header	google.protobuf.BoolValue (header is not added).
quota_mode	enum QuotaMode Quota accounting mode. Possible values: QUOTA_MODE_DEFAULT, QUOTA_MODE_KEYED and QUOTA_MODE_KEYED_BY_IP.

UserQuota

Field	Description
interval_duration	google.protobuf.Int64Value Duration of interval for quota in milliseconds. Minimal value is 1 second. The minimum value is 1000.
queries	google.protobuf.Int64Value The total number of queries. 0 - unlimited. The minimum value is 0.
errors	google.protobuf.Int64Value The number of queries that threw exception. 0 - unlimited. The minimum value is 0.
result_rows	google.protobuf.Int64Value The total number of rows given as the result.. 0 - unlimited. The minimum value is 0.
read_rows	google.protobuf.Int64Value The total number of source rows read from tables for running the query, on all remote servers. 0 - unlimited. The minimum value is 0.
execution_time	google.protobuf.Int64Value The total query execution time, in milliseconds (wall time). 0 - unlimited. The minimum value is 0.

Delete

Deletes the specified ClickHouse user.

rpc Delete (DeleteUserRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:DeleteUserMetadata

    Operation.response:google.protobuf.Empty

DeleteUserRequest

Field	Description
cluster_id	string Required. ID of the ClickHouse cluster the user belongs to. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
user_name	string Required. Name of the user to delete. To get the name of the user, use a UserService.List request. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_]*.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<DeleteUserMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<google.protobuf.Empty> if operation finished successfully.

DeleteUserMetadata

Field	Description
cluster_id	string ID of the ClickHouse cluster the user belongs to.
user_name	string Name of the user that is being deleted.

GrantPermission

Grants a permission to the specified ClickHouse user.

rpc GrantPermission (GrantUserPermissionRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:GrantUserPermissionMetadata

    Operation.response:User

GrantUserPermissionRequest

Field	Description
cluster_id	string Required. ID of the ClickHouse cluster the user belongs to. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
user_name	string Required. Name of the user to grant the permission to. To get the name of the user, use a UserService.List request. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_]*.
permission	Permission Permission that should be granted to the specified user.

Permission

Field	Description
database_name	string Name of the database that the permission grants access to.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<GrantUserPermissionMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<User> if operation finished successfully.

GrantUserPermissionMetadata

Field	Description
cluster_id	string ID of the ClickHouse cluster the user belongs to.
user_name	string Name of the user that is being granted a permission.

User

Field	Description
name	string Name of the ClickHouse user.
cluster_id	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.

Permission

Field	Description
database_name	string Name of the database that the permission grants access to.

UserSettings

Field	Description
readonly	google.protobuf.Int64Value 0 (default)—no restrictions. 1—only read data queries are allowed. 2—read data and change settings queries are allowed. Acceptable values are 0 to 2, inclusive.
allow_ddl	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.
insert_quorum	google.protobuf.Int64Value replicas with no errors until the insert_quorum_timeout expires. queries. The minimum value is 0.
connect_timeout	google.protobuf.Int64Value (default: 10000, 10 seconds). Value must be greater than 0.
receive_timeout	google.protobuf.Int64Value (default: 300000, 300 seconds or 5 minutes). Value must be greater than 0.
send_timeout	google.protobuf.Int64Value (default: 300000, 300 seconds or 5 minutes). Value must be greater than 0.
insert_quorum_timeout	google.protobuf.Int64Value query and return an error. The minimum value is 1000.
select_sequential_consistency	google.protobuf.BoolValue 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. (sequential consistency is disabled).
max_replica_delay_for_distributed_queries	google.protobuf.Int64Value Max replica delay in milliseconds. If a replica lags more than the set value, this replica is not used and becomes a stale one. Minimum value: 1000, 1 second (default: 300000, 300 seconds or 5 minutes). See in-depth description in ClickHouse documentation. The minimum value is 1000.
fallback_to_stale_replicas_for_distributed_queries	google.protobuf.BoolValue query from a distributed table that points to replicated tables. (query forcing is enabled).
replication_alter_partitions_sync	google.protobuf.Int64Value queries on replicated tables: 0—do not wait for replicas. 1—only wait for own execution (default). 2—wait for all replicas. Acceptable values are 0 to 2, inclusive.
distributed_product_mode	enum DistributedProductMode Determine the behavior of distributed subqueries. See in-depth description in ClickHouse documentation. 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.
distributed_aggregation_memory_efficient	google.protobuf.BoolValue (memory saving mode is disabled).
distributed_ddl_task_timeout	google.protobuf.Int64Value Timeout for DDL queries, in milliseconds.
skip_unavailable_shards	google.protobuf.BoolValue (silent skipping is disabled).
compile	google.protobuf.BoolValue (compilation is disabled).
min_count_to_compile	google.protobuf.Int64Value (default: 3). value compilation is synchronous: a query waits for compilation process to complete prior to continuing execution. The minimum value is 0.
compile_expressions	google.protobuf.BoolValue (expression compilation is disabled).
min_count_to_compile_expression	google.protobuf.Int64Value (default: 3). value compilation is synchronous: a query waits for expression compilation process to complete prior to continuing execution. The minimum value is 0.
max_block_size	google.protobuf.Int64Value (default: 65536). Value must be greater than 0.
min_insert_block_size_rows	google.protobuf.Int64Value query. The minimum value is 0.
min_insert_block_size_bytes	google.protobuf.Int64Value query. The minimum value is 0.
max_insert_block_size	google.protobuf.Int64Value (default: 1048576). Value must be greater than 0.
min_bytes_to_use_direct_io	google.protobuf.Int64Value Limits the minimum number of bytes to enable unbuffered direct reads from disk (Direct I/O). 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. The minimum value is 0.
use_uncompressed_cache	google.protobuf.BoolValue (uncompressed cache is disabled).
merge_tree_max_rows_to_use_cache	google.protobuf.Int64Value (default: 128x8192). Value must be greater than 0.
merge_tree_max_bytes_to_use_cache	google.protobuf.Int64Value (default: 192x10x1024x1024). Value must be greater than 0.
merge_tree_min_rows_for_concurrent_read	google.protobuf.Int64Value (default: 20x8192). Value must be greater than 0.
merge_tree_min_bytes_for_concurrent_read	google.protobuf.Int64Value (default: 24x10x1024x1024). Value must be greater than 0.
max_bytes_before_external_group_by	google.protobuf.Int64Value operation, should be flushed to disk to limit the RAM comsumption. in the external memory is disabled.
max_bytes_before_external_sort	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.
group_by_two_level_threshold	google.protobuf.Int64Value Sets the threshold of the number of keys, after that the two-level aggregation should be used. Minimal value: 0, threshold is not set (default: 10000‬‬).
group_by_two_level_threshold_bytes	google.protobuf.Int64Value Sets the threshold of the number of bytes, after that the two-level aggregation should be used. Minimal value: 0, threshold is not set (default: 100000000‬‬).
priority	google.protobuf.Int64Value 0—priority is not used. 1—the highest priority. and so on. The higher the number, the lower a query's priority. The minimum value is 0.
max_threads	google.protobuf.Int64Value (the thread number is calculated automatically based on the number of physical CPU cores, no HyperThreading cores are taken into account). Value must be greater than 0.
max_memory_usage	google.protobuf.Int64Value (10 GB). The minimum value is 0.
max_memory_usage_for_user	google.protobuf.Int64Value Limits the maximum memory usage (in bytes) for processing of user's queries on a single server. 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. The minimum value is 0.
max_network_bandwidth	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.
max_network_bandwidth_for_user	google.protobuf.Int64Value The maximum speed of data exchange over the network in bytes per second for all concurrently running user queries. Minimal value and default value: 0, no limitation is set.
force_index_by_date	google.protobuf.BoolValue (setting is disabled, query executes even if ClickHouse can't use index by date).
force_primary_key	google.protobuf.BoolValue (setting is disabled, query executes even if ClickHouse can't use index by primary key).
max_rows_to_read	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. The minimum value is 0.
max_bytes_to_read	google.protobuf.Int64Value Limits the maximum number of bytes (uncompressed data) that can be read from a table when running a query. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
read_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_to_group_by	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. The minimum value is 0.
group_by_overflow_mode	enum GroupByOverflowMode 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.
max_rows_to_sort	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. The minimum value is 0.
max_bytes_to_sort	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. The minimum value is 0.
sort_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_result_rows	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. The minimum value is 0.
max_result_bytes	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. The minimum value is 0.
result_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_in_distinct	google.protobuf.Int64Value Limits the maximum number of different rows when using DISTINCT. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
max_bytes_in_distinct	google.protobuf.Int64Value Limits the maximum size of a hash table in bytes (uncompressed data) when using DISTINCT. The minimum value is 0.
distinct_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_to_transfer	google.protobuf.Int64Value Limits the maximum number of rows that can be passed to a remote server or saved in a temporary table when using GLOBAL IN. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
max_bytes_to_transfer	google.protobuf.Int64Value Limits the maximum number of bytes (uncompressed data) that can be passed to a remote server or saved in a temporary table when using GLOBAL IN. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
transfer_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_execution_time	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. The minimum value is 0.
timeout_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_in_set	google.protobuf.Int64Value Limit on the number of rows in the set resulting from the execution of the IN section. The minimum value is 0.
max_bytes_in_set	google.protobuf.Int64Value Limit on the number of bytes in the set resulting from the execution of the IN section. The minimum value is 0.
set_overflow_mode	enum OverflowMode Determine the behavior on exceeding max_rows_in_set or max_bytes_in_set limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK.
max_rows_in_join	google.protobuf.Int64Value Limit on maximum size of the hash table for JOIN, in rows. The minimum value is 0.
max_bytes_in_join	google.protobuf.Int64Value Limit on maximum size of the hash table for JOIN, in bytes. The minimum value is 0.
join_overflow_mode	enum OverflowMode Determine the behavior on exceeding max_rows_in_join or max_bytes_in_join limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK.
max_columns_to_read	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. The minimum value is 0.
max_temporary_columns	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. The minimum value is 0.
max_temporary_non_const_columns	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. The minimum value is 0.
max_query_size	google.protobuf.Int64Value (default: 262144). Value must be greater than 0.
max_ast_depth	google.protobuf.Int64Value query may result in more complex and deeper syntax tree, compared to the SELECT ... WHERE ... query, containing constraints and conditions, in the most cases. (default: 1000). Value must be greater than 0.
max_ast_elements	google.protobuf.Int64Value (default: 50000). Value must be greater than 0.
max_expanded_ast_elements	google.protobuf.Int64Value (default: 500000). Value must be greater than 0.
min_execution_speed	google.protobuf.Int64Value Minimal execution speed in rows per second. The minimum value is 0.
min_execution_speed_bytes	google.protobuf.Int64Value Minimal execution speed in bytes per second. The minimum value is 0.
count_distinct_implementation	enum CountDistinctImplementation Aggregate function to use for implementation of count(DISTINCT ...).
input_format_values_interpret_expressions	google.protobuf.BoolValue expression; therefore an INSERT query for this value will fail and no data will be inserted into a table. expression will be parsed as SQL function, interpreted, and the current date and time will be inserted into the table as a result. (SQL parser is enabled).
input_format_defaults_for_omitted_fields	google.protobuf.BoolValue queries. (replacing is enabled).
output_format_json_quote_64bit_integers	google.protobuf.BoolValue and Int64) will be quoted when written to JSON output in order to maintain compatibility with the most of the JavaScript engines. (quoting 64-bit integers is disabled).
output_format_json_quote_denormals	google.protobuf.BoolValue and -inf) in JSON output format. (special values do not present in output).
low_cardinality_allow_in_native_format	google.protobuf.BoolValue 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 are used in Native format).
empty_result_for_aggregation_by_empty_set	google.protobuf.BoolValue 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.
joined_subquery_requires_alias	google.protobuf.BoolValue
join_use_nulls	google.protobuf.BoolValue
transform_null_in	google.protobuf.BoolValue
http_connection_timeout	google.protobuf.Int64Value (default: 1000, 1 second).
http_receive_timeout	google.protobuf.Int64Value (default: 1800000, 1800 seconds, 30 minutes).
http_send_timeout	google.protobuf.Int64Value (default: 1800000, 1800 seconds, 30 minutes).
enable_http_compression	google.protobuf.BoolValue HTTP header in a HTTP request to force compression of HTTP response from ClickHouse. and deflate. (compression is disabled).
send_progress_in_http_headers	google.protobuf.BoolValue HTTP header. (notifications disabled).
http_headers_progress_interval	google.protobuf.Int64Value HTTP header, in milliseconds. (default: 100).
add_http_cors_header	google.protobuf.BoolValue (header is not added).
quota_mode	enum QuotaMode Quota accounting mode. Possible values: QUOTA_MODE_DEFAULT, QUOTA_MODE_KEYED and QUOTA_MODE_KEYED_BY_IP.

UserQuota

Field	Description
interval_duration	google.protobuf.Int64Value Duration of interval for quota in milliseconds. Minimal value is 1 second. The minimum value is 1000.
queries	google.protobuf.Int64Value The total number of queries. 0 - unlimited. The minimum value is 0.
errors	google.protobuf.Int64Value The number of queries that threw exception. 0 - unlimited. The minimum value is 0.
result_rows	google.protobuf.Int64Value The total number of rows given as the result.. 0 - unlimited. The minimum value is 0.
read_rows	google.protobuf.Int64Value The total number of source rows read from tables for running the query, on all remote servers. 0 - unlimited. The minimum value is 0.
execution_time	google.protobuf.Int64Value The total query execution time, in milliseconds (wall time). 0 - unlimited. The minimum value is 0.

RevokePermission

Revokes a permission from the specified ClickHouse user.

rpc RevokePermission (RevokeUserPermissionRequest) returns (operation.Operation)

Metadata and response of Operation:

    Operation.metadata:RevokeUserPermissionMetadata

    Operation.response:User

RevokeUserPermissionRequest

Field	Description
cluster_id	string Required. ID of the ClickHouse cluster the user belongs to. To get the cluster ID, use a ClusterService.List request. The maximum string length in characters is 50.
user_name	string Required. Name of the user to revoke a permission from. To get the name of the user, use a UserService.List request. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_]*.
database_name	string Name of the database that the user should lose access to. The maximum string length in characters is 63. Value must match the regular expression [a-zA-Z0-9_-]*.

Operation

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
metadata	google.protobuf.Any<RevokeUserPermissionMetadata> Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
result	oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.
error	google.rpc.Status The error result of the operation in case of failure or cancellation.
response	google.protobuf.Any<User> if operation finished successfully.

RevokeUserPermissionMetadata

Field	Description
cluster_id	string ID of the ClickHouse cluster the user belongs to.
user_name	string Name of the user whose permission is being revoked.

User

Field	Description
name	string Name of the ClickHouse user.
cluster_id	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.

Permission

Field	Description
database_name	string Name of the database that the permission grants access to.

UserSettings

Field	Description
readonly	google.protobuf.Int64Value 0 (default)—no restrictions. 1—only read data queries are allowed. 2—read data and change settings queries are allowed. Acceptable values are 0 to 2, inclusive.
allow_ddl	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.
insert_quorum	google.protobuf.Int64Value replicas with no errors until the insert_quorum_timeout expires. queries. The minimum value is 0.
connect_timeout	google.protobuf.Int64Value (default: 10000, 10 seconds). Value must be greater than 0.
receive_timeout	google.protobuf.Int64Value (default: 300000, 300 seconds or 5 minutes). Value must be greater than 0.
send_timeout	google.protobuf.Int64Value (default: 300000, 300 seconds or 5 minutes). Value must be greater than 0.
insert_quorum_timeout	google.protobuf.Int64Value query and return an error. The minimum value is 1000.
select_sequential_consistency	google.protobuf.BoolValue 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. (sequential consistency is disabled).
max_replica_delay_for_distributed_queries	google.protobuf.Int64Value Max replica delay in milliseconds. If a replica lags more than the set value, this replica is not used and becomes a stale one. Minimum value: 1000, 1 second (default: 300000, 300 seconds or 5 minutes). See in-depth description in ClickHouse documentation. The minimum value is 1000.
fallback_to_stale_replicas_for_distributed_queries	google.protobuf.BoolValue query from a distributed table that points to replicated tables. (query forcing is enabled).
replication_alter_partitions_sync	google.protobuf.Int64Value queries on replicated tables: 0—do not wait for replicas. 1—only wait for own execution (default). 2—wait for all replicas. Acceptable values are 0 to 2, inclusive.
distributed_product_mode	enum DistributedProductMode Determine the behavior of distributed subqueries. See in-depth description in ClickHouse documentation. 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.
distributed_aggregation_memory_efficient	google.protobuf.BoolValue (memory saving mode is disabled).
distributed_ddl_task_timeout	google.protobuf.Int64Value Timeout for DDL queries, in milliseconds.
skip_unavailable_shards	google.protobuf.BoolValue (silent skipping is disabled).
compile	google.protobuf.BoolValue (compilation is disabled).
min_count_to_compile	google.protobuf.Int64Value (default: 3). value compilation is synchronous: a query waits for compilation process to complete prior to continuing execution. The minimum value is 0.
compile_expressions	google.protobuf.BoolValue (expression compilation is disabled).
min_count_to_compile_expression	google.protobuf.Int64Value (default: 3). value compilation is synchronous: a query waits for expression compilation process to complete prior to continuing execution. The minimum value is 0.
max_block_size	google.protobuf.Int64Value (default: 65536). Value must be greater than 0.
min_insert_block_size_rows	google.protobuf.Int64Value query. The minimum value is 0.
min_insert_block_size_bytes	google.protobuf.Int64Value query. The minimum value is 0.
max_insert_block_size	google.protobuf.Int64Value (default: 1048576). Value must be greater than 0.
min_bytes_to_use_direct_io	google.protobuf.Int64Value Limits the minimum number of bytes to enable unbuffered direct reads from disk (Direct I/O). 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. The minimum value is 0.
use_uncompressed_cache	google.protobuf.BoolValue (uncompressed cache is disabled).
merge_tree_max_rows_to_use_cache	google.protobuf.Int64Value (default: 128x8192). Value must be greater than 0.
merge_tree_max_bytes_to_use_cache	google.protobuf.Int64Value (default: 192x10x1024x1024). Value must be greater than 0.
merge_tree_min_rows_for_concurrent_read	google.protobuf.Int64Value (default: 20x8192). Value must be greater than 0.
merge_tree_min_bytes_for_concurrent_read	google.protobuf.Int64Value (default: 24x10x1024x1024). Value must be greater than 0.
max_bytes_before_external_group_by	google.protobuf.Int64Value operation, should be flushed to disk to limit the RAM comsumption. in the external memory is disabled.
max_bytes_before_external_sort	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.
group_by_two_level_threshold	google.protobuf.Int64Value Sets the threshold of the number of keys, after that the two-level aggregation should be used. Minimal value: 0, threshold is not set (default: 10000‬‬).
group_by_two_level_threshold_bytes	google.protobuf.Int64Value Sets the threshold of the number of bytes, after that the two-level aggregation should be used. Minimal value: 0, threshold is not set (default: 100000000‬‬).
priority	google.protobuf.Int64Value 0—priority is not used. 1—the highest priority. and so on. The higher the number, the lower a query's priority. The minimum value is 0.
max_threads	google.protobuf.Int64Value (the thread number is calculated automatically based on the number of physical CPU cores, no HyperThreading cores are taken into account). Value must be greater than 0.
max_memory_usage	google.protobuf.Int64Value (10 GB). The minimum value is 0.
max_memory_usage_for_user	google.protobuf.Int64Value Limits the maximum memory usage (in bytes) for processing of user's queries on a single server. 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. The minimum value is 0.
max_network_bandwidth	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.
max_network_bandwidth_for_user	google.protobuf.Int64Value The maximum speed of data exchange over the network in bytes per second for all concurrently running user queries. Minimal value and default value: 0, no limitation is set.
force_index_by_date	google.protobuf.BoolValue (setting is disabled, query executes even if ClickHouse can't use index by date).
force_primary_key	google.protobuf.BoolValue (setting is disabled, query executes even if ClickHouse can't use index by primary key).
max_rows_to_read	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. The minimum value is 0.
max_bytes_to_read	google.protobuf.Int64Value Limits the maximum number of bytes (uncompressed data) that can be read from a table when running a query. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
read_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_to_group_by	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. The minimum value is 0.
group_by_overflow_mode	enum GroupByOverflowMode 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.
max_rows_to_sort	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. The minimum value is 0.
max_bytes_to_sort	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. The minimum value is 0.
sort_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_result_rows	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. The minimum value is 0.
max_result_bytes	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. The minimum value is 0.
result_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_in_distinct	google.protobuf.Int64Value Limits the maximum number of different rows when using DISTINCT. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
max_bytes_in_distinct	google.protobuf.Int64Value Limits the maximum size of a hash table in bytes (uncompressed data) when using DISTINCT. The minimum value is 0.
distinct_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_to_transfer	google.protobuf.Int64Value Limits the maximum number of rows that can be passed to a remote server or saved in a temporary table when using GLOBAL IN. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
max_bytes_to_transfer	google.protobuf.Int64Value Limits the maximum number of bytes (uncompressed data) that can be passed to a remote server or saved in a temporary table when using GLOBAL IN. Minimal value and default value: 0, no limitation is set. The minimum value is 0.
transfer_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_execution_time	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. The minimum value is 0.
timeout_overflow_mode	enum OverflowMode throw—abort query execution, return an error. break—stop query execution, return partial result.
max_rows_in_set	google.protobuf.Int64Value Limit on the number of rows in the set resulting from the execution of the IN section. The minimum value is 0.
max_bytes_in_set	google.protobuf.Int64Value Limit on the number of bytes in the set resulting from the execution of the IN section. The minimum value is 0.
set_overflow_mode	enum OverflowMode Determine the behavior on exceeding max_rows_in_set or max_bytes_in_set limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK.
max_rows_in_join	google.protobuf.Int64Value Limit on maximum size of the hash table for JOIN, in rows. The minimum value is 0.
max_bytes_in_join	google.protobuf.Int64Value Limit on maximum size of the hash table for JOIN, in bytes. The minimum value is 0.
join_overflow_mode	enum OverflowMode Determine the behavior on exceeding max_rows_in_join or max_bytes_in_join limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK.
max_columns_to_read	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. The minimum value is 0.
max_temporary_columns	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. The minimum value is 0.
max_temporary_non_const_columns	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. The minimum value is 0.
max_query_size	google.protobuf.Int64Value (default: 262144). Value must be greater than 0.
max_ast_depth	google.protobuf.Int64Value query may result in more complex and deeper syntax tree, compared to the SELECT ... WHERE ... query, containing constraints and conditions, in the most cases. (default: 1000). Value must be greater than 0.
max_ast_elements	google.protobuf.Int64Value (default: 50000). Value must be greater than 0.
max_expanded_ast_elements	google.protobuf.Int64Value (default: 500000). Value must be greater than 0.
min_execution_speed	google.protobuf.Int64Value Minimal execution speed in rows per second. The minimum value is 0.
min_execution_speed_bytes	google.protobuf.Int64Value Minimal execution speed in bytes per second. The minimum value is 0.
count_distinct_implementation	enum CountDistinctImplementation Aggregate function to use for implementation of count(DISTINCT ...).
input_format_values_interpret_expressions	google.protobuf.BoolValue expression; therefore an INSERT query for this value will fail and no data will be inserted into a table. expression will be parsed as SQL function, interpreted, and the current date and time will be inserted into the table as a result. (SQL parser is enabled).
input_format_defaults_for_omitted_fields	google.protobuf.BoolValue queries. (replacing is enabled).
output_format_json_quote_64bit_integers	google.protobuf.BoolValue and Int64) will be quoted when written to JSON output in order to maintain compatibility with the most of the JavaScript engines. (quoting 64-bit integers is disabled).
output_format_json_quote_denormals	google.protobuf.BoolValue and -inf) in JSON output format. (special values do not present in output).
low_cardinality_allow_in_native_format	google.protobuf.BoolValue 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 are used in Native format).
empty_result_for_aggregation_by_empty_set	google.protobuf.BoolValue 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.
joined_subquery_requires_alias	google.protobuf.BoolValue
join_use_nulls	google.protobuf.BoolValue
transform_null_in	google.protobuf.BoolValue
http_connection_timeout	google.protobuf.Int64Value (default: 1000, 1 second).
http_receive_timeout	google.protobuf.Int64Value (default: 1800000, 1800 seconds, 30 minutes).
http_send_timeout	google.protobuf.Int64Value (default: 1800000, 1800 seconds, 30 minutes).
enable_http_compression	google.protobuf.BoolValue HTTP header in a HTTP request to force compression of HTTP response from ClickHouse. and deflate. (compression is disabled).
send_progress_in_http_headers	google.protobuf.BoolValue HTTP header. (notifications disabled).
http_headers_progress_interval	google.protobuf.Int64Value HTTP header, in milliseconds. (default: 100).
add_http_cors_header	google.protobuf.BoolValue (header is not added).
quota_mode	enum QuotaMode Quota accounting mode. Possible values: QUOTA_MODE_DEFAULT, QUOTA_MODE_KEYED and QUOTA_MODE_KEYED_BY_IP.

UserQuota

Field	Description
interval_duration	google.protobuf.Int64Value Duration of interval for quota in milliseconds. Minimal value is 1 second. The minimum value is 1000.
queries	google.protobuf.Int64Value The total number of queries. 0 - unlimited. The minimum value is 0.
errors	google.protobuf.Int64Value The number of queries that threw exception. 0 - unlimited. The minimum value is 0.
result_rows	google.protobuf.Int64Value The total number of rows given as the result.. 0 - unlimited. The minimum value is 0.
read_rows	google.protobuf.Int64Value The total number of source rows read from tables for running the query, on all remote servers. 0 - unlimited. The minimum value is 0.
execution_time	google.protobuf.Int64Value The total query execution time, in milliseconds (wall time). 0 - unlimited. The minimum value is 0.