Skip to content

Commit

Permalink
Merge pull request #2805 from ClickHouse/rmarin_add_tiers
Browse files Browse the repository at this point in the history
Add tier notes in settings docs
  • Loading branch information
Algunenano authored Nov 19, 2024
2 parents 232402d + 8530a2a commit a6489d6
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions scripts/settings/autogenerate-settings.sh
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@ if [ ! -f ./clickhouse ]; then
curl https://clickhouse.com/ | sh
fi


EXPERIMENTAL_NOTE=":::warning
This feature is in experimental stage. Only intended for developers and ClickHouse enthusiasts. The feature might or might not work and could be removed at any time.
:::"

BETA_NOTE=":::note
This feature is beta stage. The outcome of using it together with other features is unknown and correctness is not guaranteed. Testing and reports are welcome.
:::"


# Autogenerate Format settings
./clickhouse -q "
WITH
Expand All @@ -22,7 +32,8 @@ settings_from_cpp AS
),
main_content AS
(
SELECT format('## {} {}\\n\\nType: {}\\n\\nDefault value: {}\\n\\n{}\\n\\n', name, '{#'||name||'}', type, default, trim(BOTH '\\n' FROM description))
SELECT format('## {} {}\\n\\nType: {}\\n\\nDefault value: {}\\n\\n{}{}\\n\\n',
name, '{#'||name||'}', type, default, multiIf(tier == 'Experimental', '${EXPERIMENTAL_NOTE}\n\n', tier == 'Beta', '${BETA_NOTE}\n\n', ''), trim(BOTH '\\n' FROM description))
FROM system.settings WHERE name IN settings_from_cpp
ORDER BY name
),
Expand Down Expand Up @@ -51,7 +62,8 @@ settings_from_cpp AS
),
main_content AS
(
SELECT format('## {} {}\\n\\nType: {}\\n\\nDefault value: {}\\n\\n{}\\n\\n', name, '{#'||name||'}', type, default, trim(BOTH '\\n' FROM description))
SELECT format('## {} {}\\n\\nType: {}\\n\\nDefault value: {}\\n\\n{}{}\\n\\n',
name, '{#'||name||'}', type, default, multiIf(tier == 'Experimental', '${EXPERIMENTAL_NOTE}\n\n', tier == 'Beta', '${BETA_NOTE}\n\n', ''), trim(BOTH '\\n' FROM description))
FROM system.settings WHERE name IN settings_from_cpp
ORDER BY name
),
Expand Down

0 comments on commit a6489d6

Please sign in to comment.