CLI で Tunnel Service を作成、クエリ、削除 - Tablestore

トンネルサービスは、Tablestore 上に構築された統合型サービスであり、完全データおよび増分データのリアルタイム消費を可能にする分散型チャネルを提供します。テーブルに対して、増分専用トンネル、完全データ専用トンネル、または完全データ＋増分データの両方を対象とするトンネルを作成できます。これにより、履歴データと新規データの両方を容易に処理できます。

トンネルタイプ	モード値	説明
フルトンネル	`base_data_only`	完全データのみを消費・処理します。
増分トンネル	`stream_data_only`	増分データのみを消費・処理します。
差分トンネル	`base_and_stream`	まず完全データを消費・処理し、その後に増分データを消費・処理します。

トンネルを作成した後、指定したテーブルからエクスポートされた履歴データおよび増分データの消費に使用できます。

create_tunnel

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

コマンド構文

create_tunnel -n name

以下の表に、設定項目を示します。

パラメーター	必須	例	説明
`-t, --table`	いいえ	`mytable`	データテーブルの名前です。
`-n, --name`	はい	`t1`	トンネルの名前です。
`-m, --mode`	いいえ	`stream_data_only`	トンネルのタイプです。デフォルト値は `stream_data_only` です。有効な値は、`base_data_only`、`stream_data_only`、`base_and_stream` です。各モードの詳細については、上記の「トンネルタイプ」表をご参照ください。

実行例

データテーブル向けに、名前が t1 のトンネルを作成します：

create_tunnel -n t1

実行結果の例：

新しいトンネルが作成されました。ID は '9933470d-8a5e-4972-a5b0-b7ae6f836460' です。

describe_tunnel

トンネルに関する情報およびそのチャンネル情報を照会します。

コマンド構文

describe_tunnel -n name

以下の表に、設定項目を示します。

パラメーター	必須	例	説明
`-t, --table`	いいえ	`mytable`	データテーブルの名前です。
`-n, --name`	はい	`t1`	トンネルの名前です。
`-o, --output`	いいえ	`D:\\otstest\\mytunnel.txt`	応答結果を保存するローカルファイルです。

実行例

名前が t1 のトンネルに関する情報を照会します：

describe_tunnel -n t1

実行結果の例：

トンネル情報:
+--------------------------------------+------------+------------+---------------+---------+
| TunnelId                             | TunnelName | TunnelType | Stage         | Expired |
+--------------------------------------+------------+------------+---------------+---------+
| 9933470d-8a5e-4972-a5b0-b7ae6f836460 | t1         | Stream     | ProcessStream | false   |
+--------------------------------------+------------+------------+---------------+---------+

チャンネル情報:
+-------------------------------------------------------+-------------+---------------+----------+-------------------------------+
| ChannelId                                             | ChannelType | ChannelStatus | ClientId | ChannelRPO                    |
+-------------------------------------------------------+-------------+---------------+----------+-------------------------------+
| cfd2c05b-54b6-48ec-aa6f-feb427f0ca57_1635771329155688 | Stream      | OPEN          |          | 1970-01-01 08:00:00 +0800 CST |
+-------------------------------------------------------+-------------+---------------+----------+-------------------------------+

consume_tunnel

トンネルのデータ消費をシミュレートまたは実行します。トンネルを作成した後、データ消費をシミュレートすることで、トンネル内のデータ形式を事前に確認できます。

コマンド構文

consume_tunnel -n name -m mock_consume

以下の表に、設定項目を示します。

パラメーター	必須	例	説明
`-c, --channel`	いいえ	`cfd2c05b-54b6-48ec-aa6f-feb427f0ca57_1635771329155688`	チャンネルの ID です。このパラメーターを指定しない場合、トンネル内のすべてのチャンネルのデータが消費されます。
`-t, --table`	いいえ	`mytable`	データテーブルの名前です。
`-n, --name`	はい	`t1`	トンネルの名前です。
`-m, --mode`	はい	`mock_consume`	消費モードです。デフォルト値は `shadow_copy` です。有効な値は、`shadow_copy`（オンライントンネルの消費トラフィックをコピー）、`mock_consume`（データ消費をシミュレートし、チェックポイント情報を更新しない）、`real_consume`（データを消費してチェックポイント情報を更新；推奨されません）です。

実行例

名前が t1 のトンネルのデータ消費をシミュレートします：

consume_tunnel -n t1 -m mock_consume

コマンドを実行すると、データテーブルへのデータ書き込み時にデータ消費記録が表示されます。実行結果の例：

トンネル 't1' の消費を開始しています（テーブル 'mytable'）。開始まで数秒かかる場合がありますので、しばらくお待ちください...
null

drop_tunnel

不要になったトンネルを削除します。

コマンド構文

drop_tunnel -n name -y

以下の表に、設定項目を示します。

パラメーター	必須	例	説明
`-t, --table`	いいえ	`mytable`	データテーブルの名前です。
`-n, --name`	はい	`t1`	トンネルの名前です。
`-y, --yes`	はい	該当なし	確認メッセージを表示することを指定します。このパラメーターはコマンドに必ず含める必要があります。

実行例

名前が t1 のトンネルを削除します：

drop_tunnel -n t1 -y