output_format_* 格式设置

这些设置是根据源文件自动生成的。

在文本格式中，始终为浮点数和 Decimal 数字输出小数点，即使该值为整数也是如此。例如，输出 1. 而不是 1。

默认禁用。

Arrow 输出格式的压缩方法。支持的编解码器：lz4_frame、zstd、none (未压缩)

将 Date 值写为普通的 16 位数字 (读取时为 UInt16) ，而不是转换为 32 位的 Arrow DATE32 类型 (读取时为 Date32) 。

对 FixedString 列，使用 Arrow FIXED_SIZE_BINARY 类型而不是 Binary 类型。

启用将输出中的 LowCardinality 类型表示为 Dictionary Arrow 类型

对 String 列使用 Arrow 的 String 类型而非 Binary

将无法转换的输出类型作为原始二进制数据输出。如果为 false，则此类类型会抛出 UNKNOWN_TYPE 异常。

在 Arrow 格式中，始终对字典索引使用 64 位整数

在 Arrow 格式中对字典索引使用有符号整数

用于输出的压缩编解码器。可选值：'null'、'deflate'、'snappy'、'zstd'。

对于 AvroConfluent output format：在 Confluent Schema Registry 中注册 schema 时使用的 subject name。写入 AvroConfluent output 时为必填项。

单个文件中的最大行数 (如果存储支持)

对于 Avro 格式：用于选择作为 AVRO 字符串输出的 String 列的正则表达式。

以字节为单位的同步间隔。

在 RowBinaryWithNamesAndTypes 输出格式中，以二进制格式写入数据类型，而不是类型名称

在 RowBinary 输出格式中，将 JSON data type 的值写为 JSON String 值。

对 String 列使用 BSON String 类型，而不是 Binary。

查询输出被压缩时使用的默认压缩级别。该设置会在 SELECT 查询使用 INTO OUTFILE 时，或将数据写入表函数 file、url、hdfs、s3 或 azureBlobStorage 时生效。

可能的取值：从 1 到 22

可在输出压缩方法为 zstd 时使用。如果该值大于 0，此设置会显式指定压缩窗口大小 (2 的幂) ，并为 zstd 压缩启用长距离模式。这有助于获得更高的压缩率。

Possible values: 非负数。请注意，如果该值过小或过大，zstdlib 将抛出异常。典型值范围为 20 (window size = 1MB) 到 30 (window size = 1GB) 。

如果设置为 true，CSV 格式的行尾将使用 \r\n 而不是 \n。

当启用 output_format_csv_serialize_tuple_into_separate_columns 时，CSVWithNames 和 CSVWithNamesAndTypes 的表头会将每个裸 Tuple 列扁平化为其叶子字段 (点号名称如 t.a、t.b，以及叶子类型名称) ，因此表头的列数与数据相同。Nullable(Tuple) 列永远不会被扁平化 (其数据始终是单个 CSV 字段) ，因此其表头会保留单个顶层列名和类型。对于 CustomSeparated*，只有在 format_custom_escaping_rule = 'CSV' 且 format_custom_field_delimiter 是与 format_csv_delimiter 相同的单个字符时，才会应用这种扁平化；否则 (例如默认的制表符分隔符，或 format_custom_field_delimiter = '|') ，表头将保持未扁平化状态，以便继续与数据匹配。将其设置为 0 可保留之前的行为，即表头保留单个顶层 Tuple 名称和类型。

注意：当 input_format_with_names_use_header = 1 时，扁平化后的表头不会按名称读回到 Tuple 中。要将此类数据重新读入 Tuple，可以在输出时将此设置设为 0，或者在读取时使用 input_format_with_names_use_header = 0 (并且对于 *WithNamesAndTypes 格式 CSVWithNamesAndTypes 和 CustomSeparatedWithNamesAndTypes，还需设置 input_format_with_types_use_header = 0，否则扁平化后的类型行会与单个顶层 Tuple 输入字段进行校验，并因此被拒绝) 。

如果将其设为 true，则 CSV 格式中的裸 Tuple 列会被序列化为单独的列 (即会丢失其在 Tuple 中的嵌套结构) 。

