Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

настройки сеанса s3_*

Эти настройки доступны в system.settings и автоматически генерируются из исходного кода.

s3_base

История версий
ВерсияЗначение по умолчаниюКомментарий
26.8Новая настройка для указания базового URL, используемого для разрешения относительных URL в табличной функции s3 и движке таблицы S3.

Базовый URL для разрешения относительных URL в табличной функции s3 и движке таблицы S3, а также в табличных функциях, использующих ту же конфигурацию (s3Cluster, gcs, oss).

Если настройка задана, URL без схемы разрешается относительно s3_base в соответствии с RFC 3986 по тем же правилам, что и url_base. URL, уже содержащие схему, используются без изменений.

Например, если s3_base имеет значение s3://clickhouse-public-datasets/, то s3('hits_compatible/hits.csv') читает данные из s3://clickhouse-public-datasets/hits_compatible/hits.csv.

Базовый URL может быть задан в любом формате, поддерживаемом табличной функцией s3, например s3://bucket/, https://bucket.s3.amazonaws.com/ или https://endpoint/bucket/.

s3_check_objects_after_upload

Тип
Bool
По умолчанию
0

Проверять каждый объект, загруженный в S3, с помощью запроса head, чтобы убедиться, что загрузка выполнена успешно

s3_connect_timeout_ms

Тип
UInt64
По умолчанию
1000
История версий
ВерсияЗначение по умолчаниюКомментарий
24.31000Добавлена новая отдельная настройка тайм-аута подключения к S3

Тайм-аут подключения к хосту, используемому S3-дисками.

s3_create_new_file_on_insert

Тип
Bool
По умолчанию
0

Включает или отключает создание нового файла при каждой вставке в таблицы с движком S3. Если параметр включен, при каждой вставке будет создаваться новый объект S3 с ключом по следующему шаблону:

исходно: data.Parquet.gz -> data.1.Parquet.gz -> data.2.Parquet.gz и т. д.

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

  • 0 — запрос INSERT создает новый файл или завершается ошибкой, если файл уже существует и параметр s3_truncate_on_insert не задан.
  • 1 — запрос INSERT создает новый файл при каждой вставке, используя суффикс (начиная со второго файла), если параметр s3_truncate_on_insert не задан.

Подробнее см. здесь.

s3_disable_checksum

Тип
Bool
По умолчанию
0

Не вычислять контрольную сумму при отправке файла в S3. Это ускоряет операции записи, так как позволяет избежать лишних проходов по файлу при его обработке. В большинстве случаев это безопасно, поскольку данные таблиц семейства MergeTree в любом случае защищены контрольными суммами в ClickHouse, а при доступе к S3 по HTTPS уровень TLS уже обеспечивает целостность данных при передаче по сети. При этом дополнительные контрольные суммы в S3 обеспечивают эшелонированную защиту.

s3_ignore_file_doesnt_exist

Тип
Bool
По умолчанию
0
История версий
ВерсияЗначение по умолчаниюКомментарий
24.60Позволяет возвращать 0 строк, если запрошенные файлы не существуют, вместо того чтобы генерировать исключение в движке таблицы S3

Игнорирует отсутствие файла при чтении определённых ключей, если файл не существует.

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

  • 1 — SELECT возвращает пустой результат.
  • 0 — SELECT генерирует исключение.

s3_list_object_keys_size

Тип
UInt64
По умолчанию
1000

Максимальное количество файлов, которое запрос ListObject может вернуть в одном батче

s3_min_upload_part_size

Тип
UInt64
По умолчанию
16777216

Минимальный размер части, загружаемой при multipart-загрузке в S3.

s3_path_filter_limit

Тип
UInt64
По умолчанию
1000
История версий
ВерсияЗначение по умолчаниюКомментарий
25.121000новая настройка

Максимальное количество значений _path, которые можно извлечь из фильтров запроса, чтобы использовать их при переборе файлов вместо перечисления через glob. 0 означает, что параметр отключён.

s3_request_timeout_ms

Тип
UInt64
По умолчанию
30000

Тайм-аут простоя при отправке и получении данных в/из S3. Операция завершается с ошибкой, если один вызов TCP на чтение или запись блокируется на это время.

s3_skip_empty_files

Тип
Bool
По умолчанию
1
История версий
ВерсияЗначение по умолчаниюКомментарий
24.111Надеемся, это улучшит UX

Включает или отключает пропуск пустых файлов в таблицах с движком S3.

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

  • 0 — SELECT генерирует исключение, если пустой файл несовместим с запрошенным форматом.
  • 1 — SELECT возвращает пустой результат для пустого файла.

s3_slow_all_threads_after_network_error

Тип
Bool
По умолчанию
1
История версий
ВерсияЗначение по умолчаниюКомментарий
25.51новая настройка

Если установлено значение true, все потоки, выполняющие S3-запросы к одной и той же конечной точке резервной копии, замедляются после того, как в любом отдельном S3-запросе возникает сетевая ошибка, допускающая повторную попытку, например тайм-аут сокета. Если установлено значение false, каждый поток обрабатывает задержку S3-запросов независимо от остальных.

s3_strict_upload_part_size

Тип
UInt64
По умолчанию
0

Точный размер части, загружаемой при multipart-загрузке в S3 (некоторые реализации не поддерживают части переменного размера).

s3_throw_on_zero_files_match

Тип
Bool
По умолчанию
0

Сгенерировать исключение, если запрос ListObjects не находит ни одного подходящего файла

s3_truncate_on_insert

Тип
Bool
По умолчанию
0

Включает или отключает усечение перед вставкой в таблицы с движком S3. Если параметр отключён, при попытке вставки будет сгенерировано исключение, если объект S3 уже существует.

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

  • 0 — запрос INSERT создаёт новый файл или завершается ошибкой, если файл уже существует и параметр s3_create_new_file_on_insert не задан.
  • 1 — запрос INSERT заменяет существующее содержимое файла новыми данными.

Подробнее см. здесь.

s3_uri_style

Тип
S3UriStyle
По умолчанию
auto
История версий
ВерсияЗначение по умолчаниюКомментарий
26.4autoНовая настройка.

Принудительно задаёт стиль адресации для конечной точки S3. Возможные значения: auto, virtual_hosted, path.

s3_use_adaptive_timeouts

Тип
Bool
По умолчанию
1

Если установлено значение true, то для всех запросов к S3 первые две попытки выполняются с короткими тайм-аутами отправки и получения. Если установлено значение false, то все попытки выполняются с одинаковыми тайм-аутами.

Navigation