yandex_mdb_clickhouse_user (Data Source)

Manages a ClickHouse user within the Yandex.Cloud. For more information, see the official documentation.

Example usageExample usage

data "yandex_mdb_clickhouse_user" "foo" {
  cluster_id = "some_cluster_id"
  name       = "username"
  password   = "your_password"
}

output "permissions" {
  value = data.yandex_mdb_clickhouse_user.permission
}

SchemaSchema

RequiredRequired

• cluster_id (String) ID of the ClickHouse cluster. Provided by the client when the user is created.
• name (String) Name of the ClickHouse user. Provided by the client when the user is created.

OptionalOptional

• quota (Block Set) (see below for nested schema)
• settings (Block, Optional) (see below for nested schema)

Read-OnlyRead-Only

• connection_manager (Attributes) Connection Manager connection configuration. Filled in by the server automatically. (see below for nested schema)
• id (String) The resource identifier.
• password (String, Sensitive) Password of the ClickHouse user. Provided by the client when the user is created.
• permission (Block Set) (see below for nested schema)

Nested Schema for Nested Schema for quota

Optional:

• errors (Number) The number of queries that threw exception. 0 - unlimited.

• execution_time (Number) The total query execution time, in milliseconds (wall time). 0 - unlimited.

• queries (Number) The total number of queries. 0 - unlimited.

• read_rows (Number) The total number of source rows read from tables for running the query, on all remote servers. 0 - unlimited.

• result_rows (Number) The total number of rows given as the result. 0 - unlimited.

Read-Only:

• interval_duration (Number) Duration of interval for quota in milliseconds.

Nested Schema for Nested Schema for settings

Optional:

• add_http_cors_header (Boolean) Include CORS headers in HTTP response.

• allow_ddl (Boolean) Allows or denies DDL queries.

• allow_introspection_functions (Boolean) Enables or disables introspection functions for query profiling.

• allow_suspicious_low_cardinality_types (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.

• any_join_distinct_right_table_keys (Boolean) Enables legacy ClickHouse server behaviour in ANY INNER|LEFT JOIN operations.

• async_insert (Boolean) Enables asynchronous inserts. Disabled by default.

• async_insert_busy_timeout (Number) 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.

• async_insert_max_data_size (Number) 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.

• async_insert_stale_timeout (Number) The maximum timeout in milliseconds since the last INSERT query before dumping collected data. If enabled, the settings prolongs the async_insert_busy_timeout with every INSERT query as long as async_insert_max_data_size is not exceeded.

• async_insert_threads (Number) 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.

• cancel_http_readonly_queries_on_client_close (Boolean) Cancels HTTP read-only queries (e.g. SELECT) when a client closes the connection without waiting for the response. Default value: false.

• compile_expressions (Boolean) Enable or disable compilation of some scalar functions and operators to native code.

• connect_timeout (Number) Connection timeout in milliseconds.

• connect_timeout_with_failover (Number) 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.

• count_distinct_implementation (String) Specifies which of the uniq* functions should be used to perform the COUNT(DISTINCT …) construction.

• date_time_input_format (String) Allows choosing a parser of the text representation of date and time, one of: best_effort, basic, best_effort_us. Default value: basic. Cloud default value: best_effort.

• date_time_output_format (String) Allows choosing different output formats of the text representation of date and time, one of: simple, iso, unix_timestamp. Default value: simple.

• deduplicate_blocks_in_dependent_materialized_views (Boolean) Enables or disables the deduplication check for materialized views that receive data from Replicated* tables.

• distinct_overflow_mode (String) Sets behaviour on overflow when using DISTINCT.

• distributed_aggregation_memory_efficient (Boolean) Enables of disables memory saving mode when doing distributed aggregation.

• distributed_ddl_task_timeout (Number) Timeout for DDL queries, in milliseconds.

• distributed_product_mode (String) Determine the behavior of distributed subqueries.

• empty_result_for_aggregation_by_empty_set (Boolean) Allows to retunr empty result.

• enable_http_compression (Boolean) Enables or disables data compression in the response to an HTTP request.

• fallback_to_stale_replicas_for_distributed_queries (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.

• flatten_nested (Boolean) Sets the data format of a nested columns.

• force_index_by_date (Boolean) Disable query execution if the index cannot be used by date.

• force_primary_key (Boolean) Disable query execution if indexing by the primary key is not possible.

• format_regexp (String) Regular expression (for Regexp format).

• format_regexp_skip_unmatched (Boolean) Skip lines unmatched by regular expression.

• group_by_overflow_mode (String) Sets behaviour on overflow while GROUP BY operation.

• group_by_two_level_threshold (Number) Sets the threshold of the number of keys, after that the two-level aggregation should be used.

• group_by_two_level_threshold_bytes (Number) Sets the threshold of the number of bytes, after that the two-level aggregation should be used.

• hedged_connection_timeout_ms (Number) Connection timeout for establishing connection with replica for Hedged requests. Default value: 50 milliseconds.

• http_connection_timeout (Number) Timeout for HTTP connection in milliseconds.

• http_headers_progress_interval (Number) Sets minimal interval between notifications about request process in HTTP header X-ClickHouse-Progress.

• http_receive_timeout (Number) Timeout for HTTP connection in milliseconds.

• http_send_timeout (Number) Timeout for HTTP connection in milliseconds.

• idle_connection_timeout (Number) Timeout to close idle TCP connections after specified number of seconds. Default value: 3600 seconds.

• input_format_defaults_for_omitted_fields (Boolean) When performing INSERT queries, replace omitted input column values with default values of the respective columns.

• input_format_import_nested_json (Boolean) Enables or disables the insertion of JSON data with nested objects.

• input_format_null_as_default (Boolean) Enables or disables the initialization of NULL fields with default values, if data type of these fields is not nullable.

• input_format_parallel_parsing (Boolean) Enables or disables order-preserving parallel parsing of data formats. Supported only for TSV, TKSV, CSV and JSONEachRow formats.

• input_format_values_interpret_expressions (Boolean) Enables or disables the full SQL parser if the fast stream parser can’t parse the data.

• input_format_with_names_use_header (Boolean) Enables or disables checking the column order when inserting data.

• insert_keeper_max_retries (Number) 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.

• insert_null_as_default (Boolean) Enables the insertion of default values instead of NULL into columns with not nullable data type. Default value: true.

• insert_quorum (Number) Enables the quorum writes.

• insert_quorum_parallel (Boolean) Enables or disables parallelism for quorum INSERT queries.

• insert_quorum_timeout (Number) Quorum write timeout in milliseconds.

• join_algorithm (Set of String) Specifies which JOIN algorithm to use.

• join_overflow_mode (String) Sets behaviour on overflow in JOIN.

• join_use_nulls (Boolean) Sets the type of JOIN behaviour. When merging tables, empty cells may appear. ClickHouse fills them differently based on this setting.

• joined_subquery_requires_alias (Boolean) Require aliases for subselects and table functions in FROM that more than one table is present.

• load_balancing (String) Specifies the algorithm of replicas selection that is used for distributed query processing, one of: random, nearest_hostname, in_order, first_or_random, round_robin. Default value: random.

• local_filesystem_read_method (String) Method of reading data from local filesystem. Possible values:

• log_query_threads (Boolean) Setting up query threads logging. Query threads log into the system.query_thread_log table. This setting has effect only when log_queries is true. Queries’ threads run by ClickHouse with this setup are logged according to the rules in the query_thread_log server configuration parameter. Default value: true.

• low_cardinality_allow_in_native_format (Boolean) Allows or restricts using the LowCardinality data type with the Native format.

• max_ast_depth (Number) Limits the maximum depth of query syntax tree.

• max_ast_elements (Number) Limits the maximum size of query syntax tree in number of nodes.

• max_block_size (Number) A recommendation for what size of the block (in a count of rows) to load from tables.

• max_bytes_before_external_group_by (Number) Limit in bytes for using memoru for GROUP BY before using swap on disk.

• max_bytes_before_external_sort (Number) This setting is equivalent of the max_bytes_before_external_group_by setting, except for it is for sort operation (ORDER BY), not aggregation.

• max_bytes_in_distinct (Number) Limits the maximum size of a hash table in bytes (uncompressed data) when using DISTINCT.

• max_bytes_in_join (Number) Limit on maximum size of the hash table for JOIN, in bytes.

• max_bytes_in_set (Number) Limit on the number of bytes in the set resulting from the execution of the IN section.

• max_bytes_to_read (Number) Limits the maximum number of bytes (uncompressed data) that can be read from a table when running a query.

• max_bytes_to_sort (Number) Limits the maximum number of bytes (uncompressed data) that can be read from a table for sorting.

• max_bytes_to_transfer (Number) 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.

• max_columns_to_read (Number) Limits the maximum number of columns that can be read from a table in a single query.

• max_concurrent_queries_for_user (Number) The maximum number of concurrent requests per user. Default value: 0 (no limit).

• max_execution_time (Number) Limits the maximum query execution time in milliseconds.

• max_expanded_ast_elements (Number) Limits the maximum size of query syntax tree in number of nodes after expansion of aliases and the asterisk values.

• max_final_threads (Number) Sets the maximum number of parallel threads for the SELECT query data read phase with the FINAL modifier.

• max_http_get_redirects (Number) Limits the maximum number of HTTP GET redirect hops for URL-engine tables.

• max_insert_block_size (Number) The size of blocks (in a count of rows) to form for insertion into a table.

• max_insert_threads (Number) The maximum number of threads to execute the INSERT SELECT query. Default value: 0.

• max_memory_usage (Number) Maximum memory usage for processing all concurrently running queries for the user. Zero means unlimited.

• max_memory_usage_for_user (Number) Maximum memory usage for processing all concurrently running queries for the user. Zero means unlimited.

• max_network_bandwidth (Number) Limits the speed of the data exchange over the network in bytes per second. This setting applies to every query.

• max_network_bandwidth_for_user (Number) Limits the speed of the data exchange over the network in bytes per second. This setting applies to all concurrently running queries performed by a single user.

• max_parser_depth (Number) Limits maximum recursion depth in the recursive descent parser. Allows controlling the stack size.

• max_partitions_per_insert_block (Number) Limits the maximum number of partitions in a single inserted block.

• max_query_size (Number) The maximum part of a query that can be taken to RAM for parsing with the SQL parser.

• max_read_buffer_size (Number) The maximum size of the buffer to read from the filesystem.

• max_replica_delay_for_distributed_queries (Number) Max replica delay in milliseconds. If a replica lags more than the set value,this replica is not used and becomes a stale one.

• max_result_bytes (Number) Limits the number of bytes in the result.

• max_result_rows (Number) Limits the number of rows in the result.

• max_rows_in_distinct (Number) Limits the maximum number of different rows when using DISTINCT.

• max_rows_in_join (Number) Limit on maximum size of the hash table for JOIN, in rows.

• max_rows_in_set (Number) Limit on the number of rows in the set resulting from the execution of the IN section.

• max_rows_to_group_by (Number) Limits the maximum number of unique keys received from aggregation function.

• max_rows_to_read (Number) Limits the maximum number of rows that can be read from a table when running a query.

• max_rows_to_sort (Number) Limits the maximum number of rows that can be read from a table for sorting.

• max_rows_to_transfer (Number) Limits the maximum number of rows that can be passed to a remote server or saved in a temporary table when using GLOBAL IN.

• max_temporary_columns (Number) Limits the maximum number of temporary columns that must be kept in RAM at the same time when running a query, including constant columns.

• max_temporary_data_on_disk_size_for_query (Number) The maximum amount of data consumed by temporary files on disk in bytes for all concurrently running queries. Zero means unlimited.

• max_temporary_data_on_disk_size_for_user (Number) The maximum amount of data consumed by temporary files on disk in bytes for all concurrently running user queries. Zero means unlimited.

• max_temporary_non_const_columns (Number) Limits the maximum number of temporary columns that must be kept in RAM at the same time when running a query, excluding constant columns.

• max_threads (Number) The maximum number of query processing threads, excluding threads for retrieving data from remote servers.

• memory_overcommit_ratio_denominator (Number) 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.

• memory_overcommit_ratio_denominator_for_user (Number) 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.

• memory_profiler_sample_probability (Number) 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.

• memory_profiler_step (Number) 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.

• memory_usage_overcommit_max_wait_microseconds (Number) 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.

• merge_tree_max_bytes_to_use_cache (Number) If ClickHouse should read more than merge_tree_max_bytes_to_use_cache bytes in one query, it doesn’t use the cache of uncompressed blocks.

• merge_tree_max_rows_to_use_cache (Number) If ClickHouse should read more than merge_tree_max_rows_to_use_cache rows in one query, it doesn’t use the cache of uncompressed blocks.

• merge_tree_min_bytes_for_concurrent_read (Number) If the number of bytes to read from one file of a MergeTree-engine table exceeds merge_tree_min_bytes_for_concurrent_read, then ClickHouse tries to concurrently read from this file in several threads.

• merge_tree_min_rows_for_concurrent_read (Number) If the number of rows to be read from a file of a MergeTree table exceeds merge_tree_min_rows_for_concurrent_read then ClickHouse tries to perform a concurrent reading from this file on several threads.

• min_bytes_to_use_direct_io (Number) The minimum data volume required for using direct I/O access to the storage disk.

• min_count_to_compile_expression (Number) Minimum count of executing same expression before it is get compiled.

• min_execution_speed (Number) Minimal execution speed in rows per second.

• min_execution_speed_bytes (Number) Minimal execution speed in bytes per second.

• min_insert_block_size_bytes (Number) Sets the minimum number of bytes in the block which can be inserted into a table by an INSERT query.

• min_insert_block_size_rows (Number) Sets the minimum number of rows in the block which can be inserted into a table by an INSERT query.

• output_format_json_quote_64bit_integers (Boolean) If the value is true, integers appear in quotes when using JSON* Int64 and UInt64 formats (for compatibility with most JavaScript implementations); otherwise, integers are output without the quotes.

• output_format_json_quote_denormals (Boolean) Enables +nan, -nan, +inf, -inf outputs in JSON output format.

• prefer_localhost_replica (Boolean) Enables/disables preferable using the localhost replica when processing distributed queries. Default value: true.

• priority (Number) Priority of the query.

• quota_mode (String) Quota accounting mode.

• read_overflow_mode (String) Sets behaviour on overflow while read. Possible values: * throw - abort query execution, return an error. * break - stop query execution, return partial result.

• readonly (Number) Restricts permissions for non-DDL queries.

• receive_timeout (Number) Receive timeout in milliseconds.

• remote_filesystem_read_method (String) Method of reading data from remote filesystem, one of: read, threadpool.

• replication_alter_partitions_sync (Number) Wait mode for asynchronous actions in ALTER queries on replicated tables.

• result_overflow_mode (String) Sets behaviour on overflow in result.

• select_sequential_consistency (Boolean) Determines the behavior of SELECT queries from replicated tables. 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.

• send_progress_in_http_headers (Boolean) Enables or disables X-ClickHouse-Progress HTTP response headers in clickhouse-server responses.

• send_timeout (Number) Send timeout in milliseconds.

• set_overflow_mode (String) Sets behaviour on overflow in the set resulting.

• skip_unavailable_shards (Boolean) Enables or disables silent skipping of unavailable shards

• sort_overflow_mode (String) Sets behaviour on overflow while sort.

• timeout_before_checking_execution_speed (Number) Timeout (in seconds) between checks of execution speed. It is checked that execution speed is not less that specified in min_execution_speed parameter. Must be at least 1000.

• timeout_overflow_mode (String) Sets behaviour on overflow.

• transfer_overflow_mode (String) Sets behaviour on overflow.

• transform_null_in (Boolean) Enables equality of NULL values for IN operator.

• use_hedged_requests (Boolean) Enables hedged requests logic for remote queries. It allows to establish many connections with different replicas for query. New connection is enabled in case existent connection(s) with replica(s) were not established within hedged_connection_timeout or no data was received within receive_data_timeout. Query uses the first connection which send non empty progress packet (or data packet, if allow_changing_replica_until_first_data_packet); other connections are cancelled. Queries with max_parallel_replicas > 1 are supported. Default value: true.

• use_uncompressed_cache (Boolean) Whether to use a cache of uncompressed blocks.

• wait_for_async_insert (Boolean) Enables waiting for processing of asynchronous insertion. If enabled, server returns OK only after the data is inserted.

• wait_for_async_insert_timeout (Number) The timeout (in seconds) for waiting for processing of asynchronous insertion. Value must be at least 1000 (1 second).

Nested Schema for Nested Schema for connection_manager

Read-Only:

• connection_id (String) ID of Connection Manager connection. Filled in by the server automatically. String. ID of Connection Manager connection. Filled in by the server automatically. String.

Nested Schema for Nested Schema for permission

Read-Only:

• database_name (String) Name of the database that the permission grants access to.

ImportImport

The resource can be imported by using their resource ID. For getting the resource ID you can use Yandex Cloud Web Console or YC CLI.

# terraform import yandex_mdb_clickhouse_user.<resource Name> <cluster_id>:<user_name>
terraform import yandex_mdb_clickhouse_user.my_user cluster_id:my_username