TiDB Lightning CSV のサポートと制限

このドキュメントでは、 TiDB Lightningを使用して CSV ファイルから TiDB にデータを移行する方法について説明します。 MySQL から CSV ファイルを生成する方法については、 Dumplingを使用して CSV ファイルにエクスポートするを参照してください。

TiDB Lightningは、CSV (カンマ区切り値) データ ソースの読み取りと、TSV (タブ区切り値) などの他の区切り形式をサポートしています。

ファイル名

テーブル全体を表す CSV ファイルにはdb_name.table_name.csvという名前を付ける必要があります。これは、データベースdb_name内のテーブルtable_nameとして復元されます。

テーブルが複数の CSV ファイルにまたがる場合は、 db_name.table_name.003.csvのように名前を付ける必要があります。数値部分は連続している必要はありませんが、増加し、ゼロが埋め込まれている必要があります。

コンテンツがコンマで区切られていない場合でも、ファイル拡張子は*.csvでなければなりません。

スキーマ

CSV ファイルはスキーマレスです。それらを TiDB にインポートするには、テーブル スキーマを提供する必要があります。これは、次のいずれかで実行できます。

  • CREATE TABLE DDL ステートメントを含むdb_name.table_name-schema.sqlという名前のファイルと、 CREATE DATABASE DDL ステートメントを含むdb_name-schema-create.sqlという名前のファイルを提供します。
  • TiDB でテーブル スキーマを手動で作成します。

Configuration / コンフィグレーション

CSV 形式は、 [mydumper.csv]セクションのtidb-lightning.tomlで設定できます。ほとんどの設定には、MySQL LOAD DATAステートメントに対応するオプションがあります。

[mydumper.csv]
# Separator between fields. Must be ASCII characters. It is not recommended to use the default ','. It is recommended to use '\|+\|' or other uncommon character combinations.
separator = ','
# Quoting delimiter. Empty value means no quoting.
delimiter = '"'
# Line terminator. Empty value means both "\n" (LF) and "\r\n" (CRLF) are line terminators.
terminator = ''
# Whether the CSV files contain a header.
# If `header` is true, the first line will be skipped.
header = true
# Whether the CSV contains any NULL value.
# If `not-null` is true, all columns from CSV cannot be NULL.
not-null = false
# When `not-null` is false (that is, CSV can contain NULL),
# fields equal to this value will be treated as NULL.
null = '\N'
# Whether to interpret backslash escapes inside fields.
backslash-escape = true
# If a line ends with a separator, remove it.
trim-last-separator = false

separatordelimiterterminatorなどのすべての文字列フィールドで、入力に特殊文字が含まれている場合は、バックスラッシュ エスケープ シーケンスを使用して、それらを二重引用符で囲まれた文字列 ( "…" ) で表すことができます。たとえば、 separator = "\u001f"は ASCII 文字 0x1F をセパレータとして使用することを意味します。

さらに、単一引用符で囲まれた文字列 ( '…' ) を使用して、バックスラッシュのエスケープを抑制することができます。たとえば、 terminator = '\n'は 2 文字の文字列を使用することを意味します: バックスラッシュの後に文字 "n" がターミネータとして続きます。

詳細はTOML v1.0.0 specificationを参照してください。

separator

  • フィールド区切りを定義します。

  • 複数の文字を指定できますが、空にすることはできません。

  • 一般的な値:

    • CSV (カンマ区切り値) の場合は','
    • TSV (タブ区切り値) の場合は"\t"
    • ASCII 文字 0x01 をセパレータとして使用する場合は"\u0001"
  • LOAD DATA ステートメントのFIELDS TERMINATED BYオプションに対応します。

delimiter

  • 引用に使用する区切り文字を定義します。

  • delimiterが空の場合、すべてのフィールドは引用符で囲まれていません。

  • 一般的な値:

    • 二重引用符で囲まれた'"'個の引用フィールド、 RFC 4180個と同じ
    • ''引用を無効にする
  • LOAD DATAステートメントのFIELDS ENCLOSED BYオプションに対応します。

terminator

  • 行末記号を定義します。
  • terminatorが空の場合、 "\r" (U+000D キャリッジ リターン) と"\n" (U+000A ライン フィード) の両方がターミネータとして使用されます。
  • LOAD DATAステートメントのLINES TERMINATED BYオプションに対応します。

header

  • すべてのCSV ファイルにヘッダー行が含まれているかどうか。
  • headerが true の場合、最初の行が列名として使用されます。 headerが false の場合、最初の行は特別ではなく、通常のデータ行として扱われます。

