フォーマット設定 - ClickHouse Documentation

これらの設定は、ソースコードから自動生成されています。

allow_special_bool_values_inside_variant

“on”、“off”、“enable”、“disable” などの特殊なテキスト表現の bool 値を、Variant 型内の Bool 値としてパースできるようにします。

bool_false_representation

TSV/CSV/Vertical/Pretty フォーマットで bool の false 値を表すテキスト。

bool_true_representation

TSV/CSV/Vertical/Pretty フォーマットで、bool 型の true 値を表すテキスト。

check_conversion_from_numbers_to_enum

値が Enum に存在しない場合、Numbers から Enum への変換時に例外を発生させます。設定可能な値:

0 — 無効。
1 — 有効。

例

CREATE TABLE tab (
  val Enum('first' = 1, 'second' = 2, 'third' = 3)
) ENGINE = Memory;

INSERT INTO tab SETTINGS check_conversion_from_numbers_to_enum = 1 VALUES (4); -- エラーを返す

column_names_for_schema_inference

カラム名を持たないフォーマットのスキーマ推論で使用するカラム名の一覧です。フォーマット: ‘column1,column2,column3,…‘

date_time_64_output_format_cut_trailing_zeros_align_to_groups_of_thousands

datetime64 値の末尾のゼロを動的に削除し、出力の scale を [0, 3, 6] に調整します。それぞれ ‘秒’、‘ミリ秒’、‘マイクロ秒’ に対応します。

date_time_input_format

日付と時刻のテキスト表現を解析するパーサーを選択できます。この設定は日付と時刻の関数には適用されません。設定可能な値:

'best_effort' — 拡張パースを有効にします。 ClickHouse は基本的な YYYY-MM-DD HH:MM:SS フォーマットと、すべての ISO 8601 の日付・時刻フォーマットをパースできます。たとえば、'2018-06-08T01:02:03.000Z' です。
'best_effort_us' — best_effort と似ています (違いについては parseDateTimeBestEffortUS を参照してください)
'basic' — 基本パーサーを使用します。 ClickHouse は基本的な YYYY-MM-DD HH:MM:SS または YYYY-MM-DD フォーマットのみをパースできます。たとえば、2019-08-20 10:18:56 または 2019-08-20 です。

date_time_output_format

日付と時刻のテキスト表現の出力フォーマットを選択できます。設定可能な値:

simple - シンプルな出力フォーマット。 ClickHouse は、日付と時刻を YYYY-MM-DD hh:mm:ss フォーマットで出力します。たとえば、2019-08-20 10:18:56 です。計算は、データ型の time zone (存在する場合) または server の time zone に基づいて行われます。
iso - ISO 出力フォーマット。 ClickHouse は、日付と時刻を ISO 8601 の YYYY-MM-DDThh:mm:ssZ フォーマットで出力します。たとえば、2019-08-20T10:18:56Z です。出力は UTC であることに注意してください (Z は UTC を意味します) 。
unix_timestamp - Unix timestamp 出力フォーマット。 ClickHouse は、日付と時刻を Unix timestamp フォーマットで出力します。たとえば、1566285536 です。

date_time_overflow_behavior

Date、Date32、DateTime、DateTime64、または整数を Date、Date32、DateTime、DateTime64 に変換する際に、値が結果の型で表現できない場合の動作を定義します。設定可能な値:

ignore — オーバーフローを暗黙的に無視します。結果は未定義です。
throw — オーバーフローが発生した場合に例外をスローします。
saturate — 結果を飽和させます。値が対象の型で表現可能な最小値より小さい場合、結果は表現可能な最小値になります。値が対象の型で表現可能な最大値より大きい場合、結果は表現可能な最大値になります。

デフォルト値: ignore。

errors_output_format

エラーをテキスト出力に書き込む方法。

format_avro_schema_registry_connection_timeout

AvroConfluent フォーマット用の設定です。Confluent スキーマレジストリ HTTP クライアントの接続タイムアウトを秒単位で指定します。スキーマの取得とスキーマ登録の両方で使用されます。0 より大きく、600 (10 分) 未満である必要があります。

format_avro_schema_registry_receive_timeout

AvroConfluent フォーマットで使用される Confluent スキーマレジストリ HTTP クライアントの受信タイムアウト (秒単位) です。スキーマの取得と登録の両方で使用されます。0 より大きく、600 (10 分) 未満である必要があります。

format_avro_schema_registry_send_timeout

AvroConfluent フォーマットで使用される Confluent スキーマレジストリ HTTP クライアントの送信タイムアウト (秒単位) です。スキーマの取得とスキーマ登録の両方に使用されます。0 より大きく、600 (10 分) 未満である必要があります。

format_avro_schema_registry_url

AvroConfluent フォーマット用: Confluent スキーマレジストリの URL。

format_binary_max_array_size

RowBinary フォーマットにおける Array の最大許容サイズです。データが破損している場合に、大量のメモリが割り当てられるのを防ぎます。0 は制限なしを意味します

format_binary_max_object_size

JSON type の RowBinary フォーマットにおいて、単一の Object に含められるパスの最大数です。破損したデータによって大量のメモリが割り当てられるのを防ぎます。0 は無制限を意味します

format_binary_max_string_size

RowBinary フォーマットにおける String の最大許容サイズです。破損したデータの場合に大量のメモリが割り当てられるのを防ぎます。0 は制限がないことを意味します

format_capn_proto_enum_comparising_mode

ClickHouse Enum と CapnProto Enum の対応付け方法

format_capn_proto_max_message_size

単一の CapnProto メッセージの最大サイズ (バイト単位) です。これは、不正なデータや破損したデータによって過剰なメモリ割り当てが発生するのを防ぎます。デフォルト値は 1 GiB です。

format_capn_proto_use_autogenerated_schema

format_schema が未設定の場合、自動生成された CapnProto スキーマを使用します

format_csv_allow_double_quotes

true に設定すると、ダブルクォートで囲まれた文字列を許可します。

format_csv_allow_single_quotes

true に設定すると、シングルクォートで囲まれた文字列を許可します。

format_csv_delimiter

CSVデータで区切り文字として扱う文字を指定します。文字列で設定する場合、その長さは1である必要があります。

format_csv_null_representation

CSVフォーマットにおけるカスタムNULL表現

format_custom_escaping_rule

フィールドのエスケープルール (CustomSeparated フォーマット)

format_custom_field_delimiter

フィールド間の区切り文字 (CustomSeparated フォーマット)

format_custom_result_after_delimiter

結果セットの後に付く接尾辞 (CustomSeparated フォーマット用)

format_custom_result_before_delimiter

結果セットの前に付加されるプレフィックス (CustomSeparated フォーマット用)

format_custom_row_after_delimiter

最後のカラムのフィールドの後ろに付く区切り文字 (CustomSeparated フォーマット)

format_custom_row_before_delimiter

最初のカラムのフィールドの前に置かれる区切り文字 (CustomSeparated フォーマット)

format_custom_row_between_delimiter

行と行の間の区切り文字 (CustomSeparated フォーマット用)

format_display_secrets_in_show_and_select

テーブル、データベース、テーブル関数、Dictionaries に対する SHOW および SELECT クエリでシークレットを表示するかどうかを有効または無効にします。シークレットを表示するには、ユーザーに対して次の設定と権限も必要です。 display_secrets_in_show_and_select server setting が有効になっており、さらに displaySecretsInShowAndSelect 権限を持っている必要があります。設定可能な値:

0 — 無効。
1 — 有効。

format_json_object_each_row_column_for_object_name

JSONObjectEachRowフォーマットで、オブジェクト名の保存/書き込みに使用するカラム名です。カラムの型は String である必要があります。値が空の場合、オブジェクト名にはデフォルトの名前 row_{i} が使用されます。

format_protobuf_use_autogenerated_schema

format_schema が設定されていない場合、自動生成された Protobuf を使用します

format_regexp

正規表現 (Regexp フォーマット用)

format_regexp_escaping_rule

フィールドのエスケープルール (Regexp フォーマット用)

format_regexp_skip_unmatched

正規表現に一致しない行をスキップします (Regexp フォーマット)

format_schema

このパラメーターは、Cap’n Proto や Protobuf など、スキーマ定義を必要とするフォーマットを使用する場合に役立ちます。値はフォーマットによって異なります。

format_schema_message_name

format_schema で定義したスキーマ内で必要なメッセージ名を指定します。従来の format_schema 形式 (file_name:message_name) との互換性を維持するため、次のようになります。

format_schema_message_name が指定されていない場合、メッセージ名は従来の format_schema の値に含まれる message_name 部分から推論されます。
従来の形式の使用時に format_schema_message_name を指定すると、エラーになります。

format_schema_source

format_schema の取得元を定義します。設定可能な値:

‘file’ (デフォルト) : format_schema は、format_schemas ディレクトリ内にあるスキーマファイルの名前です。
‘string’: format_schema は、スキーマの内容をそのまま記述した文字列です。
‘query’: format_schema は、スキーマを取得するためのクエリです。 format_schema_source が ‘query’ に設定されている場合は、以下の条件が適用されます:
クエリは、単一の文字列カラムを持つ 1 行、つまり値をちょうど 1 つだけ返す必要があります。
クエリの結果は、スキーマの内容として扱われます。
この結果は、format_schemas ディレクトリにローカルでキャッシュされます。
コマンド SYSTEM DROP FORMAT SCHEMA CACHE FOR Files を使用して、ローカル cache をクリアできます。
一度キャッシュされると、キャッシュが明示的にクリアされるまで、同一のクエリがスキーマ取得のために再度実行されることはありません
ローカルのキャッシュファイルに加えて、Protobuf メッセージもメモリ内にキャッシュされます。ローカルのキャッシュファイルをクリアした後でも、スキーマを完全に更新するには、SYSTEM DROP FORMAT SCHEMA CACHE [FOR Protobuf] を使用してメモリ内キャッシュもクリアする必要があります。
クエリ SYSTEM DROP FORMAT SCHEMA CACHE を実行すると、キャッシュファイルと Protobuf メッセージスキーマの両方のキャッシュを一度にクリアできます。

format_template_resultset

結果セットのフォーマット文字列を含むファイルへのパス (Templateフォーマット用)

format_template_resultset_format

結果セットのフォーマット文字列 (Template フォーマット用)

format_template_row

行用のフォーマット文字列が含まれるファイルへのパス (Template フォーマット用)

format_template_row_format

行のフォーマット文字列 (Template フォーマット用)

format_template_rows_between_delimiter

行と行の間の区切り文字 (Template フォーマット用)

format_tsv_null_representation

TSVフォーマットでのカスタムNULL表現

input_format_allow_errors_num

テキストフォーマット (CSV、TSV など) の読み込み時に許容されるエラーの最大数を設定します。デフォルト値は 0 です。必ず input_format_allow_errors_ratio と組み合わせて使用してください。行の読み込み中にエラーが発生しても、エラーカウンターがまだ input_format_allow_errors_num 未満であれば、ClickHouse はその行を無視して次の行に進みます。 input_format_allow_errors_num と input_format_allow_errors_ratio の両方を超えた場合、ClickHouse は例外をスローします。

input_format_allow_errors_ratio

テキストフォーマット (CSV、TSV など) の読み取り時に許容されるエラーの最大割合を設定します。エラーの割合は、0 から 1 までの浮動小数点数で指定します。デフォルト値は 0 です。必ず input_format_allow_errors_num と組み合わせて使用してください。行の読み取り中にエラーが発生しても、エラーカウンターが input_format_allow_errors_ratio 未満であれば、ClickHouse はその行を無視して次の行の読み取りを続けます。 input_format_allow_errors_num と input_format_allow_errors_ratio の両方のしきい値を超えた場合、ClickHouse は例外をスローします。

input_format_allow_seeks

ORC、Parquet、Arrow の入力フォーマットの読み取り時に、シーク (または範囲読み取り) を許可します。有効で、かつソースがこれをサポートしている場合 (たとえば、ローカルファイル、S3、範囲指定をサポートしサイズが判明している HTTP) 、 ClickHouse は必要なバイト範囲だけを読み取り、メモリ使用量を削減できます。無効な場合、またはソースがシークをサポートしていない場合 (たとえば、ファイルサイズが不明な場合や、ストリームがシーク不可の場合) 、一部のリーダーでは、ファイル全体をメモリに読み込む動作にフォールバックすることがあります。デフォルトで有効です。

input_format_arrow_allow_missing_columns

Arrow 入力フォーマットの読み取り時に、欠落したカラムを許可します

input_format_arrow_case_insensitive_column_matching

Arrow のカラムと CH のカラムの照合時に、大文字と小文字を区別しません。

input_format_arrow_skip_columns_with_unsupported_types_in_schema_inference

Arrowフォーマットでスキーマ推論を行う際、サポートされていない型のカラムをスキップします

input_format_avro_allow_missing_fields

Avro/AvroConfluent フォーマットの場合: フィールドがスキーマ内に見つからない場合、エラーではなくデフォルト値を使用します

input_format_avro_null_as_default

Avro/AvroConfluent フォーマット: NULL かつ Nullable ではない列の場合、デフォルト値を挿入します

input_format_binary_decode_types_in_binary_format

RowBinaryWithNamesAndTypes 入力フォーマットで、型名の代わりにデータ型をバイナリ形式で読み取ります

input_format_binary_max_type_complexity

バイナリ型のデコード時における型ノードの最大数 (深さではなく総数) 。Map(String, UInt32) = 3ノード。悪意のある入力から保護します。0 = 無制限。

input_format_binary_read_json_as_string

RowBinary入力フォーマットで、JSON データ型の値を JSON String 値として読み取ります。

input_format_bson_skip_fields_with_unsupported_types_in_schema_inference

BSON フォーマットのスキーマ推論時に、未対応の型を持つフィールドをスキップします。

input_format_capn_proto_skip_fields_with_unsupported_types_in_schema_inference

CapnProtoフォーマットのスキーマ推論時に、未対応の型のカラムをスキップします

input_format_column_name_matching_mode

各種フォーマット (JSONEachRow、CSVWithNames、JSONColumns、BSONEachRow、RowBinaryWithNames など) でデータを取り込む際のカラム名の照合モードを定義します。サポートされるモード:

match_case: 大文字と小文字を区別して照合します
- ignore_case: 大文字と小文字を区別せずに照合します
- auto: まず大文字と小文字を区別して照合し、失敗した場合は大文字と小文字を区別せずに照合します。

input_format_connection_handling

このオプションを有効にすると、接続が予期せず閉じた場合、バッファ内に残っているデータはエラーとして扱われず、パースおよび処理されます

このオプションを有効にすると、並列パースが無効になり、重複排除はできなくなります

input_format_csv_allow_cr_end_of_line

true に設定すると、後続文字のない行末の \r を許可します

input_format_csv_allow_variable_number_of_columns

CSV入力で余分なカラムがある場合 (ファイルに想定より多くのカラムが含まれている場合) はそれらを無視し、CSV入力で欠落しているフィールドはデフォルト値として扱います

input_format_csv_allow_whitespace_or_tab_as_delimiter

CSV文字列で、フィールドの区切り文字としてスペースおよびタブ(\t)を使えるようにします

input_format_csv_arrays_as_nested_csv

CSV から Array を読み取る際、要素がネストされた CSV としてシリアライズされたうえで文字列に格納されていることを想定します。例: ”[""Hello"", ""world"", ""42"""" TV""]“。配列を囲む角括弧は省略できます。

input_format_csv_deserialize_separate_columns_into_tuple

true に設定すると、CSVフォーマットで記述された個別のカラムを Tuple カラムとしてデシリアライズできます。

input_format_csv_detect_header

CSVフォーマット内の名前と型を含むヘッダーを自動的に検出します

input_format_csv_empty_as_default

CSV入力の空のフィールドをデフォルト値として扱います。

input_format_csv_enum_as_number

CSVフォーマットで挿入されるenum値を、enumのインデックスとして扱います

input_format_csv_skip_first_lines

CSVフォーマットのデータ先頭で、指定した行数をスキップします

input_format_csv_skip_trailing_empty_lines

CSVフォーマットの末尾にある空行をスキップします

input_format_csv_trim_whitespaces

CSVの文字列の先頭と末尾にあるスペースおよびタブ (\t) 文字を削除します

input_format_csv_try_infer_numbers_from_strings

有効にすると、スキーマ推論時に ClickHouse は文字列フィールドから数値を推論しようとします。 CSV データに引用符で囲まれた UInt64 値が含まれている場合に役立ちます。デフォルトでは無効です。

input_format_csv_try_infer_strings_from_quoted_tuples

入力データ内の引用符付き Tuple を、String 型の値として解釈します。

input_format_csv_use_best_effort_in_schema_inference

CSVフォーマットでスキーマを推論する際に、いくつかの調整とヒューリスティクスを使用します

input_format_csv_use_default_on_bad_values

不正な値によってCSVフィールドのデシリアライズに失敗した場合に、カラムにデフォルト値を設定できるようにします

input_format_custom_allow_variable_number_of_columns

CustomSeparated 入力で余分なカラム (ファイルに想定より多くのカラムがある場合) を無視し、不足しているフィールドはデフォルト値として扱います

input_format_custom_detect_header

CustomSeparated フォーマットで名前と型を含むヘッダーを自動的に検出します

input_format_custom_skip_trailing_empty_lines

CustomSeparated フォーマットで末尾の空行をスキップする

input_format_defaults_for_omitted_fields

INSERT クエリの実行時に、省略された入力カラムの値を、対応するカラムのデフォルト値で補います。このオプションは、JSONEachRow (およびその他の JSON フォーマット) 、CSV、TabSeparated、TSKV、Parquet、Arrow、Avro、ORC、Native フォーマット、および WithNames/WithNamesAndTypes 接尾辞を持つフォーマットに適用されます。

このオプションを有効にすると、拡張されたテーブルメタデータがサーバーからクライアントへ送信されます。そのため、サーバーで追加の計算リソースを消費し、パフォーマンスが低下する可能性があります。

設定可能な値:

0 — 無効。
1 — 有効。

input_format_force_null_for_omitted_fields

省略されたフィールドを NULL 値で強制的に初期化します

input_format_hive_text_allow_variable_number_of_columns

Hive Text入力では、余分なカラム (ファイルのカラム数が想定より多い場合) を無視し、不足しているフィールドはデフォルト値として扱います。

input_format_hive_text_collection_items_delimiter

Hive テキストファイルにおけるコレクション (array または map) の要素間の区切り文字

input_format_hive_text_fields_delimiter

Hive テキストファイルにおけるフィールド間の区切り文字

input_format_hive_text_map_keys_delimiter

Hive テキストファイルにおける map のキーと値の区切り文字

input_format_import_nested_json

ネストされたオブジェクトを含む JSON データの挿入を有効または無効にします。対応フォーマット:

JSONEachRow

設定可能な値:

0 — 無効。
1 — 有効。

input_format_ipv4_default_on_conversion_error

IPv4 のデシリアライゼーションでは、変換エラーが発生した場合、例外をスローする代わりにデフォルト値を使用します。デフォルトでは無効です。

input_format_ipv6_default_on_conversion_error

IPv6 のデシリアライゼーションでは、変換エラーが発生した場合、例外をスローする代わりにデフォルト値が使用されます。デフォルトでは無効です。

input_format_json_compact_allow_variable_number_of_columns

JSONCompact/JSONCompactEachRow 入力フォーマットで、行ごとのカラム数が可変であることを許可します。想定より多くのカラムを含む行では余分なカラムを無視し、不足しているカラムはデフォルト値として扱います。デフォルトでは無効です。

input_format_json_defaults_for_missing_elements_in_named_tuple

名前付きタプルのパース時に、JSON オブジェクト内で欠けている要素にデフォルト値を挿入します。この設定は、input_format_json_named_tuples_as_objects 設定が有効な場合にのみ機能します。デフォルトで有効です。

input_format_json_empty_as_default

有効にすると、JSON 入力内の空のフィールドをデフォルト値に置き換えます。デフォルト式が複雑な場合は、input_format_defaults_for_omitted_fields も有効にする必要があります。設定可能な値:

0 — 無効。
1 — 有効。

input_format_json_ignore_unknown_keys_in_named_tuple

名前付きタプルの JSON オブジェクト内にある不明なキーを無視します。デフォルトで有効です。

input_format_json_ignore_unnecessary_fields

不要なフィールドを無視し、それらをパースしません。これを有効にすると、形式が無効な JSON 文字列や重複フィールドを含む JSON 文字列でも例外がスローされない場合があります

input_format_json_infer_array_of_dynamic_from_array_of_different_types

有効な場合、スキーマ推論時に ClickHouse は、異なるデータ型の値を含む JSON 配列に対して Array(Dynamic) 型を使用します。例:

SET input_format_json_infer_array_of_dynamic_from_array_of_different_types=1;
DESC format(JSONEachRow, '{"a" : [42, "hello", [1, 2, 3]]}');

┌─name─┬─type───────────┐
│ a    │ Array(Dynamic) │
└──────┴────────────────┘

SET input_format_json_infer_array_of_dynamic_from_array_of_different_types=0;
DESC format(JSONEachRow, '{"a" : [42, "hello", [1, 2, 3]]}');

┌─name─┬─type─────────────────────────────────────────────────────────────┐
│ a    │ Tuple(Nullable(Int64), Nullable(String), Array(Nullable(Int64))) │
└──────┴──────────────────────────────────────────────────────────────────┘

デフォルトで有効です。

input_format_json_infer_incomplete_types_as_strings

スキーマ推論時に、データサンプル内で Null/{}/[] のみを含む JSON キーに対して String 型を使用できるようにします。 JSON フォーマットでは任意の値を String として読み取れるため、型が不明なキーに String 型を使用することで、スキーマ推論中に

Cannot determine type for column 'column_name' by first 25000 rows of data, most likely this column contains only Nulls or empty Arrays/Maps

のようなエラーを回避できます。 Example:

SET input_format_json_infer_incomplete_types_as_strings = 1, input_format_json_try_infer_named_tuples_from_objects = 1;
DESCRIBE format(JSONEachRow, '{"obj" : {"a" : [1,2,3], "b" : "hello", "c" : null, "d" : {}, "e" : []}}');
SELECT * FROM format(JSONEachRow, '{"obj" : {"a" : [1,2,3], "b" : "hello", "c" : null, "d" : {}, "e" : []}}');

結果:

┌─name─┬─type───────────────────────────────────────────────────────────────────────────────────────────────────────────────────┬─default_type─┬─default_expression─┬─comment─┬─codec_expression─┬─ttl_expression─┐
│ obj  │ Tuple(a Array(Nullable(Int64)), b Nullable(String), c Nullable(String), d Nullable(String), e Array(Nullable(String))) │              │                    │         │                  │                │
└──────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┴──────────────┴────────────────────┴─────────┴──────────────────┴────────────────┘

┌─obj────────────────────────────┐
│ ([1,2,3],'hello',NULL,'{}',[]) │
└────────────────────────────────┘

デフォルトで有効です。

input_format_json_map_as_array_of_tuples

Map型のカラムを、タプルのJSON配列としてデシリアライズします。デフォルトでは無効です。

input_format_json_max_depth

JSON 内のフィールドの最大の深さです。これは厳密な制限ではないため、必ずしも正確に適用されるとは限りません。

input_format_json_named_tuples_as_objects

名前付きタプル型のカラムを JSON オブジェクトとして解析します。デフォルトで有効です。

input_format_json_read_arrays_as_strings

JSON 入力フォーマットで JSON 配列を String としてパースできるようにします。例:

SET input_format_json_read_arrays_as_strings = 1;
SELECT arr, toTypeName(arr), JSONExtractArrayRaw(arr)[3] from format(JSONEachRow, 'arr String', '{"arr" : [1, "Hello", [1,2,3]]}');

結果:

┌─arr───────────────────┬─toTypeName(arr)─┬─arrayElement(JSONExtractArrayRaw(arr), 3)─┐
│ [1, "Hello", [1,2,3]] │ String          │ [1,2,3]                                   │
└───────────────────────┴─────────────────┴───────────────────────────────────────────┘

デフォルトで有効です。

input_format_json_read_bools_as_numbers

JSON入力フォーマットで、bool値を数値としてパースすることを許可します。デフォルトで有効です。

input_format_json_read_bools_as_strings

JSON 入力フォーマットで bool 値を文字列としてパースできるようにします。デフォルトで有効です。

input_format_json_read_numbers_as_strings

JSON 入力フォーマットで数値を文字列としてパースできるようにします。デフォルトで有効です。

input_format_json_read_objects_as_strings

JSON 入力フォーマットで、JSON オブジェクトを String としてパースできるようにします。例:

SET input_format_json_read_objects_as_strings = 1;
CREATE TABLE test (id UInt64, obj String, date Date) ENGINE=Memory();
INSERT INTO test FORMAT JSONEachRow {"id" : 1, "obj" : {"a" : 1, "b" : "Hello"}, "date" : "2020-01-01"};
SELECT * FROM test;

結果:

┌─id─┬─obj──────────────────────┬───────date─┐
│  1 │ {"a" : 1, "b" : "Hello"} │ 2020-01-01 │
└────┴──────────────────────────┴────────────┘

デフォルトで有効です。

input_format_json_throw_on_bad_escape_sequence

JSON入力フォーマットで JSON 文字列に不正なエスケープシーケンスが含まれている場合、例外をスローします。無効にすると、不正なエスケープシーケンスはデータ内にそのまま残ります。デフォルトで有効です。

input_format_json_try_infer_named_tuples_from_objects

有効にすると、スキーマ推論時に ClickHouse は JSON オブジェクトから名前付き Tuple を推論しようとします。生成される名前付き Tuple には、サンプルデータ内の対応するすべての JSON オブジェクトに含まれる全要素が含まれます。例:

SET input_format_json_try_infer_named_tuples_from_objects = 1;
DESC format(JSONEachRow, '{"obj" : {"a" : 42, "b" : "Hello"}}, {"obj" : {"a" : 43, "c" : [1, 2, 3]}}, {"obj" : {"d" : {"e" : 42}}}')

結果:

┌─name─┬─type───────────────────────────────────────────────────────────────────────────────────────────────┬─default_type─┬─default_expression─┬─comment─┬─codec_expression─┬─ttl_expression─┐
│ obj  │ Tuple(a Nullable(Int64), b Nullable(String), c Array(Nullable(Int64)), d Tuple(e Nullable(Int64))) │              │                    │         │                  │                │
└──────┴────────────────────────────────────────────────────────────────────────────────────────────────────┴──────────────┴────────────────────┴─────────┴──────────────────┴────────────────┘

デフォルトで有効です。

input_format_json_try_infer_numbers_from_strings

有効にすると、スキーマ推論時に ClickHouse は文字列フィールドから数値を推論しようとします。これは、JSON データに引用符で囲まれた UInt64 の数値が含まれている場合に役立ちます。デフォルトでは無効です。

input_format_json_use_string_type_for_ambiguous_paths_in_named_tuples_inference_from_objects

JSON オブジェクトから名前付きタプルを推論する際、パスが曖昧な場合は例外の代わりに String 型を使用します

input_format_json_validate_types_from_metadata

JSON/JSONCompact/JSONColumnsWithMetadata 入力フォーマットでは、この設定が 1 に設定されている場合、入力データ内のメタデータに含まれる型が、テーブル内の対応するカラムの型と比較されます。デフォルトで有効です。

input_format_max_block_size_bytes

入力フォーマットでデータをパースする際に生成されるブロックのサイズを、バイト単位で制限します。ClickHouse 側でブロックが生成される行ベースの入力フォーマットで使用されます。 0 は、バイト単位の制限がないことを意味します。

input_format_max_block_wait_ms

行ベースの入力フォーマットで、パース中にブロックが出力されるまでの最大待機時間をミリ秒単位で制限します。0 は制限なしを意味します。

このオプションは、input_format_connection_handling が有効な場合にのみ機能します。値を設定すると並列パースも無効になり、重複排除はできなくなります。

ストリーミング insert の場合は、min_insert_block_size_rows=0 と min_insert_block_size_bytes=0 も設定する必要があります。そうしないと、パース済みのブロックがそれらのしきい値に達するまで、ブロックをまとめる段階で引き続きメモリ内に蓄積され、速やかな insert が妨げられる可能性があります。

例: Wikipedia の最近の変更を ClickHouse にストリーミングする

clickhouse-client --query 'CREATE TABLE wikipedia_edits (data JSON)'

curl -sS --globoff -H 'Accept: application/json' --no-buffer \
  'https://stream.wikimedia.org/v2/stream/recentchange' \
  | clickhouse-client \
      --query 'INSERT INTO wikipedia_edits FORMAT JSONAsObject' \
      --input_format_max_block_wait_ms 1000 \
      --input_format_connection_handling 1 \
      --min_insert_block_size_rows 0 \
      --min_insert_block_size_bytes 0

input_format_max_bytes_to_read_for_schema_inference

自動スキーマ推論のために読み取るデータ量の上限 (バイト単位) 。

input_format_max_rows_to_read_for_schema_inference

自動的なスキーマ推論のために読み取るデータの最大行数。

input_format_msgpack_number_of_columns

挿入される MsgPack データのカラム数です。データからスキーマを自動推論する際に使用されます。

input_format_mysql_dump_map_column_names

MySQL dump 内のテーブルのカラム名と ClickHouse テーブルのカラム名を対応付けます

input_format_mysql_dump_table_name

データの読み取り元となるMySQLダンプ内のテーブル名

input_format_native_allow_types_conversion

Native input formatでの型変換を許可します

input_format_native_decode_types_in_binary_format

Native input formatで、型名の代わりにデータ型をバイナリフォーマットで読み取ります

input_format_null_as_default

これらのフィールドの Data type が Nullable でない場合、NULL フィールドをデフォルト値で初期化する機能を有効または無効にします。カラムの型が Nullable ではなく、この設定が無効な場合、NULL を挿入すると例外が発生します。カラムの型が Nullable の場合は、この設定に関係なく、NULL 値はそのまま挿入されます。この設定は、ほとんどの入力フォーマットに適用されます。複雑なデフォルト式については、input_format_defaults_for_omitted_fields も有効にする必要があります。設定可能な値:

0 — Nullable ではないカラムに NULL を挿入すると例外が発生します。
1 — NULL フィールドはカラムのデフォルト値で初期化されます。

input_format_orc_allow_missing_columns

ORC入力フォーマットの読み取り時に、欠落したカラムを許可します

input_format_orc_case_insensitive_column_matching

ORCカラムとCHカラムの照合時に、大文字と小文字を区別しません。

input_format_orc_dictionary_as_low_cardinality

ORCファイルの読み込み時に、辞書エンコードされたORCカラムをLowCardinalityカラムとして扱います。

input_format_orc_filter_push_down

ORCファイルの読み取り時に、ORCメタデータ内のWHERE/PREWHERE式、min/max統計、またはブルームフィルターに基づいて、ストライプ全体または行グループ全体をスキップします。

input_format_orc_reader_time_zone_name

ORC 行リーダーで使用するタイムゾーン名です。デフォルトでは GMT が使用されます。

input_format_orc_row_batch_size

ORCストライプの読み取り時のバッチサイズ。

input_format_orc_skip_columns_with_unsupported_types_in_schema_inference

ORCフォーマットのスキーマ推論時に、サポートされていない型のカラムをスキップします

input_format_orc_use_fast_decoder

より高速な ORC デコーダの実装を使用します。

input_format_parallel_parsing

データフォーマットの順序を保持した並列パースを有効または無効にします。TabSeparated (TSV)、TSKV、CSV、JSONEachRow フォーマットでのみサポートされます。設定可能な値:

1 — 有効。
0 — 無効。

input_format_parquet_allow_geoparquet_parser

geoカラムパーサーを使用して、Array(UInt8) を Point/Linestring/Polygon/MultiLineString/MultiPolygon 型に変換します

input_format_parquet_allow_missing_columns

Parquet 入力フォーマットの読み取り時に欠落したカラムを許可します

input_format_parquet_bloom_filter_push_down

Parquetファイルの読み取り時に、WHERE式とParquetメタデータ内のブルームフィルタに基づいて、行グループ全体をスキップします。

input_format_parquet_case_insensitive_column_matching

Parquet のカラムと CH columns を照合する際に、大文字と小文字を区別しません。

input_format_parquet_enable_json_parsing

Parquetファイルを読み込む際、JSONカラムをClickHouse JSON Columnとしてパースします。

input_format_parquet_enable_row_group_prefetch

Parquet のパース時に行グループのプリフェッチを有効にします。現在、プリフェッチに対応しているのはシングルスレッドのパースのみです。

input_format_parquet_filter_push_down

Parquetファイルの読み取り時に、Parquetメタデータ内のWHERE/PREWHERE式および最小値/最大値の統計情報に基づいて、行グループ全体をスキップします。

input_format_parquet_local_file_min_bytes_for_seek

Parquet入力フォーマットで、ローカル読み取り (ファイル) 時に、読み飛ばしながら読み込む代わりに seek を行うために必要な最小バイト数

input_format_parquet_local_time_as_utc

isAdjustedToUTC=false の Parquet タイムスタンプに対して、スキーマ推論で使用するデータ型を決定します。true の場合は DateTime64(…, ‘UTC’)、false の場合は DateTime64(…) です。ClickHouse にはローカルの wall-clock time を表すデータ型がないため、どちらの動作も完全に正しいわけではありません。直感に反しますが、おそらく ‘true’ のほうがまだ誤りの少ない選択です。これは、‘UTC’ タイムスタンプを String としてフォーマットすると、正しいローカル時刻の表現が得られるためです。

input_format_parquet_max_block_size

Parquet リーダーの最大ブロックサイズ。

input_format_parquet_memory_high_watermark

Parquet リーダー v3 のおおよそのメモリ上限です。並列に読み取る行グループまたはカラムの数を制限します。1 つのクエリで複数のファイルを読み取る場合、この制限はそれらのファイル全体での総メモリ使用量に適用されます。

input_format_parquet_memory_low_watermark

メモリ使用量がしきい値を下回る場合、プリフェッチをより積極的にスケジュールします。たとえば、ネットワーク経由で読み取る必要がある小さなブルームフィルタが多数ある場合に役立つ可能性があります。

input_format_parquet_page_filter_push_down

カラム索引の最小値/最大値を使ってページをスキップします。

input_format_parquet_prefer_block_bytes

Parquet リーダーが出力する平均ブロックサイズ (バイト)

input_format_parquet_preserve_order

Parquet ファイルの読み取り時に行を並べ替えないようにします。通常、行の順序は保証されず、クエリパイプラインの他の部分で崩れる可能性もあるため、推奨されません。代わりに ORDER BY _row_number を使用してください。

input_format_parquet_skip_columns_with_unsupported_types_in_schema_inference

Parquet フォーマットのスキーマ推論時に、未対応の型を持つカラムをスキップします

input_format_parquet_use_offset_index

ページフィルタリングを使用しない場合のParquet fileからのページ読み取り方法に対する軽微な調整です。

input_format_parquet_verify_checksums

Parquetファイルの読み取り時に、ページのチェックサムを検証します。

input_format_protobuf_flatten_google_wrappers

通常の非ネストのカラムに対して Google wrapper を有効にします。たとえば、String カラム ‘str’ に対する google.protobuf.StringValue ‘str’ です。Nullable カラムでは、空の wrapper はデフォルト値として認識され、存在しない場合は NULL として扱われます

input_format_protobuf_oneof_presence

特別な列に enum 値を設定することで、protobuf oneof のどのフィールドが見つかったかを示します

input_format_protobuf_skip_fields_with_unsupported_types_in_schema_inference

Protobufフォーマットのスキーマ推論時に、サポートされていない型のフィールドをスキップします

input_format_record_errors_file_path

テキストフォーマット (CSV、TSV) の読み取り時に発生したエラーを記録するファイルのパスです。

input_format_skip_unknown_fields

余分なデータの挿入をスキップする機能を有効または無効にします。データの書き込み時に、入力データにターゲットテーブルに存在しないカラムが含まれている場合、ClickHouse は例外をスローします。スキップを有効にすると、ClickHouse は余分なデータを挿入せず、例外もスローしません。対応フォーマット:

JSONEachRow (およびその他の JSON フォーマット)
BSONEachRow (およびその他の JSON フォーマット)
TSKV
WithNames/WithNamesAndTypes の接尾辞を持つすべてのフォーマット
MySQLDump
Native

設定可能な値:

0 — 無効。
1 — 有効。

input_format_try_infer_dates

有効な場合、ClickHouse はテキストフォーマットのスキーマ推論で、文字列フィールドから型 Date を推論しようとします。入力データ内のあるカラムのすべてのフィールドが日付として正常にパースされた場合、結果の型は Date になります。少なくとも 1 つのフィールドが日付としてパースされなかった場合、結果の型は String になります。デフォルトで有効です。

input_format_try_infer_datetimes

有効な場合、ClickHouse はテキストフォーマットのスキーマ推論で、文字列フィールドから DateTime64 型を推論しようとします。入力データのあるカラム内のすべてのフィールドを日時として正常に解析できた場合、結果の型は DateTime64 になります。1 つでも日時として解析できないフィールドがある場合、結果の型は String になります。デフォルトで有効です。

input_format_try_infer_datetimes_only_datetime64

input_format_try_infer_datetimes が有効な場合、DateTime 型は推論せず、DateTime64 のみを推論します

input_format_try_infer_exponent_floats

テキストフォーマットでスキーマを推論する際、指数表記の浮動小数点数の推論を試みます (JSON を除く。JSON では指数表記の数値は常に推論されます)

input_format_try_infer_integers

有効な場合、ClickHouse はテキストフォーマットのスキーマ推論で、浮動小数点数ではなく整数を推論しようとします。入力データのカラム内のすべての数値が整数であれば、結果の型は Int64 になります。1 つでも浮動小数点数が含まれている場合、結果の型は Float64 になります。デフォルトで有効です。

input_format_try_infer_variants

有効にすると、ClickHouse は、カラム/配列要素に複数の型の可能性がある場合、テキストフォーマットのスキーマ推論で Variant 型の推論を試みます。設定可能な値:

0 — 無効。
1 — 有効。

input_format_tsv_allow_variable_number_of_columns

TSV 入力で余分なカラムを無視し (ファイルのカラム数が想定より多い場合) 、不足しているフィールドはデフォルト値として扱います

input_format_tsv_crlf_end_of_line

true に設定すると、file関数は \n ではなく \r\n を行末とする TSVフォーマットを読み取ります。

input_format_tsv_detect_header

TSVフォーマットで、名前と型を含むヘッダーを自動的に検出します

input_format_tsv_empty_as_default

TSV入力内の空のフィールドをデフォルト値として扱います。

input_format_tsv_enum_as_number

TSV フォーマットで挿入される enum 値を、enum のインデックスとして扱います。

input_format_tsv_skip_first_lines

TSVフォーマットのデータ先頭で、指定した行数をスキップします

input_format_tsv_skip_trailing_empty_lines

TSVフォーマットの末尾にある空行をスキップします

input_format_tsv_use_best_effort_in_schema_inference

TSVフォーマットでスキーマを推論する際に、いくつかの調整とヒューリスティクスを使用します

input_format_values_accurate_types_of_literals

Values フォーマットでは、template を使用して式をパースおよび解釈する際、overflow や精度の問題が発生する可能性を避けるため、リテラルの実際の型を確認します。

input_format_values_deduce_templates_of_expressions

Valuesフォーマットでは、フィールドをストリーミングパーサーでパースできない場合、SQLパーサーを実行して SQL 式のテンプレートを推定し、そのテンプレートを使ってすべての行のパースを試みたうえで、すべての行について式を解釈します。

input_format_values_interpret_expressions

Values フォーマットの場合、フィールドをストリーミングパーサーで解析できなければ、SQL パーサーを実行し、SQL 式として解釈を試みます。

input_format_with_names_use_header

データ挿入時のカラム順序チェックを有効または無効にします。挿入パフォーマンスを向上させるため、入力データのカラム順序がターゲットテーブルと同じであることが確実な場合は、このチェックを無効にすることを推奨します。対応フォーマット:

設定可能な値:

0 — 無効。
1 — 有効。

input_format_with_types_use_header

フォーマットパーサーが、入力データのデータ型とターゲットテーブルのデータ型が一致しているかどうかをチェックするかを制御します。対応フォーマット:

設定可能な値:

0 — 無効。
1 — 有効。

insert_distributed_one_random_shard

distributed key がない場合に、Distributed テーブルへの挿入先としてランダムな分片を使用するかどうかを設定します。既定では、複数の分片を持つ Distributed テーブルにデータを挿入する際、distributed key がない場合、ClickHouseサーバーは挿入リクエストを拒否します。insert_distributed_one_random_shard = 1 に設定すると挿入が許可され、データはすべての分片に対してランダムに振り分けられます。設定可能な値:

0 — 複数の分片があり、distributed key が指定されていない場合、挿入は拒否されます。
1 — distributed key が指定されていない場合、利用可能なすべての分片の中からランダムに選ばれた分片に挿入されます。

interval_output_format

インターバル型のテキスト表現に使用する出力フォーマットを選択できます。設定可能な値:

kusto - KQL スタイルの出力フォーマット。 ClickHouse はインターバルを KQL フォーマットで出力します。たとえば、toIntervalDay(2) は 2.00:00:00 としてフォーマットされます。なお、長さが一定でないインターバル型 (IntervalMonth および IntervalYear など) では、インターバルあたりの平均秒数が考慮されます。
numeric - 数値出力フォーマット。 ClickHouse はインターバルを基になる数値表現のまま出力します。たとえば、toIntervalDay(2) は 2 としてフォーマットされます。

into_outfile_create_parent_directories

INTO OUTFILE の使用時に親ディレクトリがまだ存在しない場合、自動的に作成します。

json_type_escape_dots_in_keys

有効にすると、JSONキー内のドットはパース時にエスケープされます。

max_dynamic_subcolumns_in_json_type_parsing

JSONカラムのパース時に、各カラムで作成可能な動的サブカラムの最大数です。これにより、データ型で指定された動的パラメータにかかわらず、パース中の動的サブカラム数を制御できます。

output_format_arrow_compression_method

Arrow 出力フォーマットの圧縮方式。対応する codec: lz4_frame、zstd、none (非圧縮)

output_format_arrow_date_as_uint16

Date の値を、32 ビットの Arrow DATE32 型 (読み戻すと Date32) に変換する代わりに、通常の 16 ビット整数 (読み戻すと UInt16) として書き込みます。

output_format_arrow_fixed_string_as_fixed_byte_array

FixedString カラムには、Binary ではなく Arrow FIXED_SIZE_BINARY 型を使用します。

output_format_arrow_low_cardinality_as_dictionary

LowCardinality 型を出力時に Dictionary Arrow 型として有効にします

output_format_arrow_string_as_string

String カラムには Binary ではなく Arrow String 型を使用する

output_format_arrow_unsupported_types_as_binary

変換先がない出力型を、生のバイナリデータとして出力します。false の場合、このような型では UNKNOWN_TYPE 例外が発生します。

output_format_arrow_use_64_bit_indexes_for_dictionary

Arrow形式のDictionaryの索引には常に64ビット整数を使用します

output_format_arrow_use_signed_indexes_for_dictionary

Arrowフォーマットの Dictionary の索引には符号付き整数を使用します

output_format_avro_codec

出力時に使用する圧縮コーデック。設定可能な値: ‘null’, ‘deflate’, ‘snappy’, ‘zstd’。

output_format_avro_confluent_subject

AvroConfluent 出力フォーマットの場合: Confluent スキーマレジストリでスキーマが登録される subject 名です。AvroConfluent 出力の書き込み時に必須です。

output_format_avro_rows_in_file

1ファイルあたりの最大行数 (ストレージで許可されている場合)

output_format_avro_string_column_pattern

Avroフォーマット: AVRO文字列として選択するStringカラムを指定する正規表現。

output_format_avro_sync_interval

バイト単位での同期間隔。

output_format_binary_encode_types_in_binary_format

RowBinaryWithNamesAndTypes 出力フォーマットで、型名ではなくデータ型をバイナリフォーマットで書き込みます

output_format_binary_write_json_as_string

JSONデータ型の値を、RowBinary出力フォーマットで JSON String 値として出力します。

output_format_bson_string_as_string

String 型のカラムには、Binary ではなく BSON String 型を使用します。

output_format_compression_level

クエリ出力が圧縮される場合のデフォルトの圧縮レベルです。この設定は、SELECT クエリで INTO OUTFILE を使用する場合、またはテーブル関数 file、url、hdfs、s3、azureBlobStorage に書き込む場合に適用されます。設定可能な値: 1 から 22

output_format_compression_zstd_window_log

出力の圧縮方式が zstd の場合に使用できます。0 より大きい場合、この設定は圧縮ウィンドウサイズ (2 のべき乗) を明示的に設定し、zstd 圧縮の long-range モードを有効にします。これにより、より高い圧縮率を得られる場合があります。設定可能な値: 0 以上の数値。値が小さすぎるか大きすぎる場合、zstdlib は例外をスローします。一般的な値は 20 (ウィンドウサイズ = 1MB) から 30 (ウィンドウサイズ = 1GB) です。

output_format_csv_crlf_end_of_line

true に設定すると、CSVフォーマットの行末は \n ではなく \r\n になります。

output_format_csv_serialize_tuple_into_separate_columns

true に設定すると、CSVフォーマットのタプルは個別のカラムとしてシリアライズされます (つまり、タプル内のネストは失われます)

output_format_decimal_trailing_zeros

Decimal 値を出力する際に、末尾のゼロも出力します。例: 1.23 ではなく 1.230000。デフォルトでは無効です。

output_format_json_array_of_rows

JSONEachRow フォーマットで、すべての行を JSON 配列として出力する機能を有効にします。設定可能な値:

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

output_format_json_escape_forward_slashes

JSON出力フォーマットで文字列を出力する際に、スラッシュをエスケープするかどうかを制御します。これは JavaScript との互換性のための設定です。常にエスケープされるバックスラッシュと混同しないでください。デフォルトで有効です。

output_format_json_map_as_array_of_tuples

Map型のカラムを、タプルのJSON配列としてシリアライズします。デフォルトでは無効です。

output_format_json_named_tuples_as_objects

名前付きタプルのカラムを JSON オブジェクトとしてシリアライズします。デフォルトで有効です。

output_format_json_pretty_print

この設定は、JSON 出力フォーマットの使用時に、data 配列内の Tuples、Maps、Arrays などのネストされた構造をどのように表示するかを制御します。たとえば、次のように出力する代わりに:

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

デフォルトで有効です。

output_format_json_quote_64bit_floats

JSON* フォーマットで出力する際に、64 ビットの floats を引用符で囲むかどうかを制御します。デフォルトでは無効です。

output_format_json_quote_64bit_integers

JSONフォーマットで出力する際に、64 ビット以上の整数 (UInt64 や Int128 など) を引用符で囲むかどうかを制御します。このような整数は、デフォルトで引用符で囲まれます。この動作は、ほとんどの JavaScript 実装と互換性があります。設定可能な値:

0 — 整数は引用符なしで出力されます。
1 — 整数は引用符で囲まれて出力されます。

output_format_json_quote_decimals

JSON出力フォーマットで Decimal 値を引用符で囲むかどうかを制御します。デフォルトでは無効です。

output_format_json_quote_denormals

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

output_format_json_skip_null_value_in_named_tuples

名前付きタプルのカラムを JSON オブジェクトとしてシリアライズする際に、NULL 値を持つキーと値のペアをスキップします。これは、output_format_json_named_tuples_as_objects が true の場合にのみ有効です。

output_format_json_validate_utf8

JSON 出力フォーマットにおける UTF-8 シーケンスの検証を制御します。JSON/JSONCompact/JSONColumnsWithMetadata フォーマットには影響せず、これらは常に UTF-8 を検証します。デフォルトでは無効です。

output_format_markdown_escape_special_characters

有効にすると、Markdown 内の特殊文字をエスケープします。 Common Mark では、次の特殊文字をでエスケープできるものとして定義しています。

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

設定可能な値:

0 — 無効。
1 — 有効。

output_format_msgpack_uuid_representation

MsgPackフォーマットでUUIDを出力する際の形式。

output_format_native_encode_types_in_binary_format

Native 出力フォーマットでは、型名の代わりにデータ型をバイナリ形式で書き込みます

output_format_native_use_flattened_dynamic_and_json_serialization

JSON および Dynamic カラムのデータを、フラット化されたフォーマットですべての型/パスを個別のサブカラムとして書き込みます。

output_format_native_write_json_as_string

デフォルトのネイティブJSONシリアライゼーションの代わりに、JSONカラムのデータを、JSON文字列を含む単一のStringカラムとしてNative 出力フォーマットで書き込みます。

output_format_orc_compression_block_size

ORC出力フォーマットの圧縮ブロックサイズ (バイト単位) 。

output_format_orc_compression_method

ORC 出力フォーマットの圧縮方式。サポートされているコーデック: lz4, snappy, zlib, zstd, none (非圧縮)

output_format_orc_dictionary_key_size_threshold

ORC出力フォーマットの文字列カラムで、一意な値の数が NULL でない行の総数に対するこの割合を超える場合は、Dictionary エンコーディングを無効にします。それ以外の場合は、Dictionary エンコーディングが有効になります

output_format_orc_row_index_stride

ORC出力フォーマットにおける目標行索引ストライド

output_format_orc_string_as_string

String カラムでは、Binary ではなく ORC の String 型を使用します

output_format_orc_writer_time_zone_name

ORCライターのタイムゾーン名です。デフォルトの ORCライターのタイムゾーンは GMT です。

output_format_parallel_formatting

データのフォーマット処理を並列化するかどうかを有効または無効にします。TSV、TSKV、CSV、JSONEachRow フォーマットでのみサポートされています。設定可能な値:

1 — 有効。
0 — 無効。

output_format_parquet_batch_size

この行数ごとにページサイズを確認します。平均的な値のサイズが数 KB を超えるカラムがある場合は、この値を小さくすることを検討してください。

output_format_parquet_bloom_filter_bits_per_value

Parquet ブルームフィルタで、個別の値ごとに使用するビット数のおおよその値です。推定される偽陽性率は次のとおりです。

6 ビット - 10%
10.5 ビット - 1%
16.9 ビット - 0.1%
26.4 ビット - 0.01%
41 ビット - 0.001%

output_format_parquet_bloom_filter_flush_threshold_bytes

Parquetファイル内でブルームフィルタをどこに配置するかを指定します。ブルームフィルタは、およそこのサイズごとにまとめて書き込まれます。具体的には次のとおりです。

0 の場合、各行グループのブルームフィルタは、その行グループの直後にただちに書き込まれます。
- すべてのブルームフィルタの合計サイズより大きい場合、すべての行グループのブルームフィルタがメモリ上に蓄積され、その後ファイル末尾付近にまとめて書き込まれます。
- それ以外の場合、ブルームフィルタはメモリ上に蓄積され、合計サイズがこの値を超えるたびに書き出されます。

output_format_parquet_compression_method

Parquet 出力フォーマットの圧縮方式。対応している codec: snappy, lz4, brotli, zstd, gzip, none (非圧縮)

output_format_parquet_data_page_size

圧縮前の目標ページサイズ (バイト単位) 。

output_format_parquet_date_as_uint16

Date の値を 32 ビットの Parquet DATE 型に変換して書き込む (読み戻すと Date32) 代わりに、単純な 16 ビット数値として書き込みます (読み戻すと UInt16) 。

output_format_parquet_datetime_as_uint32

DateTime の値をミリ秒に変換せず、生の Unix timestamp として書き込みます (読み戻すと UInt32 として扱われます) 。

output_format_parquet_enum_as_byte_array

Enum を Parquet の物理型 BYTE_ARRAY、論理型 ENUM を使用して書き込みます

output_format_parquet_fixed_string_as_fixed_byte_array

FixedString カラムには、Binary の代わりに Parquet FIXED_LEN_BYTE_ARRAY 型を使用します。

output_format_parquet_geometadata

Geoカラムに関する情報をParquetメタデータに書き込み、カラムをWKB形式でエンコードできるようにします。

output_format_parquet_max_dictionary_size

Dictionary のサイズがこのバイト数を超えると、Dictionary を使用しないエンコーディングに切り替わります。Dictionary エンコーディングを無効にするには、0 に設定してください。

output_format_parquet_parallel_encoding

Parquet のエンコードを複数スレッドで行います。

output_format_parquet_row_group_size

目標とする行グループのサイズ (行数) 。

output_format_parquet_row_group_size_bytes

圧縮前の行グループの目標サイズ (バイト単位) 。

output_format_parquet_string_as_string

String カラムには、Binary ではなく Parquet の String 型を使用します。

output_format_parquet_write_bloom_filter

Parquet ファイルにブルームフィルタを書き込みます。

output_format_parquet_write_checksums

Parquet のページヘッダーに crc32 チェックサムを書き込みます。

output_format_parquet_write_page_index

Parquetファイルにカラム索引とオフセット索引 (つまり各データページの統計情報で、読み取り時の filter pushdown に利用されることがあります) を書き込みます。

output_format_pretty_color

Pretty フォーマットで ANSI エスケープシーケンスを使用します。0 - 無効、1 - 有効、‘auto’ - 出力先が端末の場合に有効。

output_format_pretty_display_footer_column_names

テーブルの行数が多い場合に、フッターへカラム名を表示します。設定可能な値:

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_min_rows

設定 output_format_pretty_display_footer_column_names が有効な場合に、カラム名を含むフッターを表示する行数の最小値を設定します。

output_format_pretty_fallback_to_vertical

有効な場合、テーブルの幅が広く行数が少ないと、Pretty フォーマットは Vertical フォーマットと同様の形式で出力します。この動作の詳細な調整については、output_format_pretty_fallback_to_vertical_max_rows_per_chunk および output_format_pretty_fallback_to_vertical_min_table_width を参照してください。

output_format_pretty_fallback_to_vertical_max_rows_per_chunk

Vertical フォーマットへのフォールバック (output_format_pretty_fallback_to_vertical を参照) は、chunk 内のレコード数が指定値以下の場合にのみ有効になります。

output_format_pretty_fallback_to_vertical_min_columns

Verticalフォーマットへのフォールバック (output_format_pretty_fallback_to_vertical を参照) は、カラム数が指定した値を超える場合にのみ有効になります。

output_format_pretty_fallback_to_vertical_min_table_width

Vertical フォーマットへのフォールバック (output_format_pretty_fallback_to_verticalを参照) は、テーブル内のカラムの長さの合計が指定した値以上である場合、またはいずれかの値に改行文字が含まれている場合にのみ有効になります。

output_format_pretty_glue_chunks

Prettyフォーマットで表示されるデータが複数のchunkに分かれて到着した場合、遅れて到着した場合でも、次のchunkのカラム幅が前のchunkと同じであれば、ANSIエスケープシーケンスを使用して前の行に戻り、前のchunkのフッターを上書きして新しいchunkのデータを続けて表示します。これにより、結果がより見やすくなります。 0 - 無効、1 - 有効、‘auto’ - 端末の場合は有効。

output_format_pretty_grid_charset

グリッドの枠線を出力する文字セット。使用できる文字セット: ASCII、UTF-8 (デフォルト) 。

output_format_pretty_highlight_digit_groups

有効で、かつ出力先がターミナルである場合、千、百万などの単位に当たる桁ごとに下線で強調表示します。

output_format_pretty_highlight_trailing_spaces

有効で、出力先がターミナルの場合、末尾のスペースを灰色で下線付きにして強調表示します。

output_format_pretty_max_column_name_width_cut_to

カラム名が長すぎる場合は、この長さに切り詰めます。カラム名の長さが 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_min_chars_to_cut

カラム名が長すぎる場合に切り詰める最小文字数。カラム名の長さが 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_pad_width

Pretty フォーマットで、カラム内のすべての値に追加するパディングの最大幅。

output_format_pretty_max_rows

Pretty フォーマットの行数上限。

output_format_pretty_max_value_width

Pretty フォーマットで表示される値の最大幅です。これを超える場合は切り詰められます。値が 0 の場合は、切り詰められません。

output_format_pretty_max_value_width_apply_for_single_value

値を切り詰める (output_format_pretty_max_value_width 設定を参照) のは、block 内の単一の値でない場合のみです。それ以外の場合は値全体を出力します。これは SHOW CREATE TABLE クエリで便利です。

output_format_pretty_multiline_fields

有効にすると、Prettyフォーマットでは複数行のフィールドがテーブルのセル内に収まるように表示され、テーブルの外枠が維持されます。無効の場合はそのまま表示されるため、テーブルのレイアウトが崩れる可能性があります (無効のままにしておく利点の 1 つは、複数行の値をコピー＆ペーストしやすいことです) 。

output_format_pretty_named_tuples_as_json

Pretty フォーマットで名前付きタプルを整形済みの JSON オブジェクトとして出力するかどうかを制御します。

output_format_pretty_row_numbers

Pretty 出力フォーマットで各行の前に行番号を追加します

output_format_pretty_single_large_number_tip_threshold

ブロックがこの値を超える単一の数値 (0 を除く) のみで構成されている場合、テーブルの右側に見やすい数値のヒントを表示します

output_format_pretty_squash_consecutive_ms

指定したミリ秒数のあいだ次のブロックを待ち、書き込む前に前のブロックにまとめます。これにより、非常に小さいブロックが頻繁に出力されるのを防ぎつつ、ストリーミング形式でデータを表示できます。

output_format_pretty_squash_max_wait_ms

前回の出力から指定したミリ秒数以上が経過した場合、Pretty フォーマットで保留中のブロックを出力します。

output_format_protobuf_nullables_with_google_wrappers

Google ラッパーを使用して Nullable カラムをシリアライズする場合、デフォルト値は空のラッパーとしてシリアライズされます。無効になっている場合、デフォルト値と NULL 値はシリアライズされません

output_format_schema

自動生成されたスキーマを Cap’n Proto または Protobuf フォーマットで保存するファイルのパス。

output_format_sql_insert_include_column_names

INSERT クエリにカラム名を含めます

output_format_sql_insert_max_batch_size

1つのINSERTステートメントに含められる最大の行数です。

output_format_sql_insert_quote_names

カラム名を ’`’ 文字でクォートします

output_format_sql_insert_table_name

出力される INSERT クエリで使用されるテーブル名

output_format_sql_insert_use_replace

INSERT の代わりに REPLACE ステートメントを使用します

output_format_trim_fixed_string

テキスト出力フォーマットで、FixedString の値の末尾にあるヌルバイトを削除します。たとえば、toFixedString('John', 8) は John\0\0\0\0 ではなく John として出力されます。

output_format_tsv_crlf_end_of_line

true に設定すると、TSV フォーマットの行末は \n ではなく \r\n になります。

output_format_values_escape_quote_with_quote

true の場合は ’ を ” としてエスケープし、それ以外は ' で囲みます

output_format_write_statistics

適切な出力フォーマットで、読み取った行数、バイト数、経過時間に関する統計を書き込みます。デフォルトで有効

precise_float_parsing

より正確な (ただし低速な) 浮動小数点数のパースアルゴリズムを優先します

schema_inference_hints

スキーマのないフォーマットでスキーマ推論を行う際に、ヒントとして使用するカラム名と型の一覧です。例: クエリ:

desc format(JSONEachRow, '{"x" : 1, "y" : "String", "z" : "0.0.0.0" }') settings schema_inference_hints='x UInt8, z IPv4';

結果:

x   UInt8
y   Nullable(String)
z   IPv4

schema_inference_hints の形式が正しくない場合や、タイプミスや誤ったデータ型などが含まれている場合は、schema_inference_hints 全体が無視されます。

schema_inference_make_columns_nullable

スキーマ推論で、推論された型を Nullable にするかどうかを制御します。設定可能な値:

0 - 推論された型は Nullable になりません (この場合に NULL 値をどう扱うかは input_format_null_as_default で制御します) 、
1 - すべての推論された型が Nullable になります、
2 または auto - 推論された型は、スキーマ推論中に解析されるサンプル内でカラムに NULL が含まれている場合、またはファイルのメタデータにカラムの NULL 許容性に関する情報が含まれている場合にのみ Nullable になります、
3 - フォーマットが対応している場合 (例: Parquet) は、推論された型の NULL 許容性はファイルのメタデータに従います。それ以外の場合 (例: CSV) は常に Nullable になります。

schema_inference_make_json_columns_nullable

スキーマ推論時に、推論された JSON 型を Nullable にするかどうかを制御します。この設定を schema_inference_make_columns_nullable とあわせて有効にすると、推論された JSON 型は Nullable になります。

schema_inference_mode

スキーマ推論のモードです。‘default’ - すべてのファイルが同じスキーマを持つとみなし、任意のファイルからスキーマを推論できます。‘union’ - ファイルごとに異なるスキーマを持つことができ、結果のスキーマはすべてのファイルのスキーマのユニオンになります

show_create_query_identifier_quoting_rule

SHOW CREATE クエリ内の識別子の引用符付けルールを設定します

show_create_query_identifier_quoting_style

SHOW CREATE クエリにおける識別子のクォートスタイルを設定します

type_json_allow_duplicated_key_with_literal_and_nested_object

有効にすると、{"a" : 42, "a" : {"b" : 42}} のような、一部のキーが重複していても、そのうちの一方がネストされたオブジェクトである JSON をパースできるようになります。

type_json_skip_duplicated_paths

有効にすると、JSONオブジェクトを JSON type にパースする際、重複したパスは無視され、例外を発生させる代わりに最初のものだけが挿入されます

type_json_skip_invalid_typed_paths

有効にすると、型付きパスを持つ JSON type のカラムで、JSON の値を宣言された型に変換できないフィールドは、エラーをスローする代わりにスキップされます。スキップされたフィールドは欠落しているものとして扱われ、型付きパスの定義に応じてデフォルト値または NULL 値が使用されます。この設定は、特定のパスに型が宣言されている JSON type のカラム (例: JSON(a Int64, b String)) にのみ適用されます。通常の型付きカラムに insert する場合の JSONEachRow など、通常の JSON input formats には適用されません。設定可能な値:

0 — 無効 (型が一致しない場合はエラーをスロー) 。
1 — 有効 (型が一致しない場合はフィールドをスキップ) 。

type_json_use_partial_match_to_skip_paths_by_regexp

有効にすると、JSON object を JSON type にパースする際、SKIP REGEXP で指定した正規表現は、パスをスキップするために部分一致が必要です。無効にすると、完全一致が必要です。

validate_experimental_and_suspicious_types_inside_nested_types

Array/Map/Tuple のようなネストされた型の内部で、実験的な型や疑わしい型の使用を検証します

最終更新日 2026年6月10日

ベータ機能と実験的機能ClickHouse にはベータ機能と実験的機能があります。このページでは、それぞれの定義を説明します。

​allow_special_bool_values_inside_variant

​bool_false_representation

​bool_true_representation

​check_conversion_from_numbers_to_enum

​column_names_for_schema_inference

​date_time_64_output_format_cut_trailing_zeros_align_to_groups_of_thousands

​date_time_input_format

​date_time_output_format

​date_time_overflow_behavior

​errors_output_format

​format_avro_schema_registry_connection_timeout

​format_avro_schema_registry_receive_timeout

​format_avro_schema_registry_send_timeout

​format_avro_schema_registry_url

​format_binary_max_array_size

​format_binary_max_object_size

​format_binary_max_string_size

​format_capn_proto_enum_comparising_mode

​format_capn_proto_max_message_size

​format_capn_proto_use_autogenerated_schema

​format_csv_allow_double_quotes

​format_csv_allow_single_quotes

​format_csv_delimiter

​format_csv_null_representation

​format_custom_escaping_rule

​format_custom_field_delimiter

​format_custom_result_after_delimiter

​format_custom_result_before_delimiter

​format_custom_row_after_delimiter

​format_custom_row_before_delimiter

​format_custom_row_between_delimiter

​format_display_secrets_in_show_and_select

​format_json_object_each_row_column_for_object_name

​format_protobuf_use_autogenerated_schema

​format_regexp

​format_regexp_escaping_rule

​format_regexp_skip_unmatched

​format_schema

​format_schema_message_name

​format_schema_source

​format_template_resultset

​format_template_resultset_format

​format_template_row

​format_template_row_format

​format_template_rows_between_delimiter

​format_tsv_null_representation

​input_format_allow_errors_num

​input_format_allow_errors_ratio

​input_format_allow_seeks

​input_format_arrow_allow_missing_columns

​input_format_arrow_case_insensitive_column_matching

​input_format_arrow_skip_columns_with_unsupported_types_in_schema_inference

​input_format_avro_allow_missing_fields

​input_format_avro_null_as_default

​input_format_binary_decode_types_in_binary_format

​input_format_binary_max_type_complexity

​input_format_binary_read_json_as_string

​input_format_bson_skip_fields_with_unsupported_types_in_schema_inference

​input_format_capn_proto_skip_fields_with_unsupported_types_in_schema_inference

​input_format_column_name_matching_mode

​input_format_connection_handling

​input_format_csv_allow_cr_end_of_line

​input_format_csv_allow_variable_number_of_columns

​input_format_csv_allow_whitespace_or_tab_as_delimiter

​input_format_csv_arrays_as_nested_csv

​input_format_csv_deserialize_separate_columns_into_tuple

​input_format_csv_detect_header

​input_format_csv_empty_as_default

​input_format_csv_enum_as_number

​input_format_csv_skip_first_lines

​input_format_csv_skip_trailing_empty_lines

​input_format_csv_trim_whitespaces

​input_format_csv_try_infer_numbers_from_strings

​input_format_csv_try_infer_strings_from_quoted_tuples

​input_format_csv_use_best_effort_in_schema_inference

​input_format_csv_use_default_on_bad_values

​input_format_custom_allow_variable_number_of_columns

​input_format_custom_detect_header

​input_format_custom_skip_trailing_empty_lines

​input_format_defaults_for_omitted_fields

allow_special_bool_values_inside_variant

bool_false_representation

bool_true_representation

check_conversion_from_numbers_to_enum

column_names_for_schema_inference

date_time_64_output_format_cut_trailing_zeros_align_to_groups_of_thousands

date_time_input_format

date_time_output_format

date_time_overflow_behavior

errors_output_format

format_avro_schema_registry_connection_timeout

format_avro_schema_registry_receive_timeout

format_avro_schema_registry_send_timeout

format_avro_schema_registry_url

format_binary_max_array_size

format_binary_max_object_size

format_binary_max_string_size

format_capn_proto_enum_comparising_mode

format_capn_proto_max_message_size

format_capn_proto_use_autogenerated_schema

format_csv_allow_double_quotes

format_csv_allow_single_quotes

format_csv_delimiter

format_csv_null_representation

format_custom_escaping_rule

format_custom_field_delimiter

format_custom_result_after_delimiter

format_custom_result_before_delimiter

format_custom_row_after_delimiter

format_custom_row_before_delimiter

format_custom_row_between_delimiter

format_display_secrets_in_show_and_select

format_json_object_each_row_column_for_object_name

format_protobuf_use_autogenerated_schema

format_regexp

format_regexp_escaping_rule

format_regexp_skip_unmatched

format_schema

format_schema_message_name

format_schema_source

format_template_resultset

format_template_resultset_format

format_template_row

format_template_row_format

format_template_rows_between_delimiter

format_tsv_null_representation

input_format_allow_errors_num

input_format_allow_errors_ratio

input_format_allow_seeks

input_format_arrow_allow_missing_columns

input_format_arrow_case_insensitive_column_matching

input_format_arrow_skip_columns_with_unsupported_types_in_schema_inference

input_format_avro_allow_missing_fields

input_format_avro_null_as_default

input_format_binary_decode_types_in_binary_format

input_format_binary_max_type_complexity

input_format_binary_read_json_as_string

input_format_bson_skip_fields_with_unsupported_types_in_schema_inference

input_format_capn_proto_skip_fields_with_unsupported_types_in_schema_inference

input_format_column_name_matching_mode

input_format_connection_handling

input_format_csv_allow_cr_end_of_line

input_format_csv_allow_variable_number_of_columns

input_format_csv_allow_whitespace_or_tab_as_delimiter

input_format_csv_arrays_as_nested_csv

input_format_csv_deserialize_separate_columns_into_tuple

input_format_csv_detect_header

input_format_csv_empty_as_default

input_format_csv_enum_as_number

input_format_csv_skip_first_lines

input_format_csv_skip_trailing_empty_lines

input_format_csv_trim_whitespaces

input_format_csv_try_infer_numbers_from_strings

input_format_csv_try_infer_strings_from_quoted_tuples

input_format_csv_use_best_effort_in_schema_inference

input_format_csv_use_default_on_bad_values

input_format_custom_allow_variable_number_of_columns

input_format_custom_detect_header

input_format_custom_skip_trailing_empty_lines

input_format_defaults_for_omitted_fields