Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

format_* format settings

These settings are autogenerated from source.

format_display_secrets_in_show_and_select

Type
Bool
Default
0

Enables or disables showing secrets in SHOW and SELECT queries for tables, databases, table functions, and dictionaries.

User wishing to see secrets must also have display_secrets_in_show_and_select server setting turned on and a displaySecretsInShowAndSelect privilege.

Possible values:

  • 0 — Disabled.
  • 1 — Enabled.

format_geojson_validate_geometry

Type
Bool
Default
1
Version history
VersionDefault valueComment
26.71New setting that controls whether the GeoJSON format enforces RFC 7946 geometry validity (minimum points per line and ring, ring closure, non-empty multi-geometries) when reading and writing

Controls whether the GeoJSON format enforces RFC 7946 geometry validity, in both directions.

When enabled (default), a geometry that violates the GeoJSON shape rules is rejected: a LineString (or a line of a MultiLineString) with fewer than two points; a Polygon or MultiPolygon ring with fewer than four points or whose first and last points differ (an unclosed ring); or an empty MultiLineString, Polygon, or MultiPolygon. This applies both when reading (such a document is rejected) and when writing (such a ClickHouse value is rejected instead of producing a document the input format would reject).

When disabled, these shape rules are not enforced: such geometries are read as-is and written as-is, so degenerate geometries round-trip, but a written document may not be valid GeoJSON.

The validation is structural only: it checks point counts and ring closure. It does not inspect the geometric correctness of a shape — ring orientation (the right-hand rule / winding order) is not enforced, and structurally valid but geometrically degenerate geometries are accepted, such as a zero-area polygon, a self-intersecting ring, or a polygon whose holes lie outside its outer ring. Non-finite coordinates (NaN, Inf) are always rejected regardless of this setting, because they cannot be represented as JSON numbers.

format_hive_text_rows_delimiter

Type
Char
Default
Version history
VersionDefault valueComment
26.8 New setting for the delimiter at the end of each row in the HiveText output format.

Delimiter at the end of each row in the Hive Text output format

format_json_object_each_row_column_for_object_name

The name of column that will be used for storing/writing object names in JSONObjectEachRow format. Column type should be String. If value is empty, default names row_{i}will be used for object names.

format_protobuf_use_autogenerated_schema

Type
Bool
Default
1

Use autogenerated Protobuf when format_schema is not set

format_tsv_null_representation

Type
String
Default
\N

Custom NULL representation in TSV format

Navigation