Skip to content

Autogenerated docs: update scripts to show aliases for settings #4772

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 20, 2025
Merged

Autogenerated docs: update scripts to show aliases for settings #4772

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 23 additions & 8 deletions scripts/settings/format-settings.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,31 @@ WITH
FROM file(cpp_file, LineAsString)
WHERE match(line, '^\\s*DECLARE\\(')
),
setting_aliases AS
(
SELECT
alias_for,
groupArray(name) AS aliases
FROM system.settings
WHERE alias_for != ''
AND alias_for IN settings_from_cpp
GROUP BY alias_for
),
main_content AS
(
SELECT format('## {} {} {} \n\n{}\n\n{}\n\n',
name,
'{#'||name||'}',
multiIf(tier == 'Experimental', '<ExperimentalBadge/>', tier == 'Beta', '<BetaBadge/>', ''),
if(type != '' AND default != '', format('<SettingsInfoBlock type="{}" default_value="{}" />', type, default), ''),
trim(BOTH '\\n' FROM description))
FROM system.settings WHERE name IN settings_from_cpp
ORDER BY name
SELECT format('## {} {} {} \n\n{}{}\n\n{}\n\n',
s.name,
'{#'||s.name||'}',
multiIf(s.tier == 'Experimental', '<ExperimentalBadge/>', s.tier == 'Beta', '<BetaBadge/>', ''),
if(sa.aliases IS NOT NULL AND length(sa.aliases) > 0,
'**Aliases**: ' || arrayStringConcat(arrayMap(x -> '`' || x || '`', sa.aliases), ', ') || '\n\n',
''),
if(s.type != '' AND s.default != '', format('<SettingsInfoBlock type="{}" default_value="{}" />', s.type, s.default), ''),
trim(BOTH '\\n' FROM s.description))
FROM system.settings s
LEFT JOIN setting_aliases sa ON s.name = sa.alias_for
WHERE s.name IN settings_from_cpp
ORDER BY s.name
),
'' ||
'---
Expand Down
16 changes: 15 additions & 1 deletion scripts/settings/session-settings.sql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,16 @@ WITH
FROM file(cpp_file, LineAsString)
WHERE match(line, '^\\s*DECLARE(?:_WITH_ALIAS)?\\(')
),
setting_aliases AS
(
SELECT
alias_for,
groupArray(name) AS aliases
FROM system.settings
WHERE alias_for != ''
AND alias_for IN settings_from_cpp
GROUP BY alias_for
),
settings_with_change_history AS
(
SELECT
Expand All @@ -54,11 +64,14 @@ WITH
main_content AS
(
SELECT
format('## {}{}{}{}{}{}{}\n\n',
format('## {}{}{}{}{}{}{}{}\n\n',
name,
' {#'||name||'} \n\n',
multiIf(tier == 'Experimental', '<ExperimentalBadge/>\n\n', tier == 'Beta', '<BetaBadge/>\n\n', ''),
if(description LIKE '%Only has an effect in ClickHouse Cloud%', '<CloudOnlyBadge/>\n\n', ''),
if(sa.aliases IS NOT NULL AND length(sa.aliases) > 0,
'**Aliases**: ' || arrayStringConcat(arrayMap(x -> '`' || x || '`', sa.aliases), ', ') || '\n\n',
''),
if(
type != '' AND default != '',
format(
Expand All @@ -71,6 +84,7 @@ WITH
if(rows != '', printf('\n\n<VersionHistory rows={%s}/>\n\n', rows), ''),
replaceOne(trim(BOTH '\\n' FROM description), ' and [MaterializedMySQL](../../engines/database-engines/materialized-mysql.md)',''))
FROM settings_with_change_history
LEFT JOIN setting_aliases sa ON settings_with_change_history.name = sa.alias_for
ORDER BY name
),
'---
Expand Down