Skip to content

Docs: note that default_replica_* settings of Replicated database require 25.10 - #125739

Merged
Blargian merged 4 commits into
ClickHouse:masterfrom
Shahzeb-DataEngineer:docs/replicated-default-replica-settings-note
Oct 14, 2026
Merged

Blargian merged 4 commits into
ClickHouse:masterfrom
Shahzeb-DataEngineer:docs/replicated-default-replica-settings-note

Conversation

@Shahzeb-DataEngineer

@Shahzeb-DataEngineer Shahzeb-DataEngineer commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Description

The default_replica_path, default_replica_shard_name and default_replica_name settings of the Replicated database engine were introduced in ClickHouse 25.10, but the reference page lists them without any version context. Users on earlier versions (e.g. 25.8, 25.9) try to configure them and hit Code: 115. DB::Exception: Unknown setting '<name>': in DatabaseReplicated config. This adds a short version note to the Settings section of the Replicated database engine documentation so the supported version is explicit.

The note is added to the DOCS_MD block in src/Databases/DatabaseReplicated.cpp (the source of truth for this autogenerated page); the .mdx regeneration is left to the docs workflow per docs/reference/AGENTS.md.

Changelog category (leave one):

  • Documentation (changelog entry is not required)

Changelog entry (a user-readable short description of the changes that goes into CHANGELOG.md):

...

Related Issue

closes #89031


Workflow [PR]
Sync PR [sync-upstream/pr/125739]

Version info

  • Merged into: 26.10.1.2395-master (included in 26.10 and later)

…uire 25.10

The `default_replica_path`, `default_replica_shard_name` and
`default_replica_name` settings were introduced in ClickHouse 25.10.
On earlier versions (e.g. 25.8, 25.9) configuring them fails with
Code: 115 UNKNOWN_SETTING in DatabaseReplicated config, which confused
users reading the reference page. Add a version note to the Settings
section of the Replicated database engine documentation.

Signed-off-by: Shahzeb Ali <[email protected]>
Copilot AI balanced review requested due to automatic review settings October 14, 2026 04:50

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@CLAassistant

CLAassistant commented Oct 14, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@clickhouse-gh clickhouse-gh Bot added the comp-documentation Documentation (docs, examples, READMEs). label Oct 14, 2026
@Blargian Blargian added the can be tested Allows running workflows for external contributors label Oct 14, 2026
@clickhouse-gh

clickhouse-gh Bot commented Oct 14, 2026 •

Copy link
Copy Markdown
Contributor

Workflow [PR], commit [e49a57d]

Summary: ✅


AI Review

Summary

PR #125739 documents that the Replicated database settings default_replica_path, default_replica_shard_name, and default_replica_name require ClickHouse 25.10 or later, and explains the UNKNOWN_SETTING exception on older releases. No actionable findings.

Final Verdict

Status: ✅ Approve

Comment thread src/Databases/DatabaseReplicated.cpp Resolved
@clickhouse-gh clickhouse-gh Bot added the pr-documentation Documentation PRs for the specific code PR label Oct 14, 2026
@Blargian
Blargian enabled auto-merge October 14, 2026 14:16
@Blargian
Blargian added this pull request to the merge queue Oct 14, 2026
Merged via the queue into ClickHouse:master with commit 147eab9 Oct 14, 2026
177 checks passed
@robot-clickhouse-ci-2 robot-clickhouse-ci-2 added the pr-synced-to-cloud The PR is synced to the cloud repo label Oct 14, 2026
@clickhouse-gh clickhouse-gh Bot added the external Author is not a member of the ClickHouse organization label Oct 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

can be tested Allows running workflows for external contributors comp-documentation Documentation (docs, examples, READMEs). external Author is not a member of the ClickHouse organization pr-documentation Documentation PRs for the specific code PR pr-synced-to-cloud The PR is synced to the cloud repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Incorrect Documentation of database_replicated setting in ClickHouse 25.8 and 25.9

5 participants