Add documentation for the SqlCompatibilitySettings ODBC driver parameter#5517
Open
Add documentation for the SqlCompatibilitySettings ODBC driver parameter#5517
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
3 Skipped Deployments
|
slabko
force-pushed
the
sql-compatibility-settings
branch
from
71b9b02 to
920f0ba
Compare
The upcoming version of the driver includes an additional configuration parameter, SqlCompatibilitySettings, intended for BI tools and other applications that generate queries automatically. This parameter enables certain ClickHouse query settings that should be explained in the documentation. Additionally, when this setting is enabled, readonly users won't be able to execute queries because ClickHouse doesn't allow users to change any settings. The documentation also explains how to handle this situation. The ODBC driver attempts to recognize such errors and includes a link in the error message to the #readonly-users section.
slabko
force-pushed
the
sql-compatibility-settings
branch
from
920f0ba to
5af5d2f
Compare
dhtclk
approved these changes
Feb 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The upcoming version of the driver includes an additional configuration parameter,
SqlCompatibilitySettings, intended for BI tools and other applications that generate queries automatically. This parameter enables certain ClickHouse query settings that should be explained in the documentation.Additionally, when this setting is enabled, readonly users won't be able to execute queries because ClickHouse doesn't allow users to change any settings. The documentation also explains how to handle this situation. The ODBC driver attempts to recognize such errors and includes a link in the error message to the #readonly-users section.
Summary
Checklist
Delete items not relevant to your PRURL changes should add a redirect to the old URL via https://github.com/ClickHouse/clickhouse-docs/blob/main/docusaurus.config.jsIf adding a new integration page, also add an entry to the integrations list here: https://github.com/ClickHouse/clickhouse-docs/blob/main/docs/integrations/index.mdx