distributed_cache_* session settings

These settings are available in system.settings and are autogenerated from source.

distributed_cache_alignment

Only has an effect in ClickHouse Cloud. A setting for testing purposes, do not change it

distributed_cache_bypass_connection_pool

Only has an effect in ClickHouse Cloud. Allow to bypass distributed cache connection pool

distributed_cache_client_id

Only has an effect in ClickHouse Cloud. A setting used only for CI tests - overrides the registry-configured distributed cache client id for this query’s requests when non-empty. Lets tests spread data across a bounded set of client ids while keeping the same data on the same client id. It requires ci_mode to be enabled in the distributed cache client config: when it is not (the default, as in production), a query that routes a read or write through the distributed cache fails with SUPPORT_IS_DISABLED instead of silently falling back to the configured client id. Queries that never reach the distributed cache are unaffected, so the value is ignored there.

distributed_cache_connect_backoff_max_ms

Only has an effect in ClickHouse Cloud. Maximum backoff milliseconds for distributed cache connection creation.

distributed_cache_connect_backoff_min_ms

Only has an effect in ClickHouse Cloud. Minimum backoff milliseconds for distributed cache connection creation.

distributed_cache_connect_max_tries

Only has an effect in ClickHouse Cloud. Number of tries to connect to distributed cache if unsuccessful

distributed_cache_connect_timeout_ms

Only has an effect in ClickHouse Cloud. Connection timeout when connecting to distributed cache server.

distributed_cache_credentials_refresh_period_seconds

Only has an effect in ClickHouse Cloud. A period of credentials refresh.

distributed_cache_data_packet_ack_window

Only has an effect in ClickHouse Cloud. A window for sending ACK for DataPacket sequence in a single distributed cache read request

distributed_cache_discard_connection_if_unread_data

Only has an effect in ClickHouse Cloud. Discard connection if some data is unread.

distributed_cache_fetch_metrics_only_from_current_az

Only has an effect in ClickHouse Cloud. Fetch metrics only from current availability zone in system.distributed_cache_metrics, system.distributed_cache_events

distributed_cache_file_cache_name

Only has an effect in ClickHouse Cloud. A setting used only for CI tests - filesystem cache name to use on distributed cache.

distributed_cache_log_mode

Only has an effect in ClickHouse Cloud. Mode for writing to system.distributed_cache_log

distributed_cache_max_unacked_inflight_packets

Only has an effect in ClickHouse Cloud. A maximum number of unacknowledged in-flight packets in a single distributed cache read request

distributed_cache_min_bytes_for_seek

Only has an effect in ClickHouse Cloud. Minimum number of bytes to do seek in distributed cache.

distributed_cache_min_inflight_bytes_to_discard_connection_on_seek

Only has an effect in ClickHouse Cloud. On a seek away from the current position of an open distributed cache stream, if the estimated number of in-flight bytes that would have to be discarded to keep reusing the connection (via the read range id mechanism) exceeds this value, drop the connection and open a new one instead. This avoids draining a large amount of unused data when seeks are frequent. 0 disables this and always reuses the connection.

distributed_cache_pool_behaviour_on_limit

Only has an effect in ClickHouse Cloud. Identifies behaviour of distributed cache connection on pool limit reached

distributed_cache_prefer_bigger_buffer_size

Only has an effect in ClickHouse Cloud. Same as filesystem_cache_prefer_bigger_buffer_size, but for distributed cache.

distributed_cache_read_only_from_current_az

Only has an effect in ClickHouse Cloud. Allow to read only from current availability zone. If disabled, will read from all cache servers in all availability zones.

distributed_cache_read_request_max_tries

Only has an effect in ClickHouse Cloud. Number of tries to do distributed cache read request if unsuccessful

distributed_cache_receive_response_wait_milliseconds

Only has an effect in ClickHouse Cloud. Wait time in milliseconds to receive data for request from distributed cache

distributed_cache_receive_timeout_milliseconds

Only has an effect in ClickHouse Cloud. Wait time in milliseconds to receive any kind of response from distributed cache

Cloud default value: 20000.

distributed_cache_receive_timeout_ms

Only has an effect in ClickHouse Cloud. Timeout for receiving data from distributed cache server, in milliseconds. If no bytes were received in this interval, the exception is thrown.

distributed_cache_registry_show_certificate_and_signature

Only has an effect in ClickHouse Cloud. Show the certificate and signature columns in the system.distributed_cache_registry table. By default these columns are empty to keep the output compact; enable this setting to inspect them.

distributed_cache_send_timeout_ms

Only has an effect in ClickHouse Cloud. Timeout for sending data to istributed cache server, in milliseconds. If a client needs to send some data but is not able to send any bytes in this interval, the exception is thrown.

distributed_cache_tcp_keep_alive_timeout_ms

Only has an effect in ClickHouse Cloud. The time in milliseconds the connection to distributed cache server needs to remain idle before TCP starts sending keepalive probes.

distributed_cache_throw_on_error

Only has an effect in ClickHouse Cloud. Rethrow exception happened during communication with distributed cache or exception received from distributed cache. Otherwise fallback to skipping distributed cache on error

distributed_cache_use_clients_cache_for_read

Only has an effect in ClickHouse Cloud. Use clients cache for read requests.

distributed_cache_wait_connection_from_pool_milliseconds

Only has an effect in ClickHouse Cloud. Wait time in milliseconds to receive connection from connection pool if distributed_cache_pool_behaviour_on_limit is wait

distributed_cache_write_request_max_tries

Only has an effect in ClickHouse Cloud. Number of tries to do distributed cache write request if unsuccessful