Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

http_* session settings

These settings are available in system.settings and are autogenerated from source.

http_allow_database_as_path

Type
Bool
Default
0
Version history
VersionDefault valueComment
26.80New setting to recognize a database name in the URL path of HTTP requests.

If enabled, the HTTP interface recognizes a /database/ component in the URL path and uses it as the current database.

This is a per-user setting that controls whether a routed path-style request is interpreted. Routing itself is gated globally by the server-level http_allow_path_requests configuration setting (off by default), which must be enabled for the HTTP interface to route a path-style request (such as /my_db/my_table.csv) to the query handler at all — that routing decision is made before the request is authenticated, so it cannot depend on a per-user setting. When http_allow_path_requests is off, unknown paths return a plain 404. After routing, this setting is re-checked against the authenticated user’s effective settings, so it can be enabled selectively per user, role, or profile.

http_allow_filters_as_path

Type
Bool
Default
0
Version history
VersionDefault valueComment
26.80New setting to recognize hive-style `name=value` filters in the URL path of HTTP requests.

If enabled, the HTTP interface recognizes /name=value/ components in the path (hive partitioning style) and translates them to filters combined with AND. Operators >, <, >=, <=, !=, <> are also recognized.

Like http_allow_database_as_path, this is a per-user setting; routing of path-style requests is gated globally by the server-level http_allow_path_requests configuration setting (routing happens before authentication).

http_allow_filters_as_unrecognized_url_parameters

Type
Bool
Default
0
Version history
VersionDefault valueComment
26.80New setting to treat unrecognized URL parameters as filter expressions in HTTP requests.

If enabled, any URL parameter not recognized as a known parameter, setting, or param_* prefix is treated as a filter and combined with AND. Two forms are accepted:

  • A plain name=value becomes the equality `name` = 'value' (the identifier is back-quoted, the value is quoted as a string literal).
  • A comparison operator (!=, >, <, >=, <=, <>) makes it a comparison: either split across the parameter (?a!=2, ?a>=2) or written inline when the URL has no = to split on (?a<>2, ?f(x)>3), in which case the reassembled name[=value] is parsed as a full SQL expression.

http_allow_table_as_file

Type
Bool
Default
0
Version history
VersionDefault valueComment
26.80New setting to recognize a table name in the URL path of HTTP requests, with optional format/compression extensions.

If enabled, the HTTP interface recognizes the last URL path component as a table name in the form table, table.format, or table.format.compression. The path is interpreted as SELECT * FROM table.

Like http_allow_database_as_path, this is a per-user setting; routing of path-style requests is gated globally by the server-level http_allow_path_requests configuration setting (routing happens before authentication).

http_connection_timeout

Type
Seconds
Default
1

HTTP connection timeout (in seconds).

Possible values:

  • Any positive integer.
  • 0 - Disabled (infinite timeout).

http_make_head_request

Type
Bool
Default
1

The http_make_head_request setting allows the execution of a HEAD request while reading data from HTTP to retrieve information about the file to be read, such as its size. Since it’s enabled by default, it may be desirable to disable this setting in cases where the server does not support HEAD requests.

http_native_compression_disable_checksumming_on_decompress

Type
Bool
Default
0

Enables or disables checksum verification when decompressing the HTTP POST data from the client. Used only for ClickHouse native compression format (not used with gzip or deflate).

For more information, read the HTTP interface description.

Possible values:

  • 0 — Disabled.
  • 1 — Enabled.

http_receive_timeout

Type
Seconds
Default
30
Version history
VersionDefault valueComment
23.630See http_send_timeout.

HTTP receive timeout (in seconds).

Possible values:

  • Any positive integer (seconds). 0 is not an infinite timeout and can cause connection setup failures (POSIX socket timeouts require a positive interval).

http_send_timeout

Type
Seconds
Default
30
Version history
VersionDefault valueComment
23.6303 minutes seems crazy long. Note that this is timeout for a single network write call, not for the whole upload operation.

HTTP send timeout (in seconds).

Possible values:

  • Any positive integer (seconds). 0 is not an infinite timeout and can cause connection setup failures (POSIX socket timeouts require a positive interval).

http_skip_not_found_url_for_globs

Type
Bool
Default
1

Skip URLs for globs with HTTP_NOT_FOUND error

http_wait_end_of_query

Type
Bool
Default
0

Enable HTTP response buffering on the server-side.

http_write_exception_in_output_format

Type
Bool
Default
0
Version history
VersionDefault valueComment
25.110Changed for consistency across formats
23.91Output valid JSON/XML on exception in HTTP streaming.

Write exception in output format to produce valid output. Works with JSON and XML formats.

http_zlib_compression_level

Type
Int64
Default
3

Sets the level of data compression in the response to an HTTP request if enable_http_compression = 1.

Possible values: Numbers from 1 to 12. Levels above 9 require the default build with libdeflate; a build without libdeflate supports levels 1 to 9.

Navigation