コマンドラインインターフェイスを使用したデータテーブルの管理 - Tablestore

前提条件

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

テーブルの作成

データテーブルを作成するには、プライマリキー列を指定し、任意でデータの有効期間 (TTL) と最大バージョン数を設定します。または、JSON 設定ファイルからテーブルを作成することもできます。

create -t tableName --pk '[{"c":"col1","t":"string"},{"c":"col2","t":"integer"}]' [--ttl seconds] [--version max]

パラメーター	必須	説明
`-t, --table`	はい	データテーブルの名前。
`-k, --pk`	はい	JSON 配列形式のプライマリキー列の定義。各要素には、次のフィールドが含まれます： `c` (必須)：プライマリキー列の名前。 `t` (必須)：プライマリキー列の型。有効値： `string`、`integer`、`binary`。 `opt` (任意)：デフォルト値： `none`。 `auto` に設定すると、列を自動インクリメントプライマリキー列として使用します。自動インクリメントプライマリキー列の詳細については、「自動インクリメントプライマリキー列」をご参照ください。説明データテーブルの作成時に属性列を定義する必要はありません。 Tablestore の各行は、異なる属性列を持つことができます。属性列名は、データを書き込むときに指定します。データテーブルは、最大 4 つのプライマリキー列をサポートします。最初のプライマリキー列は、デフォルトでパーティションキーになります。テーブルの作成後にプライマリキーの設定を変更することはできません。
`-m, --model`	いいえ	テーブルの型。デフォルト値： `widecolumn` (データテーブル)。時系列テーブルを作成するには、「TimeSeries モデル」をご参照ください。
`--ttl`	いいえ	データの有効期間 (TTL) (単位：秒)。デフォルト値： `-1` (データは無期限になります)。値は -1、または 86400 (1 日) 以上である必要があります。
`--version`	いいえ	最大バージョン数。デフォルト値： `1`。値は 0 以外の整数である必要があります。重要 Tablestore は最大バージョン数にハードリミットを設けていません。ただし、最適なパフォーマンスとユーザビリティを確保するため、この値は 500 以下にすることを推奨します。
`--read_cu`	いいえ	予約済みの読み取り/書き込みスループット (単位：キャパシティユニット (CU))。デフォルト値： `0` (従量課金)。説明この設定は、高性能インスタンス内のデータテーブルでのみサポートされます。予約済みの読み取り/書き込みスループットが 0 以外の値に設定されている場合、読み取り/書き込みリクエストが送信されたかどうかにかかわらず課金されます。
`--write_cu`	いいえ
`-d, --defined`	いいえ	JSON 配列形式の事前定義列。セカンダリインデックスに必要です。各要素には、次のフィールドが含まれます： `c` (必須)：事前定義列の名前。 `t` (必須)：事前定義列の型。有効値： `string`、`integer`、`binary`、`double`、`bool`。説明データテーブルは、デフォルトで最大 32 の事前定義列をサポートします。
`--stream_enable`	いいえ	ストリームを有効にするかどうかを指定します。デフォルト値： `false`。
`--stream_expire`	いいえ	ストリームデータの有効期間 (単位：時間)。デフォルト値： `24`。
`-i, --input`	いいえ	テーブルを作成するための JSON 設定ファイルのパス。

基本的なデータテーブルの作成：

create -t mytable --pk '[{"c":"uid","t":"string"},{"c":"pid","t":"integer"}]'

自動インクリメント列と TTL を持つデータテーブルの作成：

create -t mytable --pk '[{"c":"uid","t":"string"},{"c":"pid","t":"integer","opt":"auto"}]' --ttl 864000 --version 1

セカンダリインデックス用の事前定義列を持つデータテーブルの作成：

create -t mytable --pk '[{"c":"uid","t":"string"},{"c":"pid","t":"integer"}]' --defined '[{"c":"name","t":"string"},{"c":"age","t":"integer"}]'

設定ファイルからデータテーブルを作成：

Windows

create -i D:\\localpath\\filename.json

Linux と macOS

create -i /localpath/filename.json

設定ファイルの例：

{
    "Name": "mytable",
    "Meta": {
        "Pk": [
            {"C": "uid", "T": "string", "Opt": "none"},
            {"C": "pid", "T": "integer", "Opt": "none"}
        ]
    },
    "Option": {
        "TTL": 864000,
        "Version": 3
    },
    "CU": {
        "Read": 0,
        "Write": 0
    }
}

テーブルの選択

後続のデータ操作のためにデータテーブルを選択します。

use --wc -t tableName

パラメーター	必須	説明
`--wc`	いいえ	ワイドカラムデータテーブルを選択します。
`-t, --table`	はい	テーブルの名前。

例：

use --wc -t mytable

テーブル名の一覧表示

現在のインスタンス内のテーブルの名前を一覧表示します。必要に応じて、テーブルタイプで結果をフィルタリングします。

list [--wc | --all] [--detail]

パラメーター	必須	説明
`-w, --wc`	いいえ	データテーブルのみを一覧表示します。
`-a, --all`	いいえ	すべてのテーブルタイプを一覧表示します。
`-d, --detail`	いいえ	テーブルの詳細情報を表示します。

例：

list --wc

テーブル詳細の表示

データテーブルまたはインデックステーブルの設定詳細を表示します。

desc [-t tableName] [-f json|table] [-o outputFile]

パラメーター	必須	説明
`-t, --table`	いいえ	データテーブルまたはインデックステーブルの名前。省略した場合は、`use` で選択したテーブルがデフォルトになります。
`-f, --print_format`	いいえ	出力形式。有効値： `json` (デフォルト) および `table`。
`-o, --output`	いいえ	出力をローカルファイルに保存します。

例：

desc -t mytable

テーブルの更新

データテーブルの設定 (データの有効期間 (TTL)、最大バージョン数、予約済みの読み取り/書き込みスループットなど) を更新します。

alter -t tableName [--ttl seconds] [--version max] [--read_cu n] [--write_cu n]

パラメーター	必須	説明
`-t, --table`	いいえ	テーブルの名前。 `use` でテーブルが選択されている場合、このパラメーターは任意です。
`--ttl`	いいえ	データの有効期間 (TTL) (単位：秒)。値は -1 (データは無期限になります)、または 86400 (1 日) 以上である必要があります。
`--version`	いいえ	最大バージョン数。値は 0 以外の整数である必要があります。
`--read_cu`	いいえ	予約済みの読み取り/書き込みスループット (単位：キャパシティユニット (CU))。この設定は、高性能インスタンスでのみサポートされます。
`--write_cu`	いいえ
`--stream_enable`	いいえ	ストリームを有効にするかどうかを指定します。
`--stream_expire`	いいえ	ストリームデータの有効期間 (単位：時間)。
`--disallow_update`	いいえ	更新操作を無効にするかどうかを指定します。

TTL を 1 日に、最大バージョン数を 1 に設定します。

alter -t mytable --ttl 86400 --version 1

テーブルの削除

指定のデータテーブルを削除します。

drop -t tableName [-y]

パラメーター	必須	説明
`-t, --table`	はい	テーブルの名前。
`-y, --yes`	いいえ	確認プロンプトをスキップして、テーブルを直接削除します。

例：

drop -t mytable -y