这种扁平化仅适用于裸 Tuple。Nullable(Tuple) 始终会被序列化为单个 CSV 字段 (以确保 NULL 行和非 NULL 行占用相同数量的字段) ，不受此设置影响。

输出 Decimal 值时保留末尾的零。例如，输出 1.230000 而不是 1.23。

默认禁用。

当该值非 0 时，将浮点输出 (Float32、Float64、BFloat16) 格式化为小数点后最多保留这么多位数字 (会去除末尾的零) 。 当值为 0 (默认值) 时，使用最短的 round-trip 表示形式。

如果某个值大到不适合使用定点表示法，或其绝对值小到按指定精度舍入后会丢失所有有效数字 (尾数会变为 ±0) ，则会改用科学计数法输出。在这些回退情况下，尾数的小数位数可能会超过指定的位数。

有效范围：0 到 100。

对于 PNG 等图像输出格式，输出图像的高度 (单位为像素) 。

默认值：1024。

对于 PNG 等图像输出格式，检测到 t 列的下一个值后，立即写入动画的每一帧，而不是将所有帧缓冲在内存中直至查询结束。

内存中只保留一帧，查询尚在运行时，帧便会输出。相应地，t 的值必须是非递减的，否则查询会引发异常。此外，写入动画请求头时尚无法确定帧数，因此声明的帧数为上限，而非精确值。浏览器可以播放此类文件，但信任声明帧数的解码器会在最后一个实际帧后报告错误。

默认值：false。

对于 PNG 等图像输出格式，使用内联图像协议将图像直接输出到终端，而不是写出原始图像字节。

可能的值：

• `` (空) — 写出原始图像字节 (默认) 。
• iterm — 使用 iTerm2 内联图像协议。
• kitty — 使用 Kitty 图形协议。
• sixel — 使用 Sixel 协议。
• auto — 如果输出目标是终端，则检测其支持情况并使用 iterm、kitty 或 sixel (按此顺序) ；否则写出原始图像字节。

默认值：`` (空) 。

对于 PNG 等图像输出格式，t 列时间单位的分母，单位为秒。

请参阅 output_format_image_time_multiplier_seconds。

默认值：60。

对于 PNG 等图像输出格式，t 列时间单位的分子，以秒为单位。

存在 t 列时，该格式会生成动画，其中 t 表示帧的相对时间偏移量。 一个 t 单位对应 output_format_image_time_multiplier_seconds / output_format_image_time_divisor_seconds 秒。 使用默认值 (1 和 60) 时，一个 t 单位为 1/60 秒。

默认值：1。

PNG 等图像输出格式的输出图像宽度，以像素为单位。

默认值：1024。

启用后，可在 JSONEachRow 格式中将所有行作为一个 JSON 数组输出。

Possible values:

• 1 — ClickHouse 将所有行输出为一个数组，其中每一行都采用 JSONEachRow 格式。
• 0 — ClickHouse 以 JSONEachRow 格式分别输出每一行。

启用此设置时的查询示例

查询：

SET output_format_json_array_of_rows = 1;
SELECT number FROM numbers(3) FORMAT JSONEachRow;

结果：

[
{"number":"0"},
{"number":"1"},
{"number":"2"}
]

禁用该设置时的查询示例

查询：

SET output_format_json_array_of_rows = 0;
SELECT number FROM numbers(3) FORMAT JSONEachRow;

结果：

{"number":"0"}
{"number":"1"}
{"number":"2"}

控制在 JSON 输出格式中，是否对字符串输出中的正斜杠进行转义。此设置旨在与 JavaScript 保持兼容。不要将其与始终会被转义的反斜杠混淆。

默认启用。

将 Map 列序列化为由 Tuple 组成的 JSON 数组。

默认禁用。

将命名元组列序列化为 JSON 对象。

默认启用。

此设置决定了使用 JSON 输出格式时，data 数组中的 Tuple、Map 和 Array 等嵌套结构的显示方式。

例如，输出不再是：

"data":
[
  {
    "tuple": {"a":1,"b":2,"c":3},
    "array": [1,2,3],
    "map": {"a":1,"b":2,"c":3}
  }
],

输出格式如下：

"data":
[
    {
        "tuple": {
            "a": 1,
            "b": 2,
            "c": 3
        },
        "array": [
            1,
            2,
            3
        ],
        "map": {
            "a": 1,
            "b": 2,
            "c": 3
        }
    }
],

默认启用。

控制在 JSON* 格式中输出 64 位浮点数时，是否为其加上引号。

默认情况下禁用。

控制在以 JSON 格式输出时，是否为 64 位或更大的整数 (如 UInt64 或 Int128) 添加引号。 默认情况下，这类整数会被引号括起来。此行为与大多数 JavaScript 实现兼容。

可能的值：

• 0 — 整数输出时不带引号。
• 1 — 整数会被引号括起来。

控制在 JSON 输出格式中是否将 Decimal 值用引号括起来。

默认禁用。

允许在 JSON 输出格式中输出 +nan、-nan、+inf 和 -inf。

可能的值：

• 0 — 已禁用。
• 1 — 已启用。

示例

考虑以下表 account_orders：

┌─id─┬─name───┬─duration─┬─period─┬─area─┐
│  1 │ Andrew │       20 │      0 │  400 │
│  2 │ John   │       40 │      0 │    0 │
│  3 │ Bob    │       15 │      0 │ -100 │
└────┴────────┴──────────┴────────┴──────┘

当 output_format_json_quote_denormals = 0 时，查询结果的输出中会返回 null 值：

SELECT area/period FROM account_orders FORMAT JSON;

{
        "meta":
        [
                {
                        "name": "divide(area, period)",
                        "type": "Float64"
                }
        ],

        "data":
        [
                {
                        "divide(area, period)": null
                },
                {
                        "divide(area, period)": null
                },
                {
                        "divide(area, period)": null
                }
        ],

        "rows": 3,

        "statistics":
        {
                "elapsed": 0.003648093,
                "rows_read": 3,
                "bytes_read": 24
        }
}

当 output_format_json_quote_denormals = 1 时，查询将返回：

{
        "meta":
        [
                {
                        "name": "divide(area, period)",
                        "type": "Float64"
                }
        ],

        "data":
        [
                {
                        "divide(area, period)": "inf"
                },
                {
                        "divide(area, period)": "-nan"
                },
                {
                        "divide(area, period)": "-inf"
                }
        ],

        "rows": 3,

        "statistics":
        {
                "elapsed": 0.000070241,
                "rows_read": 3,
                "bytes_read": 24
        }
}

将命名元组列序列化为 JSON 对象时，跳过值为 NULL 的键值对。仅当 output_format_json_named_tuples_as_objects 为 true 时，此设置才生效。

控制是否在 JSON 输出格式中验证 UTF-8 序列；不影响 JSON/JSONCompact/JSONColumnsWithMetadata 格式，这些格式始终会验证 UTF-8。

默认禁用。

启用后，会对 Markdown 中的特殊字符进行转义。

Common Mark 定义了以下可转义的特殊字符：

! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~

可选值：

• 0 — 禁用。
• 1 — 启用。

UUID 在 MsgPack 格式中的输出方式。

在 Native 输出格式中，以二进制格式写入数据类型，而不是写入类型名称

以扁平化格式写入 JSON 和 Dynamic 列中的数据 (所有类型/路径均作为独立的子列) 。

将 JSON 列的数据写入为包含 JSON 字符串的 String 列，而不是使用默认的原生 JSON 序列化。

ORC 输出格式的压缩块大小，以字节为单位。

ORC 输出格式的压缩方法。支持的编解码器：lz4、snappy、zlib、zstd、none (未压缩)

对于 ORC 输出格式中的字符串列，如果不同值的数量超过非 NULL 行总数的该比例，则关闭字典编码；否则启用字典编码

ORC 输出格式中的目标行索引步长

对 String 列使用 ORC String 类型，而不是 Binary

ORC 写入器的时区名称，默认时区为 GMT。

启用或禁用数据格式的并行格式化功能。仅 TSV、TSKV、CSV 和 JSONEachRow 格式支持此功能。

