From a19659bc26a3e9f1a5fbe7d82156c30c4e35fdc1 Mon Sep 17 00:00:00 2001 From: Shaun Struwig <41984034+Blargian@users.noreply.github.com> Date: Thu, 20 Nov 2025 13:01:49 +0100 Subject: [PATCH] update scripts to show aliases --- scripts/settings/format-settings.sql | 31 ++++++++++++++++++++------- scripts/settings/session-settings.sql | 16 +++++++++++++- 2 files changed, 38 insertions(+), 9 deletions(-) diff --git a/scripts/settings/format-settings.sql b/scripts/settings/format-settings.sql index fbe197a1d5d..73a4a282f34 100644 --- a/scripts/settings/format-settings.sql +++ b/scripts/settings/format-settings.sql @@ -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', '', tier == 'Beta', '', ''), - if(type != '' AND default != '', format('', 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', '', s.tier == 'Beta', '', ''), + 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('', 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 ), '' || '--- diff --git a/scripts/settings/session-settings.sql b/scripts/settings/session-settings.sql index 79d81ae569f..2e6b29fc56b 100644 --- a/scripts/settings/session-settings.sql +++ b/scripts/settings/session-settings.sql @@ -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 @@ -54,11 +64,14 @@ WITH main_content AS ( SELECT - format('## {}{}{}{}{}{}{}\n\n', + format('## {}{}{}{}{}{}{}{}\n\n', name, ' {#'||name||'} \n\n', multiIf(tier == 'Experimental', '\n\n', tier == 'Beta', '\n\n', ''), if(description LIKE '%Only has an effect in ClickHouse Cloud%', '\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( @@ -71,6 +84,7 @@ WITH if(rows != '', printf('\n\n\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 ), '---