Skip to content
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

Merged
merged 4 commits into from
Jul 17, 2023

Conversation

DanRoscigno
Copy link
Contributor

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):

  • Documentation (changelog entry is not required)

Related to ClickHouse/clickhouse-docs#2299 , I will tackle that one next (it should be very similar)

@DanRoscigno DanRoscigno added pr-documentation Documentation PRs for the specific code PR can be tested Allows running workflows for external contributors labels Jul 11, 2023
@robot-ch-test-poll1
Copy link
Contributor

robot-ch-test-poll1 commented Jul 11, 2023

This is an automated comment for commit 7756620 with description of existing statuses. It's updated for the latest CI running
The full report is available here
The overall status of the commit is 🟢 success

Check nameDescriptionStatus
CI runningA meta-check that indicates the running CI. Normally, it's in success or pending state. The failed status indicates some problems with the PR🟢 success
Docs CheckBuilds and tests the documentation🟢 success
Mergeable CheckChecks if all other necessary checks are successful🟢 success
Push to DockerhubThe check for building and pushing the CI related docker images to docker hub🟢 success
Style CheckRuns a set of checks to keep the code style clean. If some of tests failed, see the related log from the report🟢 success

@@ -1,11 +1,11 @@
---
slug: /en/operations/server-configuration-parameters/settings
sidebar_position: 57
Copy link
Member

@rschu1ze rschu1ze Jul 17, 2023

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:

image

In my view, a more logical order would be:

  1. Settings Overview
  2. Configuration files
  3. User Settings
  4. Settings Profiles
  5. Constraints on Settings
  6. Global Server Settings
  7. Merge Tree Settings
  8. Core Settings
  9. Format Settings
  10. 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
Copy link
Member

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
Copy link
Member

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
Copy link
Member

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.

@robot-ch-test-poll4 robot-ch-test-poll4 merged commit 036fb1f into master Jul 17, 2023
21 checks passed
@robot-ch-test-poll4 robot-ch-test-poll4 deleted the docs-organize-user-profiles branch July 17, 2023 10:03
@rschu1ze
Copy link
Member

@DanRoscigno The auto-merger submitted this PR a bit too early into the codebase :-) Kindly see my remaining comments (they are not critical).

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 pr-documentation Documentation PRs for the specific code PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants