Kvindo™ Cloud Docs


Language

ClickHouse User

A ClickHouse User is an authenticated tenant identity inside a ClickHouse cluster. The user is created across all nodes with password authentication, specific database-level grants, and tailored user settings profiles.

Key concepts

• Cluster-bound — a user belongs exclusively to its parent ClickHouse cluster

• Database grants — permissions (ReadOnly or ReadWrite) on specific ClickHouseDatabase resources of the same cluster, referenced by databaseId

• User settings profile — validated against the ClickHouse user settings catalog (e.g. max_memory_usage, max_execution_time, readonly)

Parameters
UI Name API / kc name Terraform name Optional Format Default Is read only Description
ClickHouse cluster spec.clickHouseId spec.clickhouse_id No ULID — references a ClickHouse — No Parent ClickHouse cluster
Password spec.password spec.password Yes string — No Password for authentication (write-only)
Enabled spec.enabled spec.enabled Yes boolean true No Whether the user account is active
Database grants spec.databaseGrants spec.database_grants Yes list of objects — No List of database-level permission grants
Database databaseGrants[].databaseId database_grants[].database_id No ULID — references a ClickHouseDatabase of the same cluster — No Target database
Role databaseGrants[].role database_grants[].role No string ReadWrite No ReadOnly or ReadWrite
Settings spec.settings spec.settings Yes map of string to string — No User settings profile knobs allow-listed by the catalog

Related pages

Resource docs

Examples

More in this section

An unhandled error has occurred. Reload 🗙