OS Manuals

/usr/bin/clickhouse-format

ClickHouse is the fastest and most resource efficient open-source database for real-time apps and analytics.

From clickhouse-24.4 24.4.4.113-r4 (enterprise-packages), captured 2026-11-08 by running clickhouse-format --help (exit 1). permalink

Usage: /usr/bin/clickhouse-format [options] < query
Allowed options:
  --query arg       query to format
  -h [ --help ]     produce help message
  --comments        keep comments in the output
  --hilite          add syntax highlight with ANSI terminal
                    escape sequences
  --oneline         format in single line
  --max_line_length arg (=0)
                    format in single line queries with
                    length less than specified
  -q [ --quiet ]    just check syntax, no output on success
  -n [ --multiquery ]
                    allow multiple queries in the same file
  --obfuscate       obfuscate instead of formatting
  --backslash       add a backslash at the end of each line
                    of the formatted query
  --allow_settings_after_format_in_insert
                    Allow SETTINGS after FORMAT, but note,
                    that this is not always safe
  --seed arg        seed (arbitrary string) that determines
                    the result of obfuscation
  --max_query_size arg
                    The maximum number of bytes of a query
                    string parsed by the SQL parser. Data
                    in the VALUES clause of INSERT queries
                    is processed by a separate stream
                    parser (that consumes O(1) RAM) and not
                    affected by this restriction.
  --max_parser_depth arg
                    Maximum parser depth (recursion depth
                    of recursive descend parser).
Options (12)
OptionDescriptionSource
--query argquery to formathelp
-hproduce help messagehelp
--commentskeep comments in the outputhelp
--hiliteadd syntax highlight with ANSI terminal escape sequenceshelp
--onelineformat in single linehelp
-qjust check syntax, no output on successhelp
--obfuscateobfuscate instead of formattinghelp
--backslashadd a backslash at the end of each line of the formatted queryhelp
--allow_settings_after_format_in_insertAllow SETTINGS after FORMAT, but note, that this is not always safehelp
--seed argseed (arbitrary string) that determines the result of obfuscationhelp
--max_query_size argThe maximum number of bytes of a query string parsed by the SQL parser.help
--max_parser_depth argMaximum parser depth (recursion depth of recursive descend parser).help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.