Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

distributed_plan_* session settings

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

distributed_plan_default_reader_bucket_count

Experimental feature
Type
NonZeroUInt64
Default
8
Version history
VersionDefault valueComment
25.58New experimental setting.

Default number of tasks for parallel reading in distributed query. Tasks are spread across between replicas. Used by the rule-based distributed planner. The cost-based optimizer chooses the read fan-out by estimated cost and does not use this setting.

distributed_plan_default_shuffle_join_bucket_count

Experimental feature
Type
NonZeroUInt64
Default
8
Version history
VersionDefault valueComment
25.58New experimental setting.

Default number of buckets for distributed shuffle-hash-join. Used by the rule-based distributed planner. The cost-based optimizer chooses the fan-out by estimated cost and does not use this setting.

distributed_plan_execute_locally

Experimental feature
Type
Bool
Default
0
Version history
VersionDefault valueComment
25.50New experimental setting.

Run all tasks of a distributed query plan locally. Useful for testing and debugging.

distributed_plan_force_exchange_kind

Experimental feature
Version history
VersionDefault valueComment
25.5New experimental setting.

Force specified kind of Exchange operators between distributed query stages.

Possible values:

  • ‘’ - do not force any kind of Exchange operators, let the optimizer choose,
  • ‘Persisted’ - use temporary files in object storage,
  • ‘Streaming’ - stream exchange data over network.

distributed_plan_force_shuffle_aggregation

Experimental feature
Type
Bool
Default
0
Version history
VersionDefault valueComment
25.70New experimental setting

Use Shuffle aggregation strategy instead of PartialAggregation + Merge in distributed query plan.

distributed_plan_max_rows_to_broadcast

Experimental feature
Type
UInt64
Default
20000
Version history
VersionDefault valueComment
25.720000New experimental setting.

Maximum rows to use broadcast join instead of shuffle join in distributed query plan. A heuristic for the rule-based distributed planner. When the cost-based optimizer is enabled, the broadcast-vs-shuffle choice is made by estimated cost and this setting has no effect.

distributed_plan_optimize_exchanges

Type
Bool
Default
1
Version history
VersionDefault valueComment
25.51New experimental setting.

Removes unnecessary exchanges in distributed query plan. Disable it for debugging.

distributed_plan_prefer_replicas_over_workers

Experimental feature
Type
Bool
Default
0
Version history
VersionDefault valueComment
26.40New setting to serialize distributed plan for replicas

Serialize the distributed query plan for execution at replicas.

distributed_plan_workers_num

Experimental feature
Type
UInt64
Default
0
Version history
VersionDefault valueComment
26.60New experimental setting for how many stateless workers to lease for a distributed query. Zero disables leasing.

How many stateless workers will be used to execute this query. Zero disables stateless-worker leasing for distributed plans.

distributed_plan_workers_provisioning_timeout_ms

Experimental feature
Type
UInt64
Default
10000
Version history
VersionDefault valueComment
26.910000New setting bounding how long a query waits for leased stateless workers to become reachable before execution; `compatibility` below 26.9 restores the previous no-wait behavior.

Total wall-clock time, in milliseconds, a query may spend provisioning stateless workers before execution: leasing them from the discovery service and verifying they are reachable. The query blocks up to this budget for the leased workers to become ready; when it elapses the query proceeds with the workers verified so far, or fails if none became available. Zero waits only for the initial lease-and-verify pass (no retries).

Navigation