Document HTTP URL-path table access and query-construction settings#6398
Draft
alexey-milovidov wants to merge 2 commits into
Draft
Document HTTP URL-path table access and query-construction settings#6398alexey-milovidov wants to merge 2 commits into
alexey-milovidov wants to merge 2 commits into
Conversation
ClickHouse 26.6 lets the HTTP interface interpret the URL path as a database/table/format/compression and shape the result with URL parameters (`select`, `filter`, `order`, `sort`, `limit`, `offset`, `page`, `format`, `output_format`, `input_format`, `default_format`, `compression`), gated by the `http_allow_database_as_path`, `http_allow_table_as_file`, `http_allow_filters_as_path` and `http_allow_filters_as_unrecognized_url_parameters` settings. Add a section to the HTTP interface page covering enabling path routing (and the pre-authentication routing caveat), tables-as-files, query construction, format and compression overrides, and `implicit_table_at_top_level`, with curl examples and a note that `filter` is not an access-control mechanism. Documents ClickHouse/ClickHouse#105249 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
3 Skipped Deployments
|
1 task
Path routing is gated in two layers: the server-level `http_allow_path_requests` configuration flag (default off) enables routing globally, and the per-user `http_allow_*` settings control how a routed path is interpreted after authentication. Related: ClickHouse/ClickHouse#105249
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
1 participant
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.
Documents the HTTP-interface feature added in ClickHouse/ClickHouse#105249 (ClickHouse 26.6): interpreting the URL path as
database/table.format.compressionand shaping the result with URL parameters.Adds a section to the HTTP interface page (
docs/integrations/interfaces/http.md) covering:http_allow_database_as_path,http_allow_table_as_file,http_allow_filters_as_path,http_allow_filters_as_unrecognized_url_parameters), including the pre-authentication routing caveat (enable in the server default profile);/database/table.format.compression);select,filter,order,sort,limit,offset,page), with a note thatfilteris not an access-control mechanism;format,input_format,output_format,default_format,compression);implicit_table_at_top_level.Related: ClickHouse/ClickHouse#105249
🤖 Generated with Claude Code
Note
Low Risk
Documentation-only change to the HTTP interface page; no runtime or server behavior is modified.
Overview
Adds a new “Accessing tables via the URL path and constructing queries” section to
docs/integrations/interfaces/http.mdfor the ClickHouse 26.6 HTTP feature (path-as-table reads without full SQL).It documents opt-in settings (
http_allow_table_as_file,http_allow_database_as_path, filter-in-path/URL options), including the pre-auth routing caveat (enable in the server default profile or path-style URLs may 404). It covers/database/table.format.compressionexamples, URL-driven query wrapping (select,filter,order,sort,limit/offset/page), format/compression override settings, andimplicit_table_at_top_levelwhen combining a path table with aqueryparameter. A danger callout states thatfilteris not row-level access control.Reviewed by Cursor Bugbot for commit de8a910. Bugbot is set up for automated code reviews on this repo. Configure here.