Get started
Log in
Yandex Managed Service for ClickHouse

User

A set of methods for managing ClickHouse User resources.

JSON Representation

{
  "name": "string",
  "clusterId": "string",
  "permissions": [
    {
      "databaseName": "string",
      "dataFilters": [
        {
          "tableName": "string",
          "filter": "string"
        }
      ]
    }
  ],
  "settings": {
    "readonly": "integer",
    "allowDdl": true,
    "insertQuorum": "integer",
    "connectTimeout": "integer",
    "receiveTimeout": "integer",
    "sendTimeout": "integer",
    "insertQuorumTimeout": "integer",
    "selectSequentialConsistency": true,
    "maxReplicaDelayForDistributedQueries": "integer",
    "fallbackToStaleReplicasForDistributedQueries": true,
    "replicationAlterPartitionsSync": "integer",
    "distributedProductMode": "string",
    "distributedAggregationMemoryEfficient": true,
    "distributedDdlTaskTimeout": "integer",
    "compile": true,
    "minCountToCompile": "integer",
    "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",
    "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",
    "maxColumnsToRead": "integer",
    "maxTemporaryColumns": "integer",
    "maxTemporaryNonConstColumns": "integer",
    "maxQuerySize": "integer",
    "maxAstDepth": "integer",
    "maxAstElements": "integer",
    "maxExpandedAstElements": "integer",
    "inputFormatValuesInterpretExpressions": true,
    "inputFormatDefaultsForOmittedFields": true,
    "outputFormatJsonQuote_64BitIntegers": true,
    "outputFormatJsonQuoteDenormals": true,
    "lowCardinalityAllowInNativeFormat": true,
    "emptyResultForAggregationByEmptySet": true,
    "httpConnectionTimeout": "integer",
    "httpReceiveTimeout": "integer",
    "httpSendTimeout": "integer",
    "enableHttpCompression": true,
    "sendProgressInHttpHeaders": true,
    "httpHeadersProgressInterval": "integer",
    "addHttpCorsHeader": true
  },
  "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.
permissions[].
dataFilters[]		 object
permissions[].
dataFilters[].
tableName		 string
permissions[].
dataFilters[].
filter		 string
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. Possible values:

  • 0 (default) — no restrictions.
  • 1 — only read data queries are allowed.
  • 2 — read data and change settings queries are allowed. See in-depth description in ClickHouse documentation.

Acceptable values are 0 to 2, inclusive.
settings.
allowDdl		 boolean (boolean)

Whether DDL queries are allowed. Default value: false. See in-depth description in ClickHouse documentation.
settings.
insertQuorum		 integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.
settings.
connectTimeout		 integer (int64)

Connection timeout in milliseconds. See in-depth description in ClickHouse documentation.

Value must be greater than 0.
settings.
receiveTimeout		 integer (int64)

Receive timeout in milliseconds. See in-depth description in ClickHouse documentation.

Value must be greater than 0.
settings.
sendTimeout		 integer (int64)

Send timeout in milliseconds. See in-depth description in ClickHouse documentation.

Value must be greater than 0.
settings.
insertQuorumTimeout		 integer (int64)

Quorum write timeout in milliseconds. Default value: 60000. See in-depth description in ClickHouse documentation.

The minimum value is 1000.
settings.
selectSequentialConsistency		 boolean (boolean)

See in-depth description in ClickHouse documentation.
settings.
maxReplicaDelayForDistributedQueries		 integer (int64)

Max replica delay in milliseconds. If a replica lags more than the set value, this replica is not used. Default value: 300000. See in-depth description in ClickHouse documentation.

The minimum value is 1000.
settings.
fallbackToStaleReplicasForDistributedQueries		 boolean (boolean)

See in-depth description in ClickHouse documentation.
settings.
replicationAlterPartitionsSync		 integer (int64)

See in-depth description in ClickHouse documentation.

Acceptable values are 0 to 2, inclusive.
settings.
distributedProductMode		 string

See in-depth description in ClickHouse documentation.
settings.
distributedAggregationMemoryEfficient		 boolean (boolean)

Whether the memory-saving mode of distributed aggregation is enabled.
settings.
distributedDdlTaskTimeout		 integer (int64)

Timeout for DDL queries, in milliseconds.
settings.
compile		 boolean (boolean)

Whether query compilation is enabled. See in-depth description in ClickHouse documentation.
settings.
minCountToCompile		 integer (int64)

The number of structurally identical queries before they are compiled. See in-depth description in ClickHouse documentation.

The minimum value is 0.
settings.
compileExpressions		 boolean (boolean)

Whether expression compilation is enabled.
settings.
minCountToCompileExpression		 integer (int64)

The number of identical expressions before they are compiled.

The minimum value is 0.
settings.
maxBlockSize		 integer (int64)

See in-depth description in ClickHouse documentation.

Value must be greater than 0.
settings.
minInsertBlockSizeRows		 integer (int64)

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.
settings.
minInsertBlockSizeBytes		 integer (int64)

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.
settings.
maxInsertBlockSize		 integer (int64)

See in-depth description in ClickHouse documentation.

Value must be greater than 0.
settings.
minBytesToUseDirectIo		 integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.
settings.
useUncompressedCache		 boolean (boolean)

See in-depth description in ClickHouse documentation.
settings.
mergeTreeMaxRowsToUseCache		 integer (int64)

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. See in-depth description in ClickHouse documentation.

Value must be greater than 0.
settings.
mergeTreeMaxBytesToUseCache		 integer (int64)

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.
settings.
mergeTreeMinRowsForConcurrentRead		 integer (int64)

The minimum number of rows to be read from a file to enable concurrent read. See in-depth description in ClickHouse documentation.

Value must be greater than 0.
settings.
mergeTreeMinBytesForConcurrentRead		 integer (int64)

The minimum number of bytes to be read from a file to enable concurrent read.

Value must be greater than 0.
settings.
maxBytesBeforeExternalGroupBy		 integer (int64)
settings.
maxBytesBeforeExternalSort		 integer (int64)
settings.
groupByTwoLevelThreshold		 integer (int64)
settings.
groupByTwoLevelThresholdBytes		 integer (int64)
settings.
priority		 integer (int64)

Priority of the query.

The minimum value is 0.
settings.
maxThreads		 integer (int64)

See in-depth description in ClickHouse documentation.

Value must be greater than 0.
settings.
maxMemoryUsage		 integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.
settings.
maxMemoryUsageForUser		 integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.
settings.
maxNetworkBandwidth		 integer (int64)

See in-depth description in ClickHouse documentation.
settings.
maxNetworkBandwidthForUser		 integer (int64)

See in-depth description in ClickHouse documentation.
settings.
forceIndexByDate		 boolean (boolean)

See in-depth description in ClickHouse documentation.
settings.
forcePrimaryKey		 boolean (boolean)

See in-depth description in ClickHouse documentation.
settings.
maxRowsToRead		 integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.
settings.
maxBytesToRead		 integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.
settings.
readOverflowMode		 string

See in-depth description in ClickHouse documentation.
settings.
maxRowsToGroupBy		 integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.
settings.
groupByOverflowMode		 string

See in-depth description in ClickHouse documentation.
settings.
maxRowsToSort		 integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.
settings.
maxBytesToSort		 integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.
settings.
sortOverflowMode		 string

See in-depth description in ClickHouse documentation.
settings.
maxResultRows		 integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.
settings.
maxResultBytes		 integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.
settings.
resultOverflowMode		 string

See in-depth description in ClickHouse documentation.
settings.
maxRowsInDistinct		 integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.
settings.
maxBytesInDistinct		 integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.
settings.
distinctOverflowMode		 string

See in-depth description in ClickHouse documentation.
settings.
maxRowsToTransfer		 integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.
settings.
maxBytesToTransfer		 integer (int64)

See in-depth description in ClickHouse documentation.

The minimum value is 0.
settings.
transferOverflowMode		 string

See in-depth description in ClickHouse documentation.
settings.
maxExecutionTime		 integer (int64)

Maximum query execution time in milliseconds. See in-depth description in ClickHouse documentation.

The minimum value is 0.
settings.
timeoutOverflowMode		 string

See in-depth description in ClickHouse documentation.
settings.
maxColumnsToRead		 integer (int64)

Maximum number of columns that can be read from a table in a single query. See in-depth description in ClickHouse documentation.

The minimum value is 0.
settings.
maxTemporaryColumns		 integer (int64)

Maximum number of temporary columns that must be kept in RAM at the same time when running a query, including constant columns. See in-depth description in ClickHouse documentation.

The minimum value is 0.
settings.
maxTemporaryNonConstColumns		 integer (int64)

Maximum number of temporary columns that must be kept in RAM at the same time when running a query, excluding constant columns. See in-depth description in ClickHouse documentation.

The minimum value is 0.
settings.
maxQuerySize		 integer (int64)

The maximum part of a query that can be taken to RAM for parsing with the SQL parser, in bytes. Default value: 262144. See in-depth description in ClickHouse documentation.

Value must be greater than 0.
settings.
maxAstDepth		 integer (int64)

Maximum depth of query syntax tree. Default value: 1000. See in-depth description in ClickHouse documentation.

Value must be greater than 0.
settings.
maxAstElements		 integer (int64)

Maximum size of query syntax tree in number of nodes. Default value: 50000. See in-depth description in ClickHouse documentation.

Value must be greater than 0.
settings.
maxExpandedAstElements		 integer (int64)

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.
settings.
inputFormatValuesInterpretExpressions		 boolean (boolean)

See in-depth description in ClickHouse documentation.
settings.
inputFormatDefaultsForOmittedFields		 boolean (boolean)

See in-depth description in ClickHouse documentation.
settings.
outputFormatJsonQuote_64BitIntegers		 boolean (boolean)

Whether quoting of 64-bit integers is enabled in JSON output format. See in-depth description in ClickHouse documentation.
settings.
outputFormatJsonQuoteDenormals		 boolean (boolean)

Whether output of special floating-point values (+nan, -nan, +inf and -inf) is enabled in JSON output format.
settings.
lowCardinalityAllowInNativeFormat		 boolean (boolean)
settings.
emptyResultForAggregationByEmptySet		 boolean (boolean)
settings.
httpConnectionTimeout		 integer (int64)

HTTP connection timeout, in milliseconds.
settings.
httpReceiveTimeout		 integer (int64)

HTTP receive timeout, in milliseconds.
settings.
httpSendTimeout		 integer (int64)

HTTP send timeout, in milliseconds.
settings.
enableHttpCompression		 boolean (boolean)

See in-depth description in ClickHouse documentation.
settings.
sendProgressInHttpHeaders		 boolean (boolean)

Whether progress notifications using X-ClickHouse-Progress headers are enabled. Default value: false. See in-depth description in ClickHouse documentation.
settings.
httpHeadersProgressInterval		 integer (int64)

Minimum interval between progress notifications, in milliseconds. Default value: 100.
settings.
addHttpCorsHeader		 boolean (boolean)

Whether CORS header in HTTP responses is enabled. Default value: false.
quotas[] object

ClickHouse quota representation. Each quota associated with an user and limits it resource usage for an interval. See in-depth description ClickHouse documentation.
quotas[].
intervalDuration		 integer (int64)

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

The minimum value is 60000.
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.