可选值：

• 1 — 启用。
• 0 — 禁用。

每处理这么多行就检查一次页大小。如果列中值的平均大小超过几个 KB，建议适当减小该值。

Parquet 布隆过滤器中每个不同值大致使用的位数。估计的误报率如下：

• 6 位 - 10%
• 10.5 位 - 1%
• 16.9 位 - 0.1%
• 26.4 位 - 0.01%
• 41 位 - 0.001%

用于指定在 Parquet 文件中的何处放置布隆过滤器。布隆过滤器将按大致该大小分组写入。具体来说：

• 如果为 0，则每个行组的布隆过滤器会在该行组之后立即写入，
  • 如果该值大于所有布隆过滤器的总大小，则所有行组的布隆过滤器会先在内存中累积，然后在接近文件末尾处一起写入，
  • 否则，布隆过滤器会先在内存中累积，并在其总大小超过该值时写出。

Parquet 输出格式的压缩方法。支持的编解码器：snappy、lz4、brotli、zstd、gzip、none (未压缩)

压缩前的目标页大小 (以字节为单位) 。

将 Date 值写为普通的 16 位数字 (读取回来时为 UInt16) ，而不是转换为 32 位的 Parquet DATE 类型 (读取回来时为 Date32) 。

将 DateTime 值写为原始 Unix timestamp (读取时为 UInt32) ，而不是转换为毫秒 (读取时为 DateTime64(3)) 。

使用 Parquet 物理类型 BYTE_ARRAY 和逻辑类型 ENUM 写入枚举值

对于 FixedString 列，使用 Parquet FIXED_LEN_BYTE_ARRAY 类型而不是 Binary 类型。

用于在 Parquet 元数据中写入 Geo 列信息，并将列编码为 WKB 格式。

如果字典大小超过该字节数，则切换为不使用字典的编码。设为 0 可禁用字典编码。

使用多个线程进行 Parquet 编码。

目标行组大小 (单位：行) 。

压缩前的目标行组大小，单位为字节。

对 String 列使用 Parquet String 类型，而非 Binary。

以大端字节序将 Int128、UInt128、Int256 和 UInt256 值写入为符合标准的 Parquet DECIMAL 值。默认情况下，为兼容旧版 ClickHouse，保留未标注的旧版小端序 FIXED_LEN_BYTE_ARRAY 表示形式。十进制表示形式支持可互操作的数值统计信息，但部分 Parquet reader 不支持精度超过 38 或 76 的值。

将布隆过滤器写入 Parquet 文件。

在 Parquet 页头中写入 crc32 校验和。

将列索引和偏移索引 (即每个数据页的统计信息，读取时可用于过滤器下推) 写入 Parquet 文件。

在 Pretty 格式 中使用 ANSI 转义序列。0 - 禁用，1 - 启用，'auto' - 在输出为终端时启用。

当表中的行数较多时，在页脚中显示列名。

可能的值：

• 0 — 不在页脚显示列名。
• 1 — 当行数大于或等于 output_format_pretty_display_footer_column_names_min_rows 设置的阈值时，在页脚显示列名 (默认为 50) 。

示例

查询：

SELECT *, toTypeName(*) FROM (SELECT * FROM system.numbers LIMIT 1000);

结果：

      ┌─number─┬─toTypeName(number)─┐
   1. │      0 │ UInt64             │
   2. │      1 │ UInt64             │
   3. │      2 │ UInt64             │
   ...
 999. │    998 │ UInt64             │
1000. │    999 │ UInt64             │
      └─number─┴─toTypeName(number)─┘

在启用 output_format_pretty_display_footer_column_names 时，此设置用于指定显示包含列名的页脚所需的最小行数。

如果启用，且表很宽但行数较少，Pretty 格式会按 Vertical 格式的方式输出。 有关此行为的详细调优，请参阅 output_format_pretty_fallback_to_vertical_max_rows_per_chunk 和 output_format_pretty_fallback_to_vertical_min_table_width。

仅当一个块中的记录数不超过指定值时，才会启用回退到 Vertical 格式的行为 (参见 output_format_pretty_fallback_to_vertical) 。

