Managed Service for ClickHouse API, REST: User methods
A set of methods for managing ClickHouse User resources.
NOTE: these methods are available only if user management through SQL is disabled.
JSON Representation
{
"name": "string",
"clusterId": "string",
"permissions": [
{
"databaseName": "string"
}
],
"settings": {
"readonly": "integer",
"allowDdl": true,
"allowIntrospectionFunctions": true,
"connectTimeout": "integer",
"connectTimeoutWithFailover": "integer",
"receiveTimeout": "integer",
"sendTimeout": "integer",
"timeoutBeforeCheckingExecutionSpeed": "integer",
"insertQuorum": "integer",
"insertQuorumTimeout": "integer",
"insertQuorumParallel": true,
"insertNullAsDefault": true,
"selectSequentialConsistency": true,
"deduplicateBlocksInDependentMaterializedViews": true,
"replicationAlterPartitionsSync": "integer",
"maxReplicaDelayForDistributedQueries": "integer",
"fallbackToStaleReplicasForDistributedQueries": true,
"distributedProductMode": "string",
"distributedAggregationMemoryEfficient": true,
"distributedDdlTaskTimeout": "integer",
"skipUnavailableShards": true,
"compileExpressions": true,
"minCountToCompileExpression": "integer",
"maxBlockSize": "integer",
"minInsertBlockSizeRows": "integer",
"minInsertBlockSizeBytes": "integer",
"maxInsertBlockSize": "integer",
"minBytesToUseDirectIo": "integer",
"useUncompressedCache": true,
"mergeTreeMaxRowsToUseCache": "integer",
"mergeTreeMaxBytesToUseCache": "integer",
"mergeTreeMinRowsForConcurrentRead": "integer",
"mergeTreeMinBytesForConcurrentRead": "integer",
"maxBytesBeforeExternalGroupBy": "integer",
"maxBytesBeforeExternalSort": "integer",
"groupByTwoLevelThreshold": "integer",
"groupByTwoLevelThresholdBytes": "integer",
"priority": "integer",
"maxThreads": "integer",
"maxMemoryUsage": "integer",
"maxMemoryUsageForUser": "integer",
"maxNetworkBandwidth": "integer",
"maxNetworkBandwidthForUser": "integer",
"maxPartitionsPerInsertBlock": "integer",
"maxConcurrentQueriesForUser": "integer",
"forceIndexByDate": true,
"forcePrimaryKey": true,
"maxRowsToRead": "integer",
"maxBytesToRead": "integer",
"readOverflowMode": "string",
"maxRowsToGroupBy": "integer",
"groupByOverflowMode": "string",
"maxRowsToSort": "integer",
"maxBytesToSort": "integer",
"sortOverflowMode": "string",
"maxResultRows": "integer",
"maxResultBytes": "integer",
"resultOverflowMode": "string",
"maxRowsInDistinct": "integer",
"maxBytesInDistinct": "integer",
"distinctOverflowMode": "string",
"maxRowsToTransfer": "integer",
"maxBytesToTransfer": "integer",
"transferOverflowMode": "string",
"maxExecutionTime": "integer",
"timeoutOverflowMode": "string",
"maxRowsInSet": "integer",
"maxBytesInSet": "integer",
"setOverflowMode": "string",
"maxRowsInJoin": "integer",
"maxBytesInJoin": "integer",
"joinOverflowMode": "string",
"joinAlgorithm": [
"string"
],
"anyJoinDistinctRightTableKeys": true,
"maxColumnsToRead": "integer",
"maxTemporaryColumns": "integer",
"maxTemporaryNonConstColumns": "integer",
"maxQuerySize": "integer",
"maxAstDepth": "integer",
"maxAstElements": "integer",
"maxExpandedAstElements": "integer",
"minExecutionSpeed": "integer",
"minExecutionSpeedBytes": "integer",
"countDistinctImplementation": "string",
"inputFormatValuesInterpretExpressions": true,
"inputFormatDefaultsForOmittedFields": true,
"inputFormatNullAsDefault": true,
"dateTimeInputFormat": "string",
"inputFormatWithNamesUseHeader": true,
"outputFormatJsonQuote_64BitIntegers": true,
"outputFormatJsonQuoteDenormals": true,
"dateTimeOutputFormat": "string",
"lowCardinalityAllowInNativeFormat": true,
"allowSuspiciousLowCardinalityTypes": true,
"emptyResultForAggregationByEmptySet": true,
"httpConnectionTimeout": "integer",
"httpReceiveTimeout": "integer",
"httpSendTimeout": "integer",
"enableHttpCompression": true,
"sendProgressInHttpHeaders": true,
"httpHeadersProgressInterval": "integer",
"addHttpCorsHeader": true,
"cancelHttpReadonlyQueriesOnClientClose": true,
"maxHttpGetRedirects": "integer",
"joinedSubqueryRequiresAlias": true,
"joinUseNulls": true,
"transformNullIn": true,
"quotaMode": "string",
"flattenNested": true,
"formatRegexp": "string",
"formatRegexpEscapingRule": "string",
"formatRegexpSkipUnmatched": true,
"asyncInsert": true,
"asyncInsertThreads": "integer",
"waitForAsyncInsert": true,
"waitForAsyncInsertTimeout": "integer",
"asyncInsertMaxDataSize": "integer",
"asyncInsertBusyTimeout": "integer",
"asyncInsertStaleTimeout": "integer",
"memoryProfilerStep": "integer",
"memoryProfilerSampleProbability": "number",
"maxFinalThreads": "integer",
"inputFormatParallelParsing": true,
"inputFormatImportNestedJson": true,
"localFilesystemReadMethod": "string",
"maxReadBufferSize": "integer",
"insertKeeperMaxRetries": "integer",
"maxTemporaryDataOnDiskSizeForUser": "integer",
"maxTemporaryDataOnDiskSizeForQuery": "integer",
"maxParserDepth": "integer",
"remoteFilesystemReadMethod": "string",
"memoryOvercommitRatioDenominator": "integer",
"memoryOvercommitRatioDenominatorForUser": "integer",
"memoryUsageOvercommitMaxWaitMicroseconds": "integer",
"compile": true,
"minCountToCompile": "integer"
},
"quotas": [
{
"intervalDuration": "integer",
"queries": "integer",
"errors": "integer",
"resultRows": "integer",
"readRows": "integer",
"executionTime": "integer"
}
]
}
Field | Description |
---|---|
name | string Name of the ClickHouse user. |
clusterId | string ID of the ClickHouse cluster the user belongs to. |
permissions[] | object Set of permissions granted to the user. |
permissions[]. databaseName |
string Name of the database that the permission grants access to. |
settings | object ClickHouse user settings. Supported settings are a limited subset of all settings described in ClickHouse documentation. |
settings. readonly |
integer (int64) Restricts permissions for non-DDL queries. To restrict permissions for DDL queries, use
See in-depth description in ClickHouse documentation. Acceptable values are 0 to 2, inclusive. |
settings. allowDdl |
boolean (boolean) Determines whether DDL queries are allowed (e.g., CREATE, ALTER, RENAME, etc). Default value: true. See in-depth description in ClickHouse documentation. |
settings. allowIntrospectionFunctions |
boolean (boolean) Enables introspections functions for query profiling. More info see in ClickHouse documentation. |
settings. connectTimeout |
integer (int64) Connection timeout in milliseconds. Value must be greater than 0 (default: 10000, 10 seconds). Value must be greater than 0. |
settings. connectTimeoutWithFailover |
integer (int64) The timeout in milliseconds for connecting to a remote server for a Distributed table engine. Applies only if the cluster uses sharding and replication. If unsuccessful, several attempts are made to connect to various replicas. Default value: 50. More info see in ClickHouse documentation. Value must be greater than 0. |
settings. receiveTimeout |
integer (int64) Receive timeout in milliseconds. Value must be greater than 0 (default: 300000, 300 seconds or 5 minutes). Value must be greater than 0. |
settings. sendTimeout |
integer (int64) Send timeout in milliseconds. Value must be greater than 0 (default: 300000, 300 seconds or 5 minutes). Value must be greater than 0. |
settings. timeoutBeforeCheckingExecutionSpeed |
integer (int64) Timeout (in seconds) between checks of execution speed. It is checked that execution speed is not less that specified in Default value: 10. |
settings. insertQuorum |
integer (int64) Enables or disables write quorum for ClickHouse cluster. If the value is less than 2, then write quorum is disabled, otherwise it is enabled. When used, write quorum guarantees that ClickHouse has written data to the quorum of insert_quorum replicas with no errors until the You can use See in-depth description in ClickHouse documentation. The minimum value is 0. |
settings. insertQuorumTimeout |
integer (int64) Quorum write timeout in milliseconds. If the write quorum is enabled in the cluster, this timeout expires and some data is not written to the Minimum value: 1000, 1 second (default: 60000, 1 minute). The minimum value is 1000. |
settings. insertQuorumParallel |
boolean (boolean) See in-depth description in ClickHouse documentation. |
settings. insertNullAsDefault |
boolean (boolean) Enables the insertion of default values instead of NULL into columns with not nullable data type. Default value: true. More info see in ClickHouse documentation. |
settings. selectSequentialConsistency |
boolean (boolean) Determines the behavior of SELECT queries from the replicated table: if enabled, ClickHouse will terminate a query with error message in case the replica does not have a chunk written with the quorum and will not read the parts that have not yet been written with the quorum. Default value: false (sequential consistency is disabled). |
settings. deduplicateBlocksInDependentMaterializedViews |
boolean (boolean) See in-depth description in ClickHouse documentation. |
settings. replicationAlterPartitionsSync |
integer (int64) Wait mode for asynchronous actions in ALTER queries on replicated tables:
See in-depth description in ClickHouse documentation. Acceptable values are 0 to 2, inclusive. |
settings. maxReplicaDelayForDistributedQueries |
integer (int64) 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. |
settings. fallbackToStaleReplicasForDistributedQueries |
boolean (boolean) Enables or disables query forcing to a stale replica in case the actual data is unavailable. If enabled, ClickHouse will choose the most up-to-date replica and force the query to use the data in this replica. This setting can be used when doing SELECT query from a distributed table that points to replicated tables. Default value: true (query forcing is enabled). See in-depth description in ClickHouse documentation. |
settings. distributedProductMode |
string Determine the behavior of distributed subqueries. See in-depth description in ClickHouse documentation.
|
settings. distributedAggregationMemoryEfficient |
boolean (boolean) Enables of disables memory saving mode when doing distributed aggregation. When ClickHouse works with a distributed query, external aggregation is done on remote servers. Enable this setting to achieve a smaller memory footprint on the server that sourced such a distributed query. Default value: false (memory saving mode is disabled). See in-depth description in ClickHouse documentation. |
settings. distributedDdlTaskTimeout |
integer (int64) Timeout for DDL queries, in milliseconds. |
settings. skipUnavailableShards |
boolean (boolean) Enables or disables silent skipping of unavailable shards. A shard is considered unavailable if all its replicas are also unavailable. Default value: false (silent skipping is disabled). See in-depth description in ClickHouse documentation. |
settings. compileExpressions |
boolean (boolean) Enables or disables expression compilation. If you execute a lot of queries that contain identical expressions, then enable this setting. As a result, such queries may be executed faster due to use of compiled expressions. Use this setting in combination with Default value: false (expression compilation is disabled). |
settings. minCountToCompileExpression |
integer (int64) How many identical expressions ClickHouse has to encounter before they are compiled. Minimum value: 0 (default: 3). For the 0 value compilation is synchronous: a query waits for expression compilation process to complete prior to continuing execution. It is recommended to set this value only for testing purposes. For all other values, compilation is asynchronous: the compilation process executes in a separate thread. When a compiled expression is ready, it will be used by ClickHouse for eligible queries, including the ones that are currently running. The minimum value is 0. |
settings. maxBlockSize |
integer (int64) The maximum block size for reading. Data in ClickHouse is organized and processed by blocks (block is a set of columns' parts). The internal processing cycles for a single block are efficient enough, but there are noticeable expenditures on each block. This setting is a recommendation for size of block (in a count of rows) that should be loaded from tables. Value must be greater than 0 (default: 65536). See in-depth description in ClickHouse documentation. Value must be greater than 0. |
settings. minInsertBlockSizeRows |
integer (int64) Limits the minimum number of rows in a block to be inserted in a table by INSERT query. Blocks that are smaller than the specified value, will be squashed together into the bigger blocks. Minimal value: 0, block squashing is disabled (default: 1048576). The minimum value is 0. |
settings. minInsertBlockSizeBytes |
integer (int64) Limits the minimum number of bytes in a block to be inserted in a table by INSERT query. Blocks that are smaller than the specified value, will be squashed together into the bigger blocks. Minimal value: 0, block squashing is disabled (default: 268435456, 256 MB). The minimum value is 0. |
settings. maxInsertBlockSize |
integer (int64) Allows to form blocks of the specified size (in bytes) when inserting data in a table. This setting has effect only if server is creating such blocks by itself. Value must be greater than 0 (default: 1048576). See in-depth description in ClickHouse documentation. Value must be greater than 0. |
settings. minBytesToUseDirectIo |
integer (int64) 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. |
settings. useUncompressedCache |
boolean (boolean) Determines whether to use the cache of uncompressed blocks, or not. Using this cache can significantly reduce latency and increase the throughput when a huge amount of small queries is to be processed. Enable this setting for the users who instantiates small queries frequently. This setting has effect only for tables of the MergeTree family. Default value: false (uncompressed cache is disabled). See in-depth description in ClickHouse documentation. |
settings. mergeTreeMaxRowsToUseCache |
integer (int64) Limits the maximum size in rows of the request that can use the cache of uncompressed data. The cache is not used for requests larger than the specified value. Use this setting in combination with Value must be greater than 0 (default: 128x8192). Value must be greater than 0. |
settings. mergeTreeMaxBytesToUseCache |
integer (int64) Limits the maximum size in bytes of the request that can use the cache of uncompressed data. The cache is not used for requests larger than the specified value. Use this setting in combination with Value must be greater than 0 (default: 192x10x1024x1024). Value must be greater than 0. |
settings. mergeTreeMinRowsForConcurrentRead |
integer (int64) Limits the minimum number of rows to be read from a file to enable concurrent read. If the number of rows to be read exceeds this value, then ClickHouse will try to use a few threads to read from a file concurrently. This setting has effect only for tables of the MergeTree family. Value must be greater than 0 (default: 20x8192). Value must be greater than 0. |
settings. mergeTreeMinBytesForConcurrentRead |
integer (int64) Limits the number of bytes to be read from a file to enable concurrent read. If the number of bytes to be read exceeds this value, then ClickHouse will try to use a few threads to read from a file concurrently. This setting has effect only for tables of the MergeTree family. Value must be greater than 0 (default: 24x10x1024x1024). Value must be greater than 0. |
settings. maxBytesBeforeExternalGroupBy |
integer (int64) Sets the threshold of RAM consumption (in bytes) after that the temporary data, collected during the GROUP BY operation, should be flushed to disk to limit the RAM comsumption. By default, aggregation is done by employing hash table that resides in RAM. A query can result in aggregation of huge data volumes that can lead to memory exhaustion and abortion of the query (see the Minimal value and default value: 0, GROUP BY in the external memory is disabled. When using aggregation in external memory, it is recommended to set the value of this setting twice as low as the See in-depth description in ClickHouse documentation. See also: the |
settings. maxBytesBeforeExternalSort |
integer (int64) This setting is equivalent of the |
settings. groupByTwoLevelThreshold |
integer (int64) 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). |
settings. groupByTwoLevelThresholdBytes |
integer (int64) 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). |
settings. priority |
integer (int64) Sets the priority of a query.
This setting should be set up for each query individually. If ClickHouse is working with the high-priority queries, and a low-priority query enters, then the low-priority query is paused until higher-priority queries are completed. Minimal value and default value: 0, priority is not used. The minimum value is 0. |
settings. maxThreads |
integer (int64) Limits the maximum number of threads to process the request (setting does not take threads that read data from remote servers into account). This setting applies to threads that perform the same stages of the query processing pipeline in parallel. Minimal value and default value: 0 (the thread number is calculated automatically based on the number of physical CPU cores, no HyperThreading cores are taken into account). See in-depth description in ClickHouse documentation. Value must be greater than 0. |
settings. maxMemoryUsage |
integer (int64) Limits the maximum memory usage (in bytes) for processing of a single user's query on a single server. This setting does not take server's free RAM amount or total RAM amount into account. This limitation is enforced for any user's single query on a single server. Minimal value: 0, no limitation is set. Value that is set in the ClickHouse default config file: 10737418240 (10 GB). If you use See in-depth description in ClickHouse documentation. The minimum value is 0. |
settings. maxMemoryUsageForUser |
integer (int64) 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. |
settings. maxNetworkBandwidth |
integer (int64) 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. |
settings. maxNetworkBandwidthForUser |
integer (int64) 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. |
settings. maxPartitionsPerInsertBlock |
integer (int64) See in-depth description in ClickHouse documentation. |
settings. maxConcurrentQueriesForUser |
integer (int64) The maximum number of concurrent requests per user. Default value: 0 (no limit). |
settings. forceIndexByDate |
boolean (boolean) If enabled, query is not executed if the ClickHouse can't use index by date. This setting has effect only for tables of the MergeTree family. Default value: false (setting is disabled, query executes even if ClickHouse can't use index by date). See in-depth description in ClickHouse documentation. |
settings. forcePrimaryKey |
boolean (boolean) If enabled, query is not executed if the ClickHouse can't use index by primary key. This setting has effect only for tables of the MergeTree family. Default value: false (setting is disabled, query executes even if ClickHouse can't use index by primary key). See in-depth description in ClickHouse documentation. |
settings. maxRowsToRead |
integer (int64) 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. |
settings. maxBytesToRead |
integer (int64) 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. |
settings. readOverflowMode |
string Determines the behavior on exceeding limits while reading the data.
|
settings. maxRowsToGroupBy |
integer (int64) 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. |
settings. groupByOverflowMode |
string Determines the behavior on exceeding limits while doing aggregation.
|
settings. maxRowsToSort |
integer (int64) 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. |
settings. maxBytesToSort |
integer (int64) 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. |
settings. sortOverflowMode |
string Determines the behavior on exceeding limits while sorting.
|
settings. maxResultRows |
integer (int64) 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. |
settings. maxResultBytes |
integer (int64) 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. |
settings. resultOverflowMode |
string Determines the behavior on exceeding limits while forming result.
|
settings. maxRowsInDistinct |
integer (int64) 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. |
settings. maxBytesInDistinct |
integer (int64) Limits the maximum size of a hash table in bytes (uncompressed data) when using DISTINCT. The minimum value is 0. |
settings. distinctOverflowMode |
string Determines the behavior on exceeding limits while doing DISCTINCT.
|
settings. maxRowsToTransfer |
integer (int64) 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. |
settings. maxBytesToTransfer |
integer (int64) 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. |
settings. transferOverflowMode |
string Determines the behavior on exceeding limits while doing transfers.
|
settings. maxExecutionTime |
integer (int64) 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. |
settings. timeoutOverflowMode |
string Determines the behavior on exceeding limits of execution time.
|
settings. maxRowsInSet |
integer (int64) Limit on the number of rows in the set resulting from the execution of the IN section. The minimum value is 0. |
settings. maxBytesInSet |
integer (int64) Limit on the number of bytes in the set resulting from the execution of the IN section. The minimum value is 0. |
settings. setOverflowMode |
string Determine the behavior on exceeding max_rows_in_set or max_bytes_in_set limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
settings. maxRowsInJoin |
integer (int64) Limit on maximum size of the hash table for JOIN, in rows. The minimum value is 0. |
settings. maxBytesInJoin |
integer (int64) Limit on maximum size of the hash table for JOIN, in bytes. The minimum value is 0. |
settings. joinOverflowMode |
string Determine the behavior on exceeding max_rows_in_join or max_bytes_in_join limit. Possible values: OVERFLOW_MODE_THROW, OVERFLOW_MODE_BREAK. |
settings. joinAlgorithm[] |
string See in-depth description in ClickHouse documentation. |
settings. anyJoinDistinctRightTableKeys |
boolean (boolean) See in-depth description in ClickHouse documentation. |
settings. maxColumnsToRead |
integer (int64) 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. |
settings. maxTemporaryColumns |
integer (int64) 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. |
settings. maxTemporaryNonConstColumns |
integer (int64) 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. |
settings. maxQuerySize |
integer (int64) Limits the size of the part of a query that can be transferred to RAM for parsing with the SQL parser, in bytes. Value must be greater than 0 (default: 262144). See in-depth description in ClickHouse documentation. Value must be greater than 0. |
settings. maxAstDepth |
integer (int64) Limits the maximum depth of query syntax tree. Executing a big and complex query may result in building a syntax tree of enormous depth. By using this setting, you can prohibit execution of over-sized or non-optimized queries for huge tables. For example, the **SELECT *** query may result in more complex and deeper syntax tree, compared to the SELECT ... WHERE ... query, containing constraints and conditions, in the most cases. A user can be forced to construct more optimized queries, if this setting is used. Value must be greater than 0 (default: 1000). If a too small value is set, it may render ClickHouse unable to execute even simple queries. See in-depth description in ClickHouse documentation. Value must be greater than 0. |
settings. maxAstElements |
integer (int64) Limits the maximum size of query syntax tree in number of nodes. Executing a big and complex query may result in building a syntax tree of enormous size. By using this setting, you can prohibit execution of over-sized or non-optimized queries for huge tables. Value must be greater than 0 (default: 50000). If a too small value is set, it may render ClickHouse unable to execute even simple queries. See in-depth description in ClickHouse documentation. Value must be greater than 0. |
settings. maxExpandedAstElements |
integer (int64) Limits the maximum size of query syntax tree in number of nodes after expansion of aliases and the asterisk values. Executing a big and complex query may result in building a syntax tree of enormous size. By using this setting, you can prohibit execution of over-sized or non-optimized queries for huge tables. Value must be greater than 0 (default: 500000). If a too small value is set, it may render ClickHouse unable to execute even simple queries. Value must be greater than 0. |
settings. minExecutionSpeed |
integer (int64) Minimal execution speed in rows per second. The minimum value is 0. |
settings. minExecutionSpeedBytes |
integer (int64) Minimal execution speed in bytes per second. The minimum value is 0. |
settings. countDistinctImplementation |
string Aggregate function to use for implementation of count(DISTINCT ...). |
settings. inputFormatValuesInterpretExpressions |
boolean (boolean) Enables or disables SQL parser if the fast stream parser cannot parse the data. Enable this setting, if the data that you want to insert into a table contains SQL expressions. For example, the stream parser is unable to parse a value that contains now() expression; therefore an INSERT query for this value will fail and no data will be inserted into a table. With enabled SQL parser, this expression is parsed correctly: the now() expression will be parsed as SQL function, interpreted, and the current date and time will be inserted into the table as a result. This setting has effect only if you use Values format when inserting data. Default value: true (SQL parser is enabled). See in-depth description in ClickHouse documentation. |
settings. inputFormatDefaultsForOmittedFields |
boolean (boolean) Enables or disables replacing omitted input values with default values of the respective columns when performing INSERT queries. Default value: true (replacing is enabled). |
settings. inputFormatNullAsDefault |
boolean (boolean) See in-depth description in ClickHouse documentation. |
settings. dateTimeInputFormat |
string See in-depth description in ClickHouse documentation. |
settings. inputFormatWithNamesUseHeader |
boolean (boolean) See in-depth description in ClickHouse documentation. |
settings. outputFormatJsonQuote_64BitIntegers |
boolean (boolean) Enables quoting of 64-bit integers in JSON output format. If this setting is enabled, then 64-bit integers (UInt64 and Int64) will be quoted when written to JSON output in order to maintain compatibility with the most of the JavaScript engines. Otherwise, such integers will not be quoted. Default value: false (quoting 64-bit integers is disabled). |
settings. outputFormatJsonQuoteDenormals |
boolean (boolean) Enables special floating-point values (+nan, -nan, +inf and -inf) in JSON output format. Default value: false (special values do not present in output). |
settings. dateTimeOutputFormat |
string See in-depth description in ClickHouse documentation. |
settings. lowCardinalityAllowInNativeFormat |
boolean (boolean) Determines whether to use LowCardinality type in Native format.
LowCardinality columns (aka sparse columns) store data in more effective way, compared to regular columns, by using hash tables. If data to insert suits this storage format, ClickHouse will place them into LowCardinality column. If you use a third-party ClickHouse client that can't work with LowCardinality columns, then this client will not be able to correctly interpret the result of the query that asks for data stored in LowCardinality column. Disable this setting to convert LowCardinality column to regular column when creating the result, so such clients will be able to process the result. Official ClickHouse client works with LowCardinality columns out-of-the-box. Default value: true (LowCardinality columns are used in Native format). |
settings. allowSuspiciousLowCardinalityTypes |
boolean (boolean) Allows specifying LowCardinality modifier for types of small fixed size (8 or less) in CREATE TABLE statements. Enabling this may increase merge times and memory consumption. More info see in ClickHouse documentation. |
settings. emptyResultForAggregationByEmptySet |
boolean (boolean) Enables returning of empty result when aggregating without keys (with GROUP BY operation absent) on empty set (e.g., SELECT count(*) FROM table WHERE 0).
|
settings. httpConnectionTimeout |
integer (int64) HTTP connection timeout, in milliseconds. Value must be greater than 0 (default: 1000, 1 second). |
settings. httpReceiveTimeout |
integer (int64) HTTP receive timeout, in milliseconds. Value must be greater than 0 (default: 1800000, 1800 seconds, 30 minutes). |
settings. httpSendTimeout |
integer (int64) HTTP send timeout, in milliseconds. Value must be greater than 0 (default: 1800000, 1800 seconds, 30 minutes). |
settings. enableHttpCompression |
boolean (boolean) Enables or disables data compression in HTTP responses. By default, ClickHouse stores data compressed. When executing a query, its result is uncompressed. Use this setting to command ClickHouse to compress the result when sending it via HTTP. Enable this setting and add the Accept-Encoding: ClickHouse support the following compression methods: gzip, br and deflate. Default value: false (compression is disabled). See in-depth description in ClickHouse documentation. |
settings. sendProgressInHttpHeaders |
boolean (boolean) Enables progress notifications using X-ClickHouse-Progress HTTP header. Default value: false (notifications disabled). |
settings. httpHeadersProgressInterval |
integer (int64) Minimum interval between progress notifications with X-ClickHouse-Progress HTTP header, in milliseconds. Value must be greater than 0 (default: 100). |
settings. addHttpCorsHeader |
boolean (boolean) Adds CORS header in HTTP responses. Default value: false (header is not added). |
settings. cancelHttpReadonlyQueriesOnClientClose |
boolean (boolean) Cancels HTTP read-only queries (e.g. SELECT) when a client closes the connection without waiting for the response. Default value: false. More info see in ClickHouse documentation. |
settings. maxHttpGetRedirects |
integer (int64) Limits the maximum number of HTTP GET redirect hops for URL-engine tables. If the parameter is set to 0 (default), no hops is allowed. More info see in ClickHouse documentation. |
settings. joinedSubqueryRequiresAlias |
boolean (boolean) |
settings. joinUseNulls |
boolean (boolean) |
settings. transformNullIn |
boolean (boolean) |
settings. quotaMode |
string Quota accounting mode. Possible values: QUOTA_MODE_DEFAULT, QUOTA_MODE_KEYED and QUOTA_MODE_KEYED_BY_IP. |
settings. flattenNested |
boolean (boolean) Sets the data format of a nested columns. More info see in ClickHouse documentation. |
settings. formatRegexp |
string Regular expression (for Regexp format) |
settings. formatRegexpEscapingRule |
string See in-depth description in ClickHouse documentation. |
settings. formatRegexpSkipUnmatched |
boolean (boolean) See in-depth description in ClickHouse documentation. |
settings. asyncInsert |
boolean (boolean) Enables asynchronous inserts. Disabled by default. More info see in ClickHouse documentation. |
settings. asyncInsertThreads |
integer (int64) The maximum number of threads for background data parsing and insertion. If the parameter is set to 0, asynchronous insertions are disabled. Default value: 16. More info see in ClickHouse documentation. |
settings. waitForAsyncInsert |
boolean (boolean) Enables waiting for processing of asynchronous insertion. If enabled, server returns OK only after the data is inserted. More info see in ClickHouse documentation. |
settings. waitForAsyncInsertTimeout |
integer (int64) The timeout (in seconds) for waiting for processing of asynchronous insertion. Default value: 120. More info see in ClickHouse documentation. |
settings. asyncInsertMaxDataSize |
integer (int64) The maximum size of the unparsed data in bytes collected per query before being inserted. If the parameter is set to 0, asynchronous insertions are disabled. Default value: 100000. More info see in ClickHouse documentation. |
settings. asyncInsertBusyTimeout |
integer (int64) The maximum timeout in milliseconds since the first INSERT query before inserting collected data. If the parameter is set to 0, the timeout is disabled. Default value: 200. More info see in ClickHouse documentation. |
settings. asyncInsertStaleTimeout |
integer (int64) The maximum timeout in milliseconds since the last INSERT query before dumping collected data. If enabled, the settings prolongs the More info see in ClickHouse documentation. |
settings. memoryProfilerStep |
integer (int64) Memory profiler step (in bytes). If the next query step requires more memory than this parameter specifies, the memory profiler collects the allocating stack trace. Values lower than a few megabytes slow down query processing. Default value: 4194304 (4 MB). Zero means disabled memory profiler. |
settings. memoryProfilerSampleProbability |
number (double) Collect random allocations and deallocations and write them into system.trace_log with 'MemorySample' trace_type. The probability is for every alloc/free regardless to the size of the allocation. Possible values: from 0 to 1. Default: 0. |
settings. maxFinalThreads |
integer (int64) Sets the maximum number of parallel threads for the SELECT query data read phase with the FINAL modifier. See in-depth description in ClickHouse documentation. The minimum value is 0. |
settings. inputFormatParallelParsing |
boolean (boolean) Enables or disables order-preserving parallel parsing of data formats. Supported only for TSV, TKSV, CSV and JSONEachRow formats. See in-depth description in ClickHouse documentation |
settings. inputFormatImportNestedJson |
boolean (boolean) Enables or disables the insertion of JSON data with nested objects. See in-depth description in ClickHouse documentation |
settings. localFilesystemReadMethod |
string Method of reading data from local filesystem, one of: read, pread, mmap, io_uring, pread_threadpool. The 'io_uring' method is experimental and does not work for Log, TinyLog, StripeLog, File, Set and Join, and other tables with append-able files in presence of concurrent reads and writes. |
settings. maxReadBufferSize |
integer (int64) The maximum size of the buffer to read from the filesystem. See in-depth description in ClickHouse documentation Value must be greater than 0. |
settings. insertKeeperMaxRetries |
integer (int64) The setting sets the maximum number of retries for ClickHouse Keeper (or ZooKeeper) requests during insert into replicated MergeTree. Only Keeper requests which failed due to network error, Keeper session timeout, or request timeout are considered for retries. Default: 20 from 23.2, 0(disabled) before Min_version: 22.11 See in-depth description in ClickHouse documentation The minimum value is 0. |
settings. maxTemporaryDataOnDiskSizeForUser |
integer (int64) The maximum amount of data consumed by temporary files on disk in bytes for all concurrently running user queries. Zero means unlimited. Default: 0 - unlimited Min_version: 22.10 See in-depth description in ClickHouse documentation The minimum value is 0. |
settings. maxTemporaryDataOnDiskSizeForQuery |
integer (int64) The maximum amount of data consumed by temporary files on disk in bytes for all concurrently running queries. Zero means unlimited. Default: 0 - unlimited Min_version: 22.10 See in-depth description in ClickHouse documentation The minimum value is 0. |
settings. maxParserDepth |
integer (int64) Limits maximum recursion depth in the recursive descent parser. Allows controlling the stack size. Default: 1000 Special: 0 - unlimited See in-depth description in ClickHouse documentation The minimum value is 0. |
settings. remoteFilesystemReadMethod |
string Method of reading data from remote filesystem, one of: read, threadpool. Default: read Min_version: 21.11 See in-depth description in ClickHouse GitHub |
settings. memoryOvercommitRatioDenominator |
integer (int64) It represents soft memory limit in case when hard limit is reached on user level. This value is used to compute overcommit ratio for the query. Zero means skip the query. Default: 1GiB Min_version: 22.5 See in-depth description in ClickHouse documentation The minimum value is 0. |
settings. memoryOvercommitRatioDenominatorForUser |
integer (int64) It represents soft memory limit in case when hard limit is reached on global level. This value is used to compute overcommit ratio for the query. Zero means skip the query. Default: 1GiB Min_version: 22.5 See in-depth description in ClickHouse documentation The minimum value is 0. |
settings. memoryUsageOvercommitMaxWaitMicroseconds |
integer (int64) Maximum time thread will wait for memory to be freed in the case of memory overcommit on a user level. If the timeout is reached and memory is not freed, an exception is thrown. Default: 5000000 Min_version: 22.5 See in-depth description in ClickHouse documentation The minimum value is 0. |
settings. compile |
boolean (boolean) The setting is deprecated and has no effect. |
settings. minCountToCompile |
integer (int64) The setting is deprecated and has no effect. |
quotas[] | object Set of quotas assigned to the user. |
quotas[]. intervalDuration |
integer (int64) Duration of interval for quota in milliseconds. Minimal value is 1 second. The minimum value is 1000. |
quotas[]. queries |
integer (int64) The total number of queries. 0 - unlimited. The minimum value is 0. |
quotas[]. errors |
integer (int64) The number of queries that threw exception. 0 - unlimited. The minimum value is 0. |
quotas[]. resultRows |
integer (int64) The total number of rows given as the result.. 0 - unlimited. The minimum value is 0. |
quotas[]. readRows |
integer (int64) The total number of source rows read from tables for running the query, on all remote servers. 0 - unlimited. The minimum value is 0. |
quotas[]. executionTime |
integer (int64) The total query execution time, in milliseconds (wall time). 0 - unlimited. The minimum value is 0. |
Methods
Method | Description |
---|---|
create | Creates a ClickHouse user in the specified cluster. |
delete | Deletes the specified ClickHouse user. |
get | Returns the specified ClickHouse User resource. |
grantPermission | Grants a permission to the specified ClickHouse user. |
list | Retrieves the list of ClickHouse User resources in the specified cluster. |
revokePermission | Revokes a permission from the specified ClickHouse user. |
update | Updates the specified ClickHouse user. |