Настройки формата output_format_*

Эти настройки сгенерированы автоматически из исходного кода.

Всегда выводить десятичную точку для чисел с плавающей запятой и чисел типа Decimal в текстовых форматах, даже если значение является целым числом. Например, выводить 1. вместо 1.

По умолчанию отключено.

Метод сжатия для формата вывода Arrow. Поддерживаемые кодеки: lz4_frame, zstd, none (без сжатия)

Записывает значения Date как обычные 16-битные числа (при обратном чтении — как UInt16), а не преобразует их в 32-битный тип Arrow DATE32 (при обратном чтении — как Date32).

Использовать тип Arrow FIXED_SIZE_BINARY вместо Binary для столбцов FixedString.

Включает вывод типа LowCardinality как типа Dictionary Arrow

Использовать тип Arrow String вместо Binary для столбцов String

Выводить типы, для которых нет преобразования, в виде необработанных двоичных данных. Если false — такие типы будут вызывать исключение UNKNOWN_TYPE.

Всегда использовать 64-битные целые числа для индексов словаря в формате Arrow

Использовать знаковые целые числа для индексов словарей в формате Arrow

Кодек сжатия, используемый для вывода данных. Возможные значения: 'null', 'deflate', 'snappy', 'zstd'.

Для формата вывода AvroConfluent: subject, под которым схема регистрируется в Confluent Schema Registry. Обязательно при записи вывода AvroConfluent.

Максимальное число строк в файле (если это поддерживается хранилищем)

Для формата Avro: шаблон регулярного выражения для столбцов типа String, которые следует выбирать как строки AVRO.

Интервал синхронизации, в байтах.

Записывает типы данных в двоичном формате вместо имён типов в формате вывода RowBinaryWithNamesAndTypes

Записывает значения типа данных JSON в виде значений JSON String в формате вывода RowBinary.

Использовать тип BSON String вместо Binary для столбцов типа String.

Уровень сжатия по умолчанию, если вывод запроса сжат. Эта настройка применяется, когда запрос SELECT содержит INTO OUTFILE или при записи в табличные функции file, url, hdfs, s3 или azureBlobStorage.

Возможные значения: от 1 до 22

Можно использовать, если для вывода выбран метод сжатия zstd. Если значение больше 0, этот параметр явно задаёт размер окна сжатия (степень 2) и включает для сжатия zstd режим дальнего диапазона. Это может помочь добиться более высокого коэффициента сжатия.

Возможные значения: неотрицательные числа. Обратите внимание: если значение слишком маленькое или слишком большое, zstdlib сгенерирует исключение. Обычно используются значения от 20 (размер окна = 1MB) до 30 (размер окна = 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 верхнего уровня.

Примечание: раскрытый заголовок не считывается обратно в Tuple по имени, когда input_format_with_names_use_header = 1. Чтобы прочитать такие данные обратно в Tuple, либо установите для этой настройки значение 0 при выводе, либо читайте с input_format_with_names_use_header = 0 (а для форматов *WithNamesAndTypes — CSVWithNamesAndTypes и CustomSeparatedWithNamesAndTypes — также input_format_with_types_use_header = 0, поскольку иначе раскрытая строка типов будет проверяться на соответствие единственному входному полю Tuple верхнего уровня и будет отклонена).

Если установлено значение true, то обычные столбцы Tuple в формате CSV сериализуются как отдельные столбцы (то есть их вложенность в Tuple теряется).

Это преобразование применяется только к обычному Tuple. Nullable(Tuple) всегда сериализуется как одно поле CSV (чтобы строки с NULL и не-NULL занимали одинаковое число полей) независимо от этой настройки.

Выводить конечные нули при отображении значений Decimal. Например, 1.230000 вместо 1.23.

По умолчанию отключено.

Если значение не равно нулю, вывод чисел с плавающей запятой (Float32, Float64, BFloat16) форматируется максимум с таким количеством знаков после десятичной точки (конечные нули удаляются). Если значение равно 0 (по умолчанию), используется кратчайшее представление, допускающее точное восстановление значения.

Значения, слишком большие для записи в фиксированном формате, а также значения, модуль которых настолько мал, что округление до запрошенной точности привело бы к потере всех значащих цифр (мантисса стала бы ±0), вместо этого выводятся в научной нотации. В этих случаях мантисса может содержать больше знаков дробной части, чем указано в запрошенной точности.

Допустимый диапазон: от 0 до 100.

Высота выходного изображения в пикселях для форматов вывода изображений, таких как PNG.

Значение по умолчанию: 1024.

Для форматов вывода изображений, таких как PNG, записывать каждый кадр анимации сразу после появления следующего значения в столбце t вместо буферизации всех кадров в памяти до завершения запроса.

В памяти хранится только один кадр, а кадры выводятся ещё во время выполнения запроса. Взамен значения t должны быть неубывающими, иначе запрос генерирует исключение. Кроме того, на момент записи заголовка анимации число кадров неизвестно, поэтому указанное число кадров является верхней границей, а не точным значением. Браузеры воспроизводят такой файл, но декодеры, полагающиеся на указанное число кадров, сообщают об ошибке после последнего фактического кадра.

Значение по умолчанию: false.

Для форматов вывода изображений, таких как PNG, выводить изображение прямо в терминал с помощью inline-протокола изображений вместо записи сырых байтов изображения.

Возможные значения:

• `` (пусто) — записывать сырые байты изображения (по умолчанию).
• iterm — использовать inline-протокол изображений iTerm2.
• kitty — использовать графический протокол Kitty.
• sixel — использовать протокол Sixel.
• auto — если вывод направлен в терминал, определить его возможности и использовать iterm, kitty или sixel (в этом порядке); в противном случае записывать сырые байты изображения.

Значение по умолчанию: `` (пусто).

Знаменатель единицы времени столбца t в секундах для форматов вывода изображений, таких как PNG.

См. output_format_image_time_multiplier_seconds.

Значение по умолчанию: 60.

Числитель единицы времени для столбца t в секундах для форматов вывода изображений, таких как PNG.

При наличии столбца t формат создаёт анимацию, в которой t задаёт относительное смещение времени кадра. Одна единица t соответствует output_format_image_time_multiplier_seconds / output_format_image_time_divisor_seconds секундам. При значениях по умолчанию (1 и 60) одна единица t равна 1/60 секунды.

Значение по умолчанию: 1.

Ширина выводимого изображения в пикселях для форматов вывода изображений, таких как PNG.

Значение по умолчанию: 1024.

Включает вывод всех строк в виде JSON-массива в формате JSONEachRow.

Возможные значения:

• 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 в JSON-массивы кортежей.

Отключено по умолчанию.

Сериализует столбцы именованных кортежей как объекты JSON.

Включено по умолчанию.

Этот параметр определяет, как вложенные структуры, такие как Tuples, Maps и Arrays, отображаются в массиве data при использовании формата вывода JSON.

Например, вместо вывода:

"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
        }
    }
],

Включено по умолчанию.

Управляет тем, будут ли 64-битные числа с плавающей точкой заключаться в кавычки при выводе в форматах JSON*.

По умолчанию отключено.

Управляет тем, будут ли 64-битные и более крупные целые числа (например, UInt64 или Int128) заключаться в кавычки при выводе в формате JSON. По умолчанию такие целые числа заключаются в кавычки. Такое поведение совместимо с большинством реализаций JavaScript.

Возможные значения:

• 0 — Целые числа выводятся без кавычек.
• 1 — Целые числа заключаются в кавычки.

Управляет выводом десятичных чисел в кавычках в формате вывода JSON.

Отключено по умолчанию.

Включает вывод значений +nan, -nan, +inf, -inf в формате вывода JSON.

Возможные значения:

• 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
        }
}

Пропускать пары ключ-значение со значением NULL при сериализации столбцов именованных кортежей в виде объектов JSON. Действует только если output_format_json_named_tuples_as_objects имеет значение true.

Управляет проверкой последовательностей UTF-8 в формате вывода JSON и не влияет на форматы JSON/JSONCompact/JSONColumnsWithMetadata — в них проверка UTF-8 выполняется всегда.

По умолчанию отключено.

Если включено, специальные символы в Markdown экранируются.

Common Mark определяет следующие специальные символы, которые можно экранировать с помощью :

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

Возможные значения:

• 0 — Отключено.
• 1 — Включено.

Способ представления UUID в формате MsgPack при выводе.

Записывает типы данных в двоичном виде вместо имён типов в формате вывода Native

Записывает данные из столбцов JSON и Dynamic в уплощенном формате (все типы/пути — как отдельные подстолбцы).

Записывает данные JSON столбца как столбец String, содержащий JSON-строки, вместо стандартной нативной JSON-сериализации.

Размер блока сжатия в байтах для формата вывода ORC.

Метод сжатия для выходного формата ORC. Поддерживаемые кодеки: lz4, snappy, zlib, zstd, none (без сжатия)

Для строкового столбца в формате вывода ORC: если число различных значений превышает эту долю от общего числа строк с не-NULL значениями, кодирование с использованием словаря отключается. В противном случае оно включается

Целевой шаг индекса строк для выходного формата ORC

Использовать тип ORC String вместо Binary для столбцов String

Название часового пояса для ORC writer; часовой пояс ORC writer по умолчанию — GMT.

Включает или отключает параллельное форматирование данных. Поддерживается только для форматов TSV, TSKV, CSV и JSONEachRow.

Возможные значения:

• 1 — Включено.
• 0 — Отключено.

Проверять размер страницы через каждые столько строк. Рассмотрите возможность уменьшить значение, если у вас есть столбцы, у которых средний размер значений превышает несколько КБ.

Приблизительное количество битов для каждого уникального значения в bloom-фильтрах Parquet. Оценочные уровни ложноположительных срабатываний:

• 6 бит — 10%
• 10.5 бита — 1%
• 16.9 бита — 0.1%
• 26.4 бита — 0.01%
• 41 бит — 0.001%

Где в файле Parquet размещать bloom-фильтры. Bloom-фильтры будут записываться порциями примерно такого размера. В частности:

• если значение равно 0, bloom-фильтры каждой группы строк записываются сразу после соответствующей группы строк,
  • если значение больше общего размера всех bloom-фильтров, bloom-фильтры для всех групп строк будут накапливаться в памяти, а затем записываться вместе ближе к концу файла,
  • в противном случае bloom-фильтры будут накапливаться в памяти и записываться, как только их общий размер превысит это значение.

Метод сжатия для выходного формата Parquet. Поддерживаемые кодеки: snappy, lz4, brotli, zstd, gzip, none (без сжатия)

Целевой размер страницы в байтах до сжатия.

Записывать значения Date как простые 16-битные числа (при чтении возвращаются как UInt16) вместо преобразования в 32-битный тип DATE в Parquet (при чтении возвращается как Date32).

Записывает значения DateTime как исходную Unix-временную метку (при обратном чтении — как UInt32), а не преобразует их в миллисекунды (при обратном чтении — как DateTime64(3)).

Записывать enum с использованием физического типа Parquet: BYTE_ARRAY и логического типа: ENUM

Использовать тип Parquet FIXED_LEN_BYTE_ARRAY вместо Binary для столбцов типа FixedString.

Позволяет записывать информацию о геопространственных столбцах в метаданные Parquet и кодировать столбцы в формате WKB.

Если размер словаря превышает указанное количество байт, используется кодирование без словаря. Установите значение 0, чтобы отключить кодирование с использованием словаря.

Выполняет кодирование Parquet в нескольких потоках.

Целевой размер группы строк в количестве строк.

Целевой размер группы строк в байтах, до сжатия.

Использовать тип String в Parquet вместо Binary для столбцов String.

Записывать значения Int128, UInt128, Int256 и UInt256 как соответствующие стандарту Parquet значения DECIMAL с порядком байтов big-endian. Значение по умолчанию сохраняет устаревшее представление FIXED_LEN_BYTE_ARRAY без аннотации в порядке little-endian для совместимости со старыми версиями ClickHouse. Десятичное представление обеспечивает совместимость числовой статистики, однако некоторые ридеры Parquet не поддерживают точность свыше 38 или 76.

Записывать bloom-фильтры в файлы Parquet.

Добавляет контрольные суммы CRC32 в заголовки страниц Parquet.

Записывает индекс столбцов и индекс смещений (то есть статистику по каждой странице данных, которую можно использовать для pushdown фильтров при чтении) в файлы Parquet.

Использовать ANSI-последовательности экранирования в форматах Pretty. 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 (по умолчанию).

В interactive mode clickhouse-client автоматически переключается на ASCII, если терминал не поддерживает UTF-8 (это определяется переменными окружения 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 будут отображать многострочные поля внутри ячейки таблицы, благодаря чему сохранятся границы таблицы. Если нет, они будут отображаться как есть, что может исказить таблицу (при этом у отключения этой настройки есть и плюс: многострочные значения будет проще копировать и вставлять).

Определяет, выводятся ли именованные Tuple в формате Pretty в виде красиво отформатированных объектов JSON.

Добавляет номера перед каждой строкой в формате вывода Pretty

Выводить справа от таблицы понятную числовую подсказку, если блок состоит из одного числа, превышающего это значение (кроме 0)

Ожидает следующий блок в течение указанного количества миллисекунд и перед выводом объединяет его с предыдущим. Это позволяет избежать слишком частого вывода слишком маленьких блоков, сохраняя при этом возможность отображать данные в режиме стриминга.

Выводить отложенный блок в форматах Pretty, если с момента предыдущего вывода прошло больше указанного количества миллисекунд.

Если включено, дополнение в форматах вывода Pretty отображается с помощью U+00A0 вместо пробела ASCII. В моноширинном шрифте вывод визуально остается тем же, но дополнение сохраняется при использовании инструментов, которые сжимают или обрезают последовательности обычных пробелов. Действует только если output_format_pretty_grid_charset имеет значение UTF-8.

При сериализации столбцов с типом Nullable с помощью обёрток Google значения по умолчанию сериализуются как пустые обёртки. Если этот параметр отключён, значения по умолчанию и значения NULL не сериализуются

Путь к файлу, в который будет сохранена автоматически сгенерированная схема в формате Cap'n Proto или Protobuf.

Добавлять имена столбцов в запрос INSERT

Максимальное количество строк в одном операторе INSERT.

Заключать имена столбцов в символы «`»

Название таблицы в выводимом запросе INSERT

Использовать оператор REPLACE вместо оператора INSERT

Удаляет завершающие null-байты из значений FixedString в текстовых форматах вывода. Например, toFixedString('John', 8) выводится как John, а не John\0\0\0\0.

Если установлено значение true, в формате TSV в качестве конца строки будет использоваться \r\n вместо \n.

Если true, экранировать ' как '', иначе использовать \'

Записывает статистику о количестве прочитанных строк, байтов и затраченном времени в подходящих форматах вывода.

Включено по умолчанию