仅当列数大于指定值时，才会启用回退到 Vertical 格式 (参见 output_format_pretty_fallback_to_vertical) 的行为。

仅当表中各列长度之和至少达到指定值，或至少有一个值包含换行符时，才会回退到 Vertical 格式 (参见 output_format_pretty_fallback_to_vertical) 。

如果在 Pretty 格式 中渲染的数据分多个块到达，即使这些块之间存在延迟，但后一个块的列宽与前一个相同，则使用 ANSI 转义序列 返回上一行并覆盖前一个块的页脚，以便接着显示新块中的数据。这样可以让结果看起来更美观。

0 - 禁用，1 - 启用，'auto' - 在终端中启用。

用于打印网格边框的字符集。可用字符集：ASCII、UTF-8 (默认) 。

在交互模式下，clickhouse-client 会在终端不支持 UTF-8 时自动切换为 ASCII (依据 LC_ALL、LC_CTYPE 和 LANG 环境变量判断) ，除非已显式指定此设置。

如果启用且输出到终端，则会以下划线高亮表示千位、百万位等对应的每一位数字。

如果启用且输出到终端，则会以灰色并加下划线的方式高亮尾随空格。

如果列名过长，则将其截断到此长度。 如果列名长度超过 output_format_pretty_max_column_name_width_cut_to 与 output_format_pretty_max_column_name_width_min_chars_to_cut 之和，就会被截断。

当列名过长时，最少需要截断的字符数。 如果列名长度超过 output_format_pretty_max_column_name_width_cut_to 与 output_format_pretty_max_column_name_width_min_chars_to_cut 之和，则会被截断。

Pretty 格式中，对列内所有值进行填充时的最大宽度。

Pretty 格式的行数上限。

Pretty 格式 中显示值的最大宽度。若超过该宽度，则会被截断。 值为 0 表示永不截断。

仅当某个值不是块内的单个值时，才会截断该值 (参见 output_format_pretty_max_value_width 设置) 。否则会完整输出，这对 SHOW CREATE TABLE 查询很有帮助。

如果启用，Pretty 格式会在表单元中以多行形式渲染多行字段，从而保持表格边框完整。 如果未启用，则会按原样渲染，这可能会导致表格变形 (不过保持关闭的一个好处是，复制粘贴多行值会更方便) 。

控制 Pretty 格式中的命名元组是否以格式化的 JSON 对象输出。

为 Pretty 输出格式的每一行添加行号

如果块仅包含一个数字，且该数字超过此值 (0 除外) ，则会在表右侧显示一个易读的数字提示

最多等待下一个块指定的毫秒数，然后在写入前将其与前一个块合并。 这样既可避免过于频繁地输出过小的块，又仍可按流式方式显示数据。

如果自上次输出以来经过的时间超过指定的毫秒数，则在 Pretty 格式 中输出待处理的块。

启用后，Pretty output formats 中的填充将使用 U+00A0 而不是 ASCII 空格来渲染。 在等宽字体下，输出的视觉效果保持不变，但填充内容在经过会压缩或裁剪连续普通空格的工具时仍能保留下来。 仅在 output_format_pretty_grid_charset 为 UTF-8 时生效。

使用 Google wrapper 对 Nullable 列进行序列化时，会将默认值序列化为空 wrapper。若关闭此设置，则默认值和 NULL 值都不会被序列化

自动生成的 schema 在 Cap'n Proto 或 Protobuf 格式下将保存到的文件路径。

在 INSERT 查询中包含列名

单条 INSERT 语句中的最大行数。

使用 '`' 字符为列名加引号

输出 INSERT 查询中的表名称

使用 REPLACE 语句而不是 INSERT

在文本输出格式中去除 FixedString 值末尾的零字节。例如，toFixedString('John', 8) 将显示为 John，而不是 John\0\0\0\0。

如果将其设为 true，TSV 格式的行尾将使用 \r\n，而不是 \n。

如果为 true，则将 ' 转义为 ''；否则使用 \' 进行转义

在适用的输出格式中写入有关已读取行数、字节数和耗时的统计信息。

默认启用