Перейти к основному содержимому
Перейти к основному содержимому

Условие INTO OUTFILE

Условие INTO OUTFILE перенаправляет результат запроса SELECT в файл на стороне клиента.

Поддерживаются сжатые файлы. Тип сжатия определяется по расширению имени файла (по умолчанию используется режим 'auto'). Либо его можно явно указать в условии COMPRESSION. Уровень сжатия для определенного типа сжатия может быть указан в условии LEVEL.

Синтаксис

SELECT <expr_list> INTO OUTFILE file_name [AND STDOUT] [APPEND | TRUNCATE] [COMPRESSION type [LEVEL level]]

file_name и type являются строковыми литералами. Поддерживаемые типы сжатия: 'none', 'gzip', 'deflate', 'br', 'xz', 'zstd', 'lz4', 'bz2'.

level — это числовой литерал. Поддерживаются положительные целые числа в следующих диапазонах: 1-12 для типа lz4, 1-22 для типа zstd и 1-9 для других типов сжатия.

Подробности реализации​

  • Эта функциональность доступна в командной строке клиента и clickhouse-local. Поэтому запрос, отправленный через HTTP интерфейс, будет завершен с ошибкой.
  • Запрос завершится с ошибкой, если файл с тем же именем уже существует.
  • Формат по умолчанию для вывода — TabSeparated (так же, как в пакетном режиме командного клиента). Используйте условие FORMAT, чтобы изменить его.
  • Если в запросе упоминается AND STDOUT, то вывод, который записывается в файл, также отображается на стандартном выводе. Если используется сжатие, то текст в открытом виде отображается на стандартном выводе.
  • Если в запросе упоминается APPEND, то вывод добавляется к существующему файлу. Если используется сжатие, добавление не может быть использовано.
  • При записи в файл, который уже существует, необходимо использовать APPEND или TRUNCATE.

Пример

Выполните следующий запрос, используя командную строку клиента:

clickhouse-client --query="SELECT 1,'ABC' INTO OUTFILE 'select.gz' FORMAT CSV;"
zcat select.gz

Результат:

1,"ABC"