すべてのプロダクト
Search
ドキュメントセンター

Tablestore:トンネルサービス

最終更新日:Jun 05, 2026

Tablestore CLI を使用してトンネルを作成および管理し、データテーブルから増分、全量、または全量および増分データを消費します。

前提条件

  • Tablestore CLI がインストールされ、アクセス認証情報が設定されていること。 詳細については、「Tablestore CLI」をご参照ください。

  • データテーブルでストリーム (データ変更ログ機能) が有効になっていること。 詳細については、「データテーブル操作」をご参照ください。

トンネルの作成

データテーブルのトンネルを作成します。

create_tunnel -n <tunnelName>

パラメーター

必須

説明

-t, --table

任意

データテーブルの名前。 use コマンドでデータテーブルを選択した場合、このパラメーターは不要です。

-n, --name

必須

トンネルの名前。

-m, --mode

任意

トンネルタイプ。 有効な値は次のとおりです。

  • base_data_only:全量データモード。 テーブル内の既存のデータのみを消費します。

  • stream_data_only (デフォルト):増分データモード。 増分データのみを消費します。

  • base_and_stream:全量および増分モード。 最初に全量データを消費し、次に増分データを消費し続けます。

データテーブルに t1 という名前のトンネルを作成します。

create_tunnel -n t1

出力例:

New tunnel created, its id is '9933470d-8a5e-4972-a5b0-b7ae6f836460'.

トンネルの一覧表示

データテーブルのすべてのトンネルを一覧表示します。

list_tunnel

パラメーター

必須

説明

-t, --table

任意

データテーブルの名前。 use コマンドでデータテーブルを選択した場合、このパラメーターは不要です。

list_tunnel

トンネル詳細の表示

トンネルとチャネルの詳細を表示します。

describe_tunnel -n <tunnelName>

パラメーター

必須

説明

-t, --table

任意

データテーブルの名前。 use コマンドでデータテーブルを選択した場合、このパラメーターは不要です。

-n, --name

必須

トンネルの名前。

-o, --output

任意

出力をローカルファイルに保存します。

t1 トンネルの詳細を表示します。

describe_tunnel -n t1

出力例:

Tunnel Info:
+--------------------------------------+------------+------------+---------------+---------+
| TunnelId                             | TunnelName | TunnelType | Stage         | Expired |
+--------------------------------------+------------+------------+---------------+---------+
| 9933470d-8a5e-4972-a5b0-b7ae6f836460 | t1         | Stream     | ProcessStream | false   |
+--------------------------------------+------------+------------+---------------+---------+

Channel Info:
+-------------------------------------------------------+-------------+---------------+----------+-------------------------------+
| ChannelId                                             | ChannelType | ChannelStatus | ClientId | ChannelRPO                    |
+-------------------------------------------------------+-------------+---------------+----------+-------------------------------+
| cfd2c05b-54b6-48ec-aa6f-feb427f0ca57_1635771329155688 | Stream      | OPEN          |          | 1970-01-01 08:00:00 +0800 CST |
+-------------------------------------------------------+-------------+---------------+----------+-------------------------------+

トンネル消費のシミュレーション

データ消費をシミュレーションして、トンネル内のデータ形式をプレビューします。

consume_tunnel -n <tunnelName> -m mock_consume

パラメーター

必須

説明

-c, --channel

任意

チャネル ID。 指定しない場合、すべてのチャネルを消費します。

-t, --table

任意

データテーブルの名前。 use コマンドでデータテーブルを選択した場合、このパラメーターは不要です。

-n, --name

必須

トンネルの名前。

-m, --mode

必須

消費モード。 有効な値は次のとおりです。

  • shadow_copy (デフォルト):オンラインのトンネルの消費トラフィックをミラーリングします。

  • mock_consume:チェックポイントレコードを更新せずにデータ消費をシミュレートします。

  • real_consume:データを消費し、チェックポイントレコードを更新します。 本番トンネルのチェックポイント状態に影響するため、推奨されません。

t1 トンネルでのデータ消費をシミュレートします。

consume_tunnel -n t1 -m mock_consume

コマンドを実行すると、CLI は受信データを待機します。 テーブルにデータを書き込むと、消費レコードが出力に表示されます。 出力例:

{"Type":0,"Timestamp":1636360028961786,"SequenceInfo":{"Epoch":0,"Timestamp":1636360028961786,"RowIndex":1},"PrimaryKey":{"PrimaryKeys":[{"ColumnName":"uid","Value":"86"},{"ColumnName":"pid","Value":6771}]},"Columns":[{"Type":0,"Name":"name","Value":"redchen","Timestamp":1636360028962},{"Type":0,"Name":"country","Value":"china","Timestamp":1636360028962}]}

トンネルの削除

トンネルを削除します。

drop_tunnel -n <tunnelName> -y

パラメーター

必須

説明

-t, --table

任意

データテーブルの名前。 use コマンドでデータテーブルを選択した場合、このパラメーターは不要です。

-n, --name

必須

トンネルの名前。

-y, --yes

必須

削除を確認し、対話型の確認プロンプトをスキップします。

t1 トンネルを削除します。

drop_tunnel -n t1 -y