Add support of SETTINGS ClickHouse clause #803
Conversation
This file contains 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
### Summary Clickhouse SQL has an optional [`SETTINGS` clause](settings-clause) with `SELECT`s which can be used to configure [all kinds of options](settings). This PR adds a `settings` method to `ClickHouseQueryBuilder` to add these options to a `SELECT` query. All current (Clickhouse 24.4) settings keys are snake-case. Therefore I opted to use the settings keys directly as kwargs to the `settings` method, allowing passing multiple settings pairs in one call in a Pythonic/ideomatic way. [settings-clause]: https://clickhouse.com/docs/en/sql-reference/statements/select#settings-in-select-query [settings]: https://clickhouse.com/docs/en/operations/settings/settings ### Test Plan Added a unit test to exercise the new function.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Clickhouse SQL has an optional
SETTINGSclause withSELECTs which can be used to configure all kinds of options.This PR adds a
settingsmethod toClickHouseQueryBuilderto add these options to aSELECTquery.All current (Clickhouse 24.4) settings keys are snake-case. Therefore I opted to use the settings keys directly as kwargs to the
settingsmethod, allowing passing multiple settings pairs in one call in a Pythonic/ideomatic way.Test Plan
Added a unit test to exercise the new function.