テーブルフィルター

TiDB 移行ツールはデフォルトですべてのデータベースで動作しますが、必要なのはサブセットのみであることがよくあります。たとえば、 foo*bar*の形式のスキーマのみを操作し、それ以外は操作しないとします。

TiDB 4.0 以降、すべての TiDB 移行ツールは、サブセットを定義するための共通のフィルター構文を共有します。このドキュメントでは、テーブル フィルター機能の使用方法について説明します。

使用法

CLI

テーブル フィルターは、複数の-fまたは--filterコマンド ライン パラメーターを使用してツールに適用できます。各フィルターはdb.tableの形式で、各部分はワイルドカードにすることができます ( 次のセクションで詳しく説明します)。以下に使用例を示します。

  • BR :

    ./br backup full -f 'foo*.*' -f 'bar*.*' -s 'local:///tmp/backup'
    ./br restore full -f 'foo*.*' -f 'bar*.*' -s 'local:///tmp/backup'
  • Dumpling :

    ./dumpling -f 'foo*.*' -f 'bar*.*' -P 3306 -o /tmp/data/
  • TiDB Lightning :

    ./tidb-lightning -f 'foo*.*' -f 'bar*.*' -d /tmp/data/ --backend tidb
  • TiDB Lightning :

    ./tidb-lightning -f 'foo*.*' -f 'bar*.*' -d /tmp/data/ --backend tidb

TOML 設定ファイル

TOML ファイルのテーブル フィルターは文字列の配列として指定されます。以下に使用例を示します。

  • TiDB Lightning:

    [mydumper] filter = ['foo*.*', 'bar*.*']
  • TiCDC :

    [filter] rules = ['foo*.*', 'bar*.*'] [[sink.dispatchers]] matcher = ['db1.*', 'db2.*', 'db3.*'] dispatcher = 'ts'

構文

プレーンなテーブル名

各テーブル フィルター ルールは、ドット ( . ) で区切られた「スキーマ パターン」と「テーブル パターン」で構成されます。完全修飾名がルールに一致するテーブルが受け入れられます。

db1.tbl1 db2.tbl2 db3.tbl3

プレーン名は、次のように有効な識別文字のみで構成されている必要があります。

  • 数字 ( 09 )
  • 文字 ( azAZ )
  • $
  • _
  • 非 ASCII 文字 (U+0080 ~ U+10FFFF)

他のすべての ASCII 文字は予約されています。次のセクションで説明するように、一部の句読点には特別な意味があります。

ワイルドカード

名前の各部分には、 fnmatch(3)で説明されているワイルドカード記号を使用できます。

  • * — 0 個以上の文字と一致します
  • ? — 1 つの文字と一致します
  • [a-z] — 「a」と「z」の間の 1 文字を包括的に一致させます。
  • [!a-z] — 「a」から「z」を除く 1 つの文字と一致します。
db[0-9].tbl[0-9a-f][0-9a-f] data.* *.backup_*

ここでの「文字」とは、次のような Unicode コード ポイントを意味します。

  • U+00E9 (é) は 1 文字です。
  • U+0065 U+0301 (é) は 2 文字です。
  • U+1F926 U+1F3FF U+200D U+2640 U+FE0F (🤦🏿‍♀️)は5文字です。

ファイルのインポート

ファイルをフィルター ルールとしてインポートするには、ルールの先頭に@を含めてファイル名を指定します。テーブル フィルター パーサーは、インポートされたファイルの各行を追加のフィルター ルールとして処理します。

たとえば、ファイルconfig/filter.txtに次の内容があるとします。

employees.* *.WorkOrder

次の 2 つの呼び出しは同等です。

./dumpling -f '@config/filter.txt' ./dumpling -f 'employees.*' -f '*.WorkOrder'

フィルター ファイルはさらに別のファイルをインポートできません。

コメントと空白行

フィルター ファイル内では、各行の先頭と末尾の空白がトリミングされます。また、空白行(空文字列)は無視されます。

先頭の#コメントをマークし、無視されます。行の先頭にない#構文エラーとみなされます。

# this line is a comment db.table # but this part is not comment and may cause error

除外

ルールの先頭の!テーブルを処理から除外するために使用されるパターンを意味します。これにより、フィルターが効果的にブロック リストに変わります。

*.* #^ note: must add the *.* to include all tables first !*.Password !employees.salaries

エスケープ文字

特殊文字を識別子文字に変えるには、その前にバックスラッシュ\を付けます。

db\.with\.dots.*

簡素化と将来の互換性のために、次のシーケンスは禁止されています。

  • 空白をトリミングした後の行末の\ (末尾のリテラル空白と一致させるには[ ]を使用します)。
  • \の後に任意の ASCII 英数字 ( [0-9a-zA-Z] ) が続きます。特に、 \0\r\n\tなどの C 風のエスケープ シーケンスは、現時点では意味がありません。

引用符で囲まれた識別子

\のほかに、 "または`を使用して引用符で特殊文字を抑制することもできます。

"db.with.dots"."tbl\1" `db.with.dots`.`tbl\2`

引用符は、それ自体を二重化することで識別子の中に含めることができます。

"foo""bar".`foo``bar` # equivalent to: foo\"bar.foo\`bar

引用符で囲まれた識別子は複数行にまたがることはできません。

識別子の一部を引用することは無効です。

"this is "invalid*.*

正規表現

非常に複雑なルールが必要な場合は、各パターンを/で区切った正規表現として記述することができます。

/^db\d{2,}$/./^tbl\d{2,}$/

これらの正規表現では囲碁方言使用されます。識別子に正規表現と一致する部分文字列が含まれている場合、パターンは一致します。たとえば、 /b/ db01と一致します。

ノート:

正規表現内のすべての/ […]の内側も含めて\/としてエスケープする必要があります。エスケープされていない/ \Q…\Eの間に置くことはできません。

複数のルール

ノート:

このセクションはTiDB Cloudには適用されません。現在、 TiDB Cloud は1 つのテーブル フィルター ルールのみをサポートしています。

テーブル名がフィルタ リスト内のどのルールにも一致しない場合、デフォルトの動作では、そのような一致しないテーブルは無視されます。

ブロック リストを作成するには、最初のルールとして明示的な*.*を使用する必要があります。そうしないと、すべてのテーブルが除外されます。

# every table will be filtered out ./dumpling -f '!*.Password' # only the "Password" table is filtered out, the rest are included. ./dumpling -f '*.*' -f '!*.Password'

フィルター リストでは、テーブル名が複数のパターンに一致する場合、最後の一致によって結果が決まります。例えば:

# rule 1 employees.* # rule 2 !*.dep* # rule 3 *.departments

フィルタリングされた結果は次のようになります。

テーブル名ルール1ルール2ルール3結果
無関係なテーブルデフォルト (拒否)
従業員、従業員ルール 1 (受け入れる)
従業員.dept_empルール 2 (拒否)
従業員.部門ルール 3 (受け入れる)
その他の部門ルール 3 (受け入れる)

ノート:

TiDB ツールでは、システム スキーマはデフォルト構成で常に除外されます。システム スキーマは次のとおりです。

  • INFORMATION_SCHEMA
  • PERFORMANCE_SCHEMA
  • METRICS_SCHEMA
  • INSPECTION_SCHEMA
  • mysql
  • sys

このページは役に立ちましたか?

Playground
新規
登録なしで TiDB の機能をワンストップでインタラクティブに体験できます。
製品
TiDB Cloud
TiDB
価格
PoC お問い合わせ
エコシステム
TiKV
TiFlash
OSS Insight
© 2024 PingCAP. All Rights Reserved.
Privacy Policy.