not-nullおよびnull

  • not-null設定は、すべてのフィールドが null 非許容であるかどうかを制御します。

  • not-nullが false の場合、 nullで指定された文字列は、具体的な値ではなく SQL NULL に変換されます。

  • 引用符は、フィールドが null であるかどうかには影響しません。

    たとえば、CSV ファイルの場合:

    A,B,C
    \N,"\N",
    

    デフォルト設定 ( not-null = false; null = '\N' ) では、列ABは両方とも、TiDB へのインポート後に NULL に変換されます。列Cは単に空の文字列''ですが、NULL ではありません。

backslash-escape

  • フィールド内のバックスラッシュ エスケープを解釈するかどうか。

  • backslash-escapeが true の場合、次のシーケンスが認識され、変換されます。

    順序に変換
    \0空文字 (U+0000)
    \bバックスペース (U+0008)
    \n改行 (U+000A)
    \rキャリッジ リターン (U+000D)
    \tタブ (U+0009)
    \ZWindows EOF (U+001A)

    他のすべての場合 (たとえば、 \" ) では、バックスラッシュは単純に取り除かれ、次の文字 ( " ) がフィールドに残ります。左の文字には特別な役割 (区切り文字など) はなく、単なる通常の文字です。

  • 引用符は、バックスラッシュ エスケープが解釈されるかどうかには影響しません。

  • LOAD DATAステートメントのFIELDS ESCAPED BY '\'オプションに対応します。

trim-last-separator

  • フィールドseparatorをターミネータとして扱い、末尾のセパレータをすべて削除します。

    たとえば、CSV ファイルの場合:

    A,,B,,
    
  • trim-last-separator = falseの場合、これは 5 つのフィールド('A', '', 'B', '', '')の行として解釈されます。

  • trim-last-separator = trueの場合、これは 3 つのフィールド('A', '', 'B')の行として解釈されます。

  • 複数の末尾の区切り文字を使用した動作は直感的ではないため、このオプションは非推奨です。代わりにterminatorオプションを使用してください。古い構成が

    separator = ','
    trim-last-separator = true
    

    これをに変更することをお勧めします

    separator = ','
    terminator = ",\n"
    

構成不可能なオプション

TiDB Lightningは、 LOAD DATAステートメントでサポートされているすべてのオプションをサポートしているわけではありません。いくつかの例:

  • 行のプレフィックス ( LINES STARTING BY ) は使用できません。
  • ヘッダーを単純にスキップすることはできません ( IGNORE n LINES )。存在する場合は、有効な列名でなければなりません。

厳密な形式

入力ファイルのサイズが 256 MB 前後で一定の場合、Lightning は最適に機能します。入力が単一の巨大な CSV ファイルの場合、Lightning はそれを処理するために 1 つのスレッドしか使用できないため、インポート速度が大幅に低下します。

これは、最初に CSV を複数のファイルに分割することで修正できます。一般的な CSV 形式の場合、ファイル全体を読み取らずに行の開始時刻と終了時刻をすばやく識別する方法はありません。したがって、デフォルトでは、Lightning は CSV ファイルを自動的に分割しませ。ただし、CSV 入力が特定の制限に準拠していることが確実な場合は、 strict-format設定を有効にして、Lightning がファイルを複数の 256 MB サイズのチャンクに分割して並列処理できるようにすることができます。

[mydumper]
strict-format = true

現在、厳密な CSV ファイルは、すべてのフィールドが 1 行のみを占めることを意味します。つまり、次のいずれかに該当する必要があります。

  • 区切り文字が空であるか、または
  • すべてのフィールドにターミネータ自体が含まれているわけではありません。デフォルトの構成では、これはすべてのフィールドに CR ( \r ) または LF ( \n ) が含まれていないことを意味します。

CSV ファイルが厳密ではなく、 strict-formatが誤ってtrueに設定されている場合、複数行にまたがるフィールドが半分に分割されて 2 つのチャンクになり、解析が失敗するか、さらに悪いことに、破損したデータが静かにインポートされる可能性があります。

一般的な構成

CSV

デフォルト設定は、RFC 4180 に従って CSV 用に調整済みです。

[mydumper.csv]
separator = ',' # It is not recommended to use the default ','. It is recommended to use '\|+\|' or other uncommon character combinations.
delimiter = '"'
header = true
not-null = false
null = '\N'
backslash-escape = true

コンテンツの例:

ID,Region,Count
1,"East",32
2,"South",\N
3,"West",10
4,"North",39

TSV

[mydumper.csv]
separator = "\t"
delimiter = ''
header = true
not-null = false
null = 'NULL'
backslash-escape = false

コンテンツの例:

ID    Region    Count
1     East      32
2     South     NULL
3     West      10
4     North     39

TPC-H DBGEN

[mydumper.csv]
separator = '|'
delimiter = ''
terminator = "|\n"
header = false
not-null = true
backslash-escape = false

コンテンツの例:

1|East|32|
2|South|0|
3|West|10|
4|North|39|
エコシステム
TiDB
TiKV
TiSpark
Chaos Mesh
© 2022 PingCAP. All Rights Reserved.