UserService
A set of methods for managing ClickHouse User resources.
| 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. false 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. false 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 Restricts permissions for non-DDL queries. Possible values: 0 (default) — no restrictions, 1 — only read data queries are allowed, 2 — read data and change settings queries are allowed. Acceptable values are 0 to 2, inclusive. |
| allow_ddl | google.protobuf.BoolValue Whether DDL queries are allowed. Default value: false. |
| insert_quorum | google.protobuf.Int64Value For INSERT queries in the replicated table, wait writing for the specified number of replicas and linearize the addition of the data. The minimum value is 0. |
| connect_timeout | google.protobuf.Int64Value Connection timeout in milliseconds. Value must be greater than 0. |
| receive_timeout | google.protobuf.Int64Value Receive timeout in milliseconds. Value must be greater than 0. |
| send_timeout | google.protobuf.Int64Value Send timeout in milliseconds. Value must be greater than 0. |
| insert_quorum_timeout | google.protobuf.Int64Value Quorum write timeout in milliseconds. Default value: 60000. The minimum value is 1000. |
| select_sequential_consistency | google.protobuf.BoolValue For SELECT queries from the replicated table, throw an exception if the replica does not have a chunk written with the quorum; do not read the parts that have not yet been written with the quorum. |
| 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. Default value: 300000. The minimum value is 1000. |
| fallback_to_stale_replicas_for_distributed_queries | google.protobuf.BoolValue Determine the behavior when all replicas for the queried table are stale. If enabled, the query will be performed anyway. Otherwise, the error will be thrown. |
| replication_alter_partitions_sync | google.protobuf.Int64Value Wait mode for ALTER queries on replicated tables. Possible values: 0 - do not wait, 1 - wait for execution only of itself, 2 - wait for everyone. Acceptable values are 0 to 2, inclusive. |
| distributed_product_mode | enum DistributedProductMode Determine the behavior of distributed subqueries. Possible values: DISTRIBUTED_PRODUCT_MODE_DENY, DISTRIBUTED_PRODUCT_MODE_LOCAL, DISTRIBUTED_PRODUCT_MODE_GLOBAL, DISTRIBUTED_PRODUCT_MODE_ALLOW.
|
| distributed_aggregation_memory_efficient | google.protobuf.BoolValue Whether the memory-saving mode of distributed aggregation is enabled. |
| distributed_ddl_task_timeout | google.protobuf.Int64Value Timeout for DDL queries, in milliseconds. |
| skip_unavailable_shards | google.protobuf.BoolValue Whether unavailable shards can be skipped. |
| compile | google.protobuf.BoolValue Whether query compilation is enabled. |
| min_count_to_compile | google.protobuf.Int64Value The number of structurally identical queries before they are compiled. The minimum value is 0. |
| compile_expressions | google.protobuf.BoolValue Whether expression compilation is enabled. |
| min_count_to_compile_expression | google.protobuf.Int64Value The number of identical expressions before they are compiled. The minimum value is 0. |
| max_block_size | google.protobuf.Int64Value The maximum block size for reading. Value must be greater than 0. |
| min_insert_block_size_rows | google.protobuf.Int64Value Squash blocks passed to INSERT query to specified size in rows, if blocks are not big enough. If set to 0, blocks will never be squashed. The minimum value is 0. |
| min_insert_block_size_bytes | google.protobuf.Int64Value Squash blocks passed to INSERT query to specified size in bytes, if blocks are not big enough. If set to 0, blocks will never be squashed. The minimum value is 0. |
| max_insert_block_size | google.protobuf.Int64Value The maximum block size for insertion. Value must be greater than 0. |
| min_bytes_to_use_direct_io | google.protobuf.Int64Value The minimum number of bytes for reading the data with O_DIRECT option during SELECT queries execution. The minimum value is 0. |
| use_uncompressed_cache | google.protobuf.BoolValue Whether to use the cache of uncompressed blocks. |
| merge_tree_max_rows_to_use_cache | google.protobuf.Int64Value The maximum request size in rows to use the cache of uncompressed data. The cache is not used for requests larger than the specified value. Value must be greater than 0. |
| merge_tree_max_bytes_to_use_cache | google.protobuf.Int64Value The maximum request size in bytes to use the cache of uncompressed data. The cache is not used for requests larger than the specified value. Value must be greater than 0. |
| merge_tree_min_rows_for_concurrent_read | google.protobuf.Int64Value The minimum number of rows to be read from a file to enable concurrent read. Value must be greater than 0. |
| merge_tree_min_bytes_for_concurrent_read | google.protobuf.Int64Value The minimum number of bytes to be read from a file to enable concurrent read. Value must be greater than 0. |
| max_bytes_before_external_group_by | google.protobuf.Int64Value |
| max_bytes_before_external_sort | google.protobuf.Int64Value |
| group_by_two_level_threshold | google.protobuf.Int64Value |
| group_by_two_level_threshold_bytes | google.protobuf.Int64Value |
| priority | google.protobuf.Int64Value Priority of the query. The minimum value is 0. |
| max_threads | google.protobuf.Int64Value The maximum number of threads to execute the request. Value must be greater than 0. |
| max_memory_usage | google.protobuf.Int64Value The maximum memory usage for processing of a single query. The minimum value is 0. |
| max_memory_usage_for_user | google.protobuf.Int64Value The maximum memory usage for processing all concurrently running queries for the user. 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. |
| 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. |
| force_index_by_date | google.protobuf.BoolValue Disables query execution if the index can’t be used by date. |
| force_primary_key | google.protobuf.BoolValue Disables query execution if indexing by the primary key is not possible. |
| max_rows_to_read | google.protobuf.Int64Value The maximum number of rows that can be read from a table when running a query. The minimum value is 0. |
| max_bytes_to_read | google.protobuf.Int64Value The maximum number of bytes (uncompressed data) that can be read from a table when running a query. The minimum value is 0. |
| read_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_rows_to_read or max_bytes_to_read limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_rows_to_group_by | google.protobuf.Int64Value The maximum number of unique keys received from aggregation. The minimum value is 0. |
| group_by_overflow_mode | enum GroupByOverflowMode Determine the behavior on exceeding max_rows_to_group_by limit. Possible values: GROUP_BY_OVERFLOW_MODE_THROW, GROUP_BY_OVERFLOW_MODE_BREAK, GROUP_BY_OVERFLOW_MODE_ANY. |
| max_rows_to_sort | google.protobuf.Int64Value The maximum number of rows before sorting. The minimum value is 0. |
| max_bytes_to_sort | google.protobuf.Int64Value The maximum number of bytes before sorting. The minimum value is 0. |
| sort_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_rows_to_sort or max_bytes_to_sort limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_result_rows | google.protobuf.Int64Value Limit on the number of rows in the result. The minimum value is 0. |
| max_result_bytes | google.protobuf.Int64Value Limit on the number of bytes in the result. The minimum value is 0. |
| result_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_result_rows or max_result_bytes limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_rows_in_distinct | google.protobuf.Int64Value The maximum number of different rows when using DISTINCT. The minimum value is 0. |
| max_bytes_in_distinct | google.protobuf.Int64Value The maximum number of bytes used by a hash table when using DISTINCT. The minimum value is 0. |
| distinct_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_rows_in_distinct or max_bytes_in_distinct limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_rows_to_transfer | google.protobuf.Int64Value The maximum number of rows that can be passed to a remote server or saved in a temporary table when using GLOBAL IN. The minimum value is 0. |
| max_bytes_to_transfer | google.protobuf.Int64Value 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. The minimum value is 0. |
| transfer_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_rows_to_transfer or max_bytes_to_transfer limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_execution_time | google.protobuf.Int64Value The maximum query execution time in milliseconds. The minimum value is 0. |
| timeout_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_execution_time limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_columns_to_read | google.protobuf.Int64Value The maximum number of columns that can be read from a table in a single query. The minimum value is 0. |
| max_temporary_columns | google.protobuf.Int64Value The maximum number of temporary columns that must be kept in RAM at the same time when running a query, including constant columns. The minimum value is 0. |
| max_temporary_non_const_columns | google.protobuf.Int64Value The maximum number of temporary columns that must be kept in RAM at the same time when running a query, excluding constant columns. The minimum value is 0. |
| max_query_size | google.protobuf.Int64Value The maximum part of a query that can be taken to RAM for parsing with the SQL parser, in bytes. Default value: 262144. Value must be greater than 0. |
| max_ast_depth | google.protobuf.Int64Value The maximum depth of query syntax tree. Default value: 1000. Value must be greater than 0. |
| max_ast_elements | google.protobuf.Int64Value The maximum size of query syntax tree in number of nodes. Default value: 50000. Value must be greater than 0. |
| max_expanded_ast_elements | google.protobuf.Int64Value The maximum size of query syntax tree in number of nodes after expansion of aliases and the asterisk. Default value: 500000. Value must be greater than 0. |
| input_format_values_interpret_expressions | google.protobuf.BoolValue Enables or disables the full SQL parser if the fast stream parser cannot parse the data. |
| input_format_defaults_for_omitted_fields | google.protobuf.BoolValue When performing INSERT queries, replace omitted input column values with default values of the respective columns. |
| output_format_json_quote_64bit_integers | google.protobuf.BoolValue Whether quoting of 64-bit integers is enabled in JSON output format. |
| output_format_json_quote_denormals | google.protobuf.BoolValue Whether output of special floating-point values (+nan, -nan, +inf and -inf) is enabled in JSON output format. |
| low_cardinality_allow_in_native_format | google.protobuf.BoolValue Whether LowCardinality type is enabled in Native format. |
| empty_result_for_aggregation_by_empty_set | google.protobuf.BoolValue Return empty result when aggregating without keys on empty set. |
| http_connection_timeout | google.protobuf.Int64Value HTTP connection timeout, in milliseconds. |
| http_receive_timeout | google.protobuf.Int64Value HTTP receive timeout, in milliseconds. |
| http_send_timeout | google.protobuf.Int64Value HTTP send timeout, in milliseconds. |
| enable_http_compression | google.protobuf.BoolValue Whether data compression is enabled in HTTP responses. |
| send_progress_in_http_headers | google.protobuf.BoolValue Whether progress notifications using X-ClickHouse-Progress headers are enabled. Default value: false. |
| http_headers_progress_interval | google.protobuf.Int64Value Minimum interval between progress notifications, in milliseconds. Default value: 100. |
| add_http_cors_header | google.protobuf.BoolValue Whether CORS header in HTTP responses is enabled. Default value: false. |
| 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. false 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 Restricts permissions for non-DDL queries. Possible values: 0 (default) — no restrictions, 1 — only read data queries are allowed, 2 — read data and change settings queries are allowed. Acceptable values are 0 to 2, inclusive. |
| allow_ddl | google.protobuf.BoolValue Whether DDL queries are allowed. Default value: false. |
| insert_quorum | google.protobuf.Int64Value For INSERT queries in the replicated table, wait writing for the specified number of replicas and linearize the addition of the data. The minimum value is 0. |
| connect_timeout | google.protobuf.Int64Value Connection timeout in milliseconds. Value must be greater than 0. |
| receive_timeout | google.protobuf.Int64Value Receive timeout in milliseconds. Value must be greater than 0. |
| send_timeout | google.protobuf.Int64Value Send timeout in milliseconds. Value must be greater than 0. |
| insert_quorum_timeout | google.protobuf.Int64Value Quorum write timeout in milliseconds. Default value: 60000. The minimum value is 1000. |
| select_sequential_consistency | google.protobuf.BoolValue For SELECT queries from the replicated table, throw an exception if the replica does not have a chunk written with the quorum; do not read the parts that have not yet been written with the quorum. |
| 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. Default value: 300000. The minimum value is 1000. |
| fallback_to_stale_replicas_for_distributed_queries | google.protobuf.BoolValue Determine the behavior when all replicas for the queried table are stale. If enabled, the query will be performed anyway. Otherwise, the error will be thrown. |
| replication_alter_partitions_sync | google.protobuf.Int64Value Wait mode for ALTER queries on replicated tables. Possible values: 0 - do not wait, 1 - wait for execution only of itself, 2 - wait for everyone. Acceptable values are 0 to 2, inclusive. |
| distributed_product_mode | enum DistributedProductMode Determine the behavior of distributed subqueries. Possible values: DISTRIBUTED_PRODUCT_MODE_DENY, DISTRIBUTED_PRODUCT_MODE_LOCAL, DISTRIBUTED_PRODUCT_MODE_GLOBAL, DISTRIBUTED_PRODUCT_MODE_ALLOW.
|
| distributed_aggregation_memory_efficient | google.protobuf.BoolValue Whether the memory-saving mode of distributed aggregation is enabled. |
| distributed_ddl_task_timeout | google.protobuf.Int64Value Timeout for DDL queries, in milliseconds. |
| skip_unavailable_shards | google.protobuf.BoolValue Whether unavailable shards can be skipped. |
| compile | google.protobuf.BoolValue Whether query compilation is enabled. |
| min_count_to_compile | google.protobuf.Int64Value The number of structurally identical queries before they are compiled. The minimum value is 0. |
| compile_expressions | google.protobuf.BoolValue Whether expression compilation is enabled. |
| min_count_to_compile_expression | google.protobuf.Int64Value The number of identical expressions before they are compiled. The minimum value is 0. |
| max_block_size | google.protobuf.Int64Value The maximum block size for reading. Value must be greater than 0. |
| min_insert_block_size_rows | google.protobuf.Int64Value Squash blocks passed to INSERT query to specified size in rows, if blocks are not big enough. If set to 0, blocks will never be squashed. The minimum value is 0. |
| min_insert_block_size_bytes | google.protobuf.Int64Value Squash blocks passed to INSERT query to specified size in bytes, if blocks are not big enough. If set to 0, blocks will never be squashed. The minimum value is 0. |
| max_insert_block_size | google.protobuf.Int64Value The maximum block size for insertion. Value must be greater than 0. |
| min_bytes_to_use_direct_io | google.protobuf.Int64Value The minimum number of bytes for reading the data with O_DIRECT option during SELECT queries execution. The minimum value is 0. |
| use_uncompressed_cache | google.protobuf.BoolValue Whether to use the cache of uncompressed blocks. |
| merge_tree_max_rows_to_use_cache | google.protobuf.Int64Value The maximum request size in rows to use the cache of uncompressed data. The cache is not used for requests larger than the specified value. Value must be greater than 0. |
| merge_tree_max_bytes_to_use_cache | google.protobuf.Int64Value The maximum request size in bytes to use the cache of uncompressed data. The cache is not used for requests larger than the specified value. Value must be greater than 0. |
| merge_tree_min_rows_for_concurrent_read | google.protobuf.Int64Value The minimum number of rows to be read from a file to enable concurrent read. Value must be greater than 0. |
| merge_tree_min_bytes_for_concurrent_read | google.protobuf.Int64Value The minimum number of bytes to be read from a file to enable concurrent read. Value must be greater than 0. |
| max_bytes_before_external_group_by | google.protobuf.Int64Value |
| max_bytes_before_external_sort | google.protobuf.Int64Value |
| group_by_two_level_threshold | google.protobuf.Int64Value |
| group_by_two_level_threshold_bytes | google.protobuf.Int64Value |
| priority | google.protobuf.Int64Value Priority of the query. The minimum value is 0. |
| max_threads | google.protobuf.Int64Value The maximum number of threads to execute the request. Value must be greater than 0. |
| max_memory_usage | google.protobuf.Int64Value The maximum memory usage for processing of a single query. The minimum value is 0. |
| max_memory_usage_for_user | google.protobuf.Int64Value The maximum memory usage for processing all concurrently running queries for the user. 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. |
| 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. |
| force_index_by_date | google.protobuf.BoolValue Disables query execution if the index can’t be used by date. |
| force_primary_key | google.protobuf.BoolValue Disables query execution if indexing by the primary key is not possible. |
| max_rows_to_read | google.protobuf.Int64Value The maximum number of rows that can be read from a table when running a query. The minimum value is 0. |
| max_bytes_to_read | google.protobuf.Int64Value The maximum number of bytes (uncompressed data) that can be read from a table when running a query. The minimum value is 0. |
| read_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_rows_to_read or max_bytes_to_read limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_rows_to_group_by | google.protobuf.Int64Value The maximum number of unique keys received from aggregation. The minimum value is 0. |
| group_by_overflow_mode | enum GroupByOverflowMode Determine the behavior on exceeding max_rows_to_group_by limit. Possible values: GROUP_BY_OVERFLOW_MODE_THROW, GROUP_BY_OVERFLOW_MODE_BREAK, GROUP_BY_OVERFLOW_MODE_ANY. |
| max_rows_to_sort | google.protobuf.Int64Value The maximum number of rows before sorting. The minimum value is 0. |
| max_bytes_to_sort | google.protobuf.Int64Value The maximum number of bytes before sorting. The minimum value is 0. |
| sort_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_rows_to_sort or max_bytes_to_sort limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_result_rows | google.protobuf.Int64Value Limit on the number of rows in the result. The minimum value is 0. |
| max_result_bytes | google.protobuf.Int64Value Limit on the number of bytes in the result. The minimum value is 0. |
| result_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_result_rows or max_result_bytes limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_rows_in_distinct | google.protobuf.Int64Value The maximum number of different rows when using DISTINCT. The minimum value is 0. |
| max_bytes_in_distinct | google.protobuf.Int64Value The maximum number of bytes used by a hash table when using DISTINCT. The minimum value is 0. |
| distinct_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_rows_in_distinct or max_bytes_in_distinct limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_rows_to_transfer | google.protobuf.Int64Value The maximum number of rows that can be passed to a remote server or saved in a temporary table when using GLOBAL IN. The minimum value is 0. |
| max_bytes_to_transfer | google.protobuf.Int64Value 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. The minimum value is 0. |
| transfer_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_rows_to_transfer or max_bytes_to_transfer limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_execution_time | google.protobuf.Int64Value The maximum query execution time in milliseconds. The minimum value is 0. |
| timeout_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_execution_time limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_columns_to_read | google.protobuf.Int64Value The maximum number of columns that can be read from a table in a single query. The minimum value is 0. |
| max_temporary_columns | google.protobuf.Int64Value The maximum number of temporary columns that must be kept in RAM at the same time when running a query, including constant columns. The minimum value is 0. |
| max_temporary_non_const_columns | google.protobuf.Int64Value The maximum number of temporary columns that must be kept in RAM at the same time when running a query, excluding constant columns. The minimum value is 0. |
| max_query_size | google.protobuf.Int64Value The maximum part of a query that can be taken to RAM for parsing with the SQL parser, in bytes. Default value: 262144. Value must be greater than 0. |
| max_ast_depth | google.protobuf.Int64Value The maximum depth of query syntax tree. Default value: 1000. Value must be greater than 0. |
| max_ast_elements | google.protobuf.Int64Value The maximum size of query syntax tree in number of nodes. Default value: 50000. Value must be greater than 0. |
| max_expanded_ast_elements | google.protobuf.Int64Value The maximum size of query syntax tree in number of nodes after expansion of aliases and the asterisk. Default value: 500000. Value must be greater than 0. |
| input_format_values_interpret_expressions | google.protobuf.BoolValue Enables or disables the full SQL parser if the fast stream parser cannot parse the data. |
| input_format_defaults_for_omitted_fields | google.protobuf.BoolValue When performing INSERT queries, replace omitted input column values with default values of the respective columns. |
| output_format_json_quote_64bit_integers | google.protobuf.BoolValue Whether quoting of 64-bit integers is enabled in JSON output format. |
| output_format_json_quote_denormals | google.protobuf.BoolValue Whether output of special floating-point values (+nan, -nan, +inf and -inf) is enabled in JSON output format. |
| low_cardinality_allow_in_native_format | google.protobuf.BoolValue Whether LowCardinality type is enabled in Native format. |
| empty_result_for_aggregation_by_empty_set | google.protobuf.BoolValue Return empty result when aggregating without keys on empty set. |
| http_connection_timeout | google.protobuf.Int64Value HTTP connection timeout, in milliseconds. |
| http_receive_timeout | google.protobuf.Int64Value HTTP receive timeout, in milliseconds. |
| http_send_timeout | google.protobuf.Int64Value HTTP send timeout, in milliseconds. |
| enable_http_compression | google.protobuf.BoolValue Whether data compression is enabled in HTTP responses. |
| send_progress_in_http_headers | google.protobuf.BoolValue Whether progress notifications using X-ClickHouse-Progress headers are enabled. Default value: false. |
| http_headers_progress_interval | google.protobuf.Int64Value Minimum interval between progress notifications, in milliseconds. Default value: 100. |
| add_http_cors_header | google.protobuf.BoolValue Whether CORS header in HTTP responses is enabled. Default value: false. |
| 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. false The maximum string length in characters is 50. |
| user_spec | UserSpec Required. Properties of the user to be created. false |
UserSpec
| Field | Description |
|---|---|
| name | string Required. Name of the ClickHouse user. false 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. false 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 Restricts permissions for non-DDL queries. Possible values: 0 (default) — no restrictions, 1 — only read data queries are allowed, 2 — read data and change settings queries are allowed. Acceptable values are 0 to 2, inclusive. |
| allow_ddl | google.protobuf.BoolValue Whether DDL queries are allowed. Default value: false. |
| insert_quorum | google.protobuf.Int64Value For INSERT queries in the replicated table, wait writing for the specified number of replicas and linearize the addition of the data. The minimum value is 0. |
| connect_timeout | google.protobuf.Int64Value Connection timeout in milliseconds. Value must be greater than 0. |
| receive_timeout | google.protobuf.Int64Value Receive timeout in milliseconds. Value must be greater than 0. |
| send_timeout | google.protobuf.Int64Value Send timeout in milliseconds. Value must be greater than 0. |
| insert_quorum_timeout | google.protobuf.Int64Value Quorum write timeout in milliseconds. Default value: 60000. The minimum value is 1000. |
| select_sequential_consistency | google.protobuf.BoolValue For SELECT queries from the replicated table, throw an exception if the replica does not have a chunk written with the quorum; do not read the parts that have not yet been written with the quorum. |
| 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. Default value: 300000. The minimum value is 1000. |
| fallback_to_stale_replicas_for_distributed_queries | google.protobuf.BoolValue Determine the behavior when all replicas for the queried table are stale. If enabled, the query will be performed anyway. Otherwise, the error will be thrown. |
| replication_alter_partitions_sync | google.protobuf.Int64Value Wait mode for ALTER queries on replicated tables. Possible values: 0 - do not wait, 1 - wait for execution only of itself, 2 - wait for everyone. Acceptable values are 0 to 2, inclusive. |
| distributed_product_mode | enum DistributedProductMode Determine the behavior of distributed subqueries. Possible values: DISTRIBUTED_PRODUCT_MODE_DENY, DISTRIBUTED_PRODUCT_MODE_LOCAL, DISTRIBUTED_PRODUCT_MODE_GLOBAL, DISTRIBUTED_PRODUCT_MODE_ALLOW.
|
| distributed_aggregation_memory_efficient | google.protobuf.BoolValue Whether the memory-saving mode of distributed aggregation is enabled. |
| distributed_ddl_task_timeout | google.protobuf.Int64Value Timeout for DDL queries, in milliseconds. |
| skip_unavailable_shards | google.protobuf.BoolValue Whether unavailable shards can be skipped. |
| compile | google.protobuf.BoolValue Whether query compilation is enabled. |
| min_count_to_compile | google.protobuf.Int64Value The number of structurally identical queries before they are compiled. The minimum value is 0. |
| compile_expressions | google.protobuf.BoolValue Whether expression compilation is enabled. |
| min_count_to_compile_expression | google.protobuf.Int64Value The number of identical expressions before they are compiled. The minimum value is 0. |
| max_block_size | google.protobuf.Int64Value The maximum block size for reading. Value must be greater than 0. |
| min_insert_block_size_rows | google.protobuf.Int64Value Squash blocks passed to INSERT query to specified size in rows, if blocks are not big enough. If set to 0, blocks will never be squashed. The minimum value is 0. |
| min_insert_block_size_bytes | google.protobuf.Int64Value Squash blocks passed to INSERT query to specified size in bytes, if blocks are not big enough. If set to 0, blocks will never be squashed. The minimum value is 0. |
| max_insert_block_size | google.protobuf.Int64Value The maximum block size for insertion. Value must be greater than 0. |
| min_bytes_to_use_direct_io | google.protobuf.Int64Value The minimum number of bytes for reading the data with O_DIRECT option during SELECT queries execution. The minimum value is 0. |
| use_uncompressed_cache | google.protobuf.BoolValue Whether to use the cache of uncompressed blocks. |
| merge_tree_max_rows_to_use_cache | google.protobuf.Int64Value The maximum request size in rows to use the cache of uncompressed data. The cache is not used for requests larger than the specified value. Value must be greater than 0. |
| merge_tree_max_bytes_to_use_cache | google.protobuf.Int64Value The maximum request size in bytes to use the cache of uncompressed data. The cache is not used for requests larger than the specified value. Value must be greater than 0. |
| merge_tree_min_rows_for_concurrent_read | google.protobuf.Int64Value The minimum number of rows to be read from a file to enable concurrent read. Value must be greater than 0. |
| merge_tree_min_bytes_for_concurrent_read | google.protobuf.Int64Value The minimum number of bytes to be read from a file to enable concurrent read. Value must be greater than 0. |
| max_bytes_before_external_group_by | google.protobuf.Int64Value |
| max_bytes_before_external_sort | google.protobuf.Int64Value |
| group_by_two_level_threshold | google.protobuf.Int64Value |
| group_by_two_level_threshold_bytes | google.protobuf.Int64Value |
| priority | google.protobuf.Int64Value Priority of the query. The minimum value is 0. |
| max_threads | google.protobuf.Int64Value The maximum number of threads to execute the request. Value must be greater than 0. |
| max_memory_usage | google.protobuf.Int64Value The maximum memory usage for processing of a single query. The minimum value is 0. |
| max_memory_usage_for_user | google.protobuf.Int64Value The maximum memory usage for processing all concurrently running queries for the user. 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. |
| 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. |
| force_index_by_date | google.protobuf.BoolValue Disables query execution if the index can’t be used by date. |
| force_primary_key | google.protobuf.BoolValue Disables query execution if indexing by the primary key is not possible. |
| max_rows_to_read | google.protobuf.Int64Value The maximum number of rows that can be read from a table when running a query. The minimum value is 0. |
| max_bytes_to_read | google.protobuf.Int64Value The maximum number of bytes (uncompressed data) that can be read from a table when running a query. The minimum value is 0. |
| read_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_rows_to_read or max_bytes_to_read limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_rows_to_group_by | google.protobuf.Int64Value The maximum number of unique keys received from aggregation. The minimum value is 0. |
| group_by_overflow_mode | enum GroupByOverflowMode Determine the behavior on exceeding max_rows_to_group_by limit. Possible values: GROUP_BY_OVERFLOW_MODE_THROW, GROUP_BY_OVERFLOW_MODE_BREAK, GROUP_BY_OVERFLOW_MODE_ANY. |
| max_rows_to_sort | google.protobuf.Int64Value The maximum number of rows before sorting. The minimum value is 0. |
| max_bytes_to_sort | google.protobuf.Int64Value The maximum number of bytes before sorting. The minimum value is 0. |
| sort_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_rows_to_sort or max_bytes_to_sort limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_result_rows | google.protobuf.Int64Value Limit on the number of rows in the result. The minimum value is 0. |
| max_result_bytes | google.protobuf.Int64Value Limit on the number of bytes in the result. The minimum value is 0. |
| result_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_result_rows or max_result_bytes limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_rows_in_distinct | google.protobuf.Int64Value The maximum number of different rows when using DISTINCT. The minimum value is 0. |
| max_bytes_in_distinct | google.protobuf.Int64Value The maximum number of bytes used by a hash table when using DISTINCT. The minimum value is 0. |
| distinct_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_rows_in_distinct or max_bytes_in_distinct limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_rows_to_transfer | google.protobuf.Int64Value The maximum number of rows that can be passed to a remote server or saved in a temporary table when using GLOBAL IN. The minimum value is 0. |
| max_bytes_to_transfer | google.protobuf.Int64Value 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. The minimum value is 0. |
| transfer_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_rows_to_transfer or max_bytes_to_transfer limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_execution_time | google.protobuf.Int64Value The maximum query execution time in milliseconds. The minimum value is 0. |
| timeout_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_execution_time limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_columns_to_read | google.protobuf.Int64Value The maximum number of columns that can be read from a table in a single query. The minimum value is 0. |
| max_temporary_columns | google.protobuf.Int64Value The maximum number of temporary columns that must be kept in RAM at the same time when running a query, including constant columns. The minimum value is 0. |
| max_temporary_non_const_columns | google.protobuf.Int64Value The maximum number of temporary columns that must be kept in RAM at the same time when running a query, excluding constant columns. The minimum value is 0. |
| max_query_size | google.protobuf.Int64Value The maximum part of a query that can be taken to RAM for parsing with the SQL parser, in bytes. Default value: 262144. Value must be greater than 0. |
| max_ast_depth | google.protobuf.Int64Value The maximum depth of query syntax tree. Default value: 1000. Value must be greater than 0. |
| max_ast_elements | google.protobuf.Int64Value The maximum size of query syntax tree in number of nodes. Default value: 50000. Value must be greater than 0. |
| max_expanded_ast_elements | google.protobuf.Int64Value The maximum size of query syntax tree in number of nodes after expansion of aliases and the asterisk. Default value: 500000. Value must be greater than 0. |
| input_format_values_interpret_expressions | google.protobuf.BoolValue Enables or disables the full SQL parser if the fast stream parser cannot parse the data. |
| input_format_defaults_for_omitted_fields | google.protobuf.BoolValue When performing INSERT queries, replace omitted input column values with default values of the respective columns. |
| output_format_json_quote_64bit_integers | google.protobuf.BoolValue Whether quoting of 64-bit integers is enabled in JSON output format. |
| output_format_json_quote_denormals | google.protobuf.BoolValue Whether output of special floating-point values (+nan, -nan, +inf and -inf) is enabled in JSON output format. |
| low_cardinality_allow_in_native_format | google.protobuf.BoolValue Whether LowCardinality type is enabled in Native format. |
| empty_result_for_aggregation_by_empty_set | google.protobuf.BoolValue Return empty result when aggregating without keys on empty set. |
| http_connection_timeout | google.protobuf.Int64Value HTTP connection timeout, in milliseconds. |
| http_receive_timeout | google.protobuf.Int64Value HTTP receive timeout, in milliseconds. |
| http_send_timeout | google.protobuf.Int64Value HTTP send timeout, in milliseconds. |
| enable_http_compression | google.protobuf.BoolValue Whether data compression is enabled in HTTP responses. |
| send_progress_in_http_headers | google.protobuf.BoolValue Whether progress notifications using X-ClickHouse-Progress headers are enabled. Default value: false. |
| http_headers_progress_interval | google.protobuf.Int64Value Minimum interval between progress notifications, in milliseconds. Default value: 100. |
| add_http_cors_header | google.protobuf.BoolValue Whether CORS header in HTTP responses is enabled. Default value: false. |
| 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 responseThe 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. |
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. false 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. false 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 Restricts permissions for non-DDL queries. Possible values: 0 (default) — no restrictions, 1 — only read data queries are allowed, 2 — read data and change settings queries are allowed. Acceptable values are 0 to 2, inclusive. |
| allow_ddl | google.protobuf.BoolValue Whether DDL queries are allowed. Default value: false. |
| insert_quorum | google.protobuf.Int64Value For INSERT queries in the replicated table, wait writing for the specified number of replicas and linearize the addition of the data. The minimum value is 0. |
| connect_timeout | google.protobuf.Int64Value Connection timeout in milliseconds. Value must be greater than 0. |
| receive_timeout | google.protobuf.Int64Value Receive timeout in milliseconds. Value must be greater than 0. |
| send_timeout | google.protobuf.Int64Value Send timeout in milliseconds. Value must be greater than 0. |
| insert_quorum_timeout | google.protobuf.Int64Value Quorum write timeout in milliseconds. Default value: 60000. The minimum value is 1000. |
| select_sequential_consistency | google.protobuf.BoolValue For SELECT queries from the replicated table, throw an exception if the replica does not have a chunk written with the quorum; do not read the parts that have not yet been written with the quorum. |
| 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. Default value: 300000. The minimum value is 1000. |
| fallback_to_stale_replicas_for_distributed_queries | google.protobuf.BoolValue Determine the behavior when all replicas for the queried table are stale. If enabled, the query will be performed anyway. Otherwise, the error will be thrown. |
| replication_alter_partitions_sync | google.protobuf.Int64Value Wait mode for ALTER queries on replicated tables. Possible values: 0 - do not wait, 1 - wait for execution only of itself, 2 - wait for everyone. Acceptable values are 0 to 2, inclusive. |
| distributed_product_mode | enum DistributedProductMode Determine the behavior of distributed subqueries. Possible values: DISTRIBUTED_PRODUCT_MODE_DENY, DISTRIBUTED_PRODUCT_MODE_LOCAL, DISTRIBUTED_PRODUCT_MODE_GLOBAL, DISTRIBUTED_PRODUCT_MODE_ALLOW.
|
| distributed_aggregation_memory_efficient | google.protobuf.BoolValue Whether the memory-saving mode of distributed aggregation is enabled. |
| distributed_ddl_task_timeout | google.protobuf.Int64Value Timeout for DDL queries, in milliseconds. |
| skip_unavailable_shards | google.protobuf.BoolValue Whether unavailable shards can be skipped. |
| compile | google.protobuf.BoolValue Whether query compilation is enabled. |
| min_count_to_compile | google.protobuf.Int64Value The number of structurally identical queries before they are compiled. The minimum value is 0. |
| compile_expressions | google.protobuf.BoolValue Whether expression compilation is enabled. |
| min_count_to_compile_expression | google.protobuf.Int64Value The number of identical expressions before they are compiled. The minimum value is 0. |
| max_block_size | google.protobuf.Int64Value The maximum block size for reading. Value must be greater than 0. |
| min_insert_block_size_rows | google.protobuf.Int64Value Squash blocks passed to INSERT query to specified size in rows, if blocks are not big enough. If set to 0, blocks will never be squashed. The minimum value is 0. |
| min_insert_block_size_bytes | google.protobuf.Int64Value Squash blocks passed to INSERT query to specified size in bytes, if blocks are not big enough. If set to 0, blocks will never be squashed. The minimum value is 0. |
| max_insert_block_size | google.protobuf.Int64Value The maximum block size for insertion. Value must be greater than 0. |
| min_bytes_to_use_direct_io | google.protobuf.Int64Value The minimum number of bytes for reading the data with O_DIRECT option during SELECT queries execution. The minimum value is 0. |
| use_uncompressed_cache | google.protobuf.BoolValue Whether to use the cache of uncompressed blocks. |
| merge_tree_max_rows_to_use_cache | google.protobuf.Int64Value The maximum request size in rows to use the cache of uncompressed data. The cache is not used for requests larger than the specified value. Value must be greater than 0. |
| merge_tree_max_bytes_to_use_cache | google.protobuf.Int64Value The maximum request size in bytes to use the cache of uncompressed data. The cache is not used for requests larger than the specified value. Value must be greater than 0. |
| merge_tree_min_rows_for_concurrent_read | google.protobuf.Int64Value The minimum number of rows to be read from a file to enable concurrent read. Value must be greater than 0. |
| merge_tree_min_bytes_for_concurrent_read | google.protobuf.Int64Value The minimum number of bytes to be read from a file to enable concurrent read. Value must be greater than 0. |
| max_bytes_before_external_group_by | google.protobuf.Int64Value |
| max_bytes_before_external_sort | google.protobuf.Int64Value |
| group_by_two_level_threshold | google.protobuf.Int64Value |
| group_by_two_level_threshold_bytes | google.protobuf.Int64Value |
| priority | google.protobuf.Int64Value Priority of the query. The minimum value is 0. |
| max_threads | google.protobuf.Int64Value The maximum number of threads to execute the request. Value must be greater than 0. |
| max_memory_usage | google.protobuf.Int64Value The maximum memory usage for processing of a single query. The minimum value is 0. |
| max_memory_usage_for_user | google.protobuf.Int64Value The maximum memory usage for processing all concurrently running queries for the user. 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. |
| 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. |
| force_index_by_date | google.protobuf.BoolValue Disables query execution if the index can’t be used by date. |
| force_primary_key | google.protobuf.BoolValue Disables query execution if indexing by the primary key is not possible. |
| max_rows_to_read | google.protobuf.Int64Value The maximum number of rows that can be read from a table when running a query. The minimum value is 0. |
| max_bytes_to_read | google.protobuf.Int64Value The maximum number of bytes (uncompressed data) that can be read from a table when running a query. The minimum value is 0. |
| read_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_rows_to_read or max_bytes_to_read limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_rows_to_group_by | google.protobuf.Int64Value The maximum number of unique keys received from aggregation. The minimum value is 0. |
| group_by_overflow_mode | enum GroupByOverflowMode Determine the behavior on exceeding max_rows_to_group_by limit. Possible values: GROUP_BY_OVERFLOW_MODE_THROW, GROUP_BY_OVERFLOW_MODE_BREAK, GROUP_BY_OVERFLOW_MODE_ANY. |
| max_rows_to_sort | google.protobuf.Int64Value The maximum number of rows before sorting. The minimum value is 0. |
| max_bytes_to_sort | google.protobuf.Int64Value The maximum number of bytes before sorting. The minimum value is 0. |
| sort_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_rows_to_sort or max_bytes_to_sort limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_result_rows | google.protobuf.Int64Value Limit on the number of rows in the result. The minimum value is 0. |
| max_result_bytes | google.protobuf.Int64Value Limit on the number of bytes in the result. The minimum value is 0. |
| result_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_result_rows or max_result_bytes limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_rows_in_distinct | google.protobuf.Int64Value The maximum number of different rows when using DISTINCT. The minimum value is 0. |
| max_bytes_in_distinct | google.protobuf.Int64Value The maximum number of bytes used by a hash table when using DISTINCT. The minimum value is 0. |
| distinct_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_rows_in_distinct or max_bytes_in_distinct limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_rows_to_transfer | google.protobuf.Int64Value The maximum number of rows that can be passed to a remote server or saved in a temporary table when using GLOBAL IN. The minimum value is 0. |
| max_bytes_to_transfer | google.protobuf.Int64Value 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. The minimum value is 0. |
| transfer_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_rows_to_transfer or max_bytes_to_transfer limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_execution_time | google.protobuf.Int64Value The maximum query execution time in milliseconds. The minimum value is 0. |
| timeout_overflow_mode | enum OverflowMode Determine the behavior on exceeding max_execution_time limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
| max_columns_to_read | google.protobuf.Int64Value The maximum number of columns that can be read from a table in a single query. The minimum value is 0. |
| max_temporary_columns | google.protobuf.Int64Value The maximum number of temporary columns that must be kept in RAM at the same time when running a query, including constant columns. The minimum value is 0. |
| max_temporary_non_const_columns | google.protobuf.Int64Value The maximum number of temporary columns that must be kept in RAM at the same time when running a query, excluding constant columns. The minimum value is 0. |
| max_query_size | google.protobuf.Int64Value The maximum part of a query that can be taken to RAM for parsing with the SQL parser, in bytes. Default value: 262144. Value must be greater than 0. |
| max_ast_depth | google.protobuf.Int64Value The maximum depth of query syntax tree. Default value: 1000. Value must be greater than 0. |
| max_ast_elements | google.protobuf.Int64Value The maximum size of query syntax tree in number of nodes. Default value: 50000. Value must be greater than 0. |
| max_expanded_ast_elements | google.protobuf.Int64Value The maximum size of query syntax tree in number of nodes after expansion of aliases and the asterisk. Default value: 500000. Value must be greater than 0. |
| input_format_values_interpret_expressions | google.protobuf.BoolValue Enables or disables the full SQL parser if the fast stream parser cannot parse the data. |
| input_format_defaults_for_omitted_fields | google.protobuf.BoolValue When performing INSERT queries, replace omitted input column values with default values of the respective columns. |
| output_format_json_quote_64bit_integers | google.protobuf.BoolValue Whether quoting of 64-bit integers is enabled in JSON output format. |
| output_format_json_quote_denormals | google.protobuf.BoolValue Whether output of special floating-point values (+nan, -nan, +inf and -inf) is enabled in JSON output format. |
| low_cardinality_allow_in_native_format | google.protobuf.BoolValue Whether LowCardinality type is enabled in Native format. |
| empty_result_for_aggregation_by_empty_set | google.protobuf.BoolValue Return empty result when aggregating without keys on empty set. |
| http_connection_timeout | google.protobuf.Int64Value HTTP connection timeout, in milliseconds. |
| http_receive_timeout | google.protobuf.Int64Value HTTP receive timeout, in milliseconds. |
| http_send_timeout | google.protobuf.Int64Value HTTP send timeout, in milliseconds. |
| enable_http_compression | google.protobuf.BoolValue Whether data compression is enabled in HTTP responses. |
| send_progress_in_http_headers | google.protobuf.BoolValue Whether progress notifications using X-ClickHouse-Progress headers are enabled. Default value: false. |
| http_headers_progress_interval | google.protobuf.Int64Value Minimum interval between progress notifications, in milliseconds. Default value: 100. |
| add_http_cors_header | google.protobuf.BoolValue Whether CORS header in HTTP responses is enabled. Default value: false. |
| 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 responseThe 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. |
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. false 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. false 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 responseThe 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. false 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. false 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 responseThe 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. |
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. false 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. false 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 responseThe 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. |