-
Notifications
You must be signed in to change notification settings - Fork 6.6k
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.
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
Docs organize user setting profiles #52041
Conversation
This is an automated comment for commit 7756620 with description of existing statuses. It's updated for the latest CI running
|
@@ -1,11 +1,11 @@ | |||
--- | |||
slug: /en/operations/server-configuration-parameters/settings | |||
sidebar_position: 57 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the current order of doc pages:
In my view, a more logical order would be:
- Settings Overview
- Configuration files
- User Settings
- Settings Profiles
- Constraints on Settings
- Global Server Settings
- Merge Tree Settings
- Core Settings
- Format Settings
- Restrictions on Query Complexity
Pages "Permissions for Queries" and "Memory Overcommit" look out-of-place and are ideally integrated into an existing page. But that can also be done separately.
|
||
The order of priority for defining a setting is: | ||
- Global server settings |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are two main groups of ClickHouse settings:
- Global server settings
- Session and query-level settings
|
||
1. Settings in the `users.xml` server configuration file | ||
The main distinction between global server settings and query-level settings is that |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The main distinction between global server settings and session / query-level settings is that global server settings must be set in configuration files while session / query-level settings can be set in configuration files or with SQL queries.
@@ -0,0 +1,217 @@ | |||
--- | |||
sidebar_label: Query-level Settings |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's rename this to include "session-level" settings.
@DanRoscigno The auto-merger submitted this PR a bit too early into the codebase :-) Kindly see my remaining comments (they are not critical). |
This adds an overview to the settings section of the docs explaining the difference between global server settings and query-level settings and provides examples of the different ways of setting the query-level settings.
Changelog category (leave one):
Related to ClickHouse/clickhouse-docs#2299 , I will tackle that one next (it should be very similar)