PHP SDK を使用してテーブルの説明をクエリする - Tablestore

DescribeTable オペレーションを呼び出すことで、スキーマ情報、予約済み読み取りスループット、予約済み書き込みスループットなど、テーブルの説明をクエリできます。

説明

DescribeTable オペレーションの詳細については、DescribeTable を参照してください。

前提条件

OTSClient インスタンスが初期化されていること。詳細については、OTSClient インスタンスの初期化を参照してください。
データテーブルが作成されていること。詳細については、データテーブルの作成を参照してください。

API オペレーション

/**
 * テーブルのスキーマ情報、構成情報、予約済み読み取りスループットと予約済み書き込みスループット、および Stream 構成情報をクエリします。
 * @api
 * @param [] $request リクエストパラメータ。
 * @return [] レスポンス。
 * @throws OTSClientException パラメータエラーが発生した場合、または Tablestore サーバーが検証エラーを返した場合にスローされる例外。
 * @throws OTSServerException Tablestore サーバーがエラーを返した場合にスローされる例外。
 */
public function describeTable(array $request);

パラメータ

リクエスト情報

リクエストパラメータ

パラメータ	説明
table_name	テーブルの名前。

リクエスト構文

$result = $client->describeTable([
     'table_name' => '<string>', // テーブルの名前を指定します。テーブル名は必須です。
]);

レスポンス情報

レスポンスパラメータ

パラメータ	説明
table_meta	テーブルに関するスキーマ情報。以下の項目が含まれます。 table_name: テーブルの名前。 primary_key_schema: テーブルのプライマリキースキーマ。テーブルの作成時に定義されたプライマリキースキーマと同じです。 defined_column: テーブルに定義済みの列の定義。
capacity_unit_details	テーブルの予約済み読み取りスループットと予約済み書き込みスループット。以下の項目が含まれます。 capacity_unit は、テーブルの予約済み読み取りスループットと予約済み書き込みスループットの構成を示し、課金に関連しています。単位：CU。 read: 予約済み読み取りスループット。 write: 予約済み書き込みスループット。 last_increase_time: このテーブルの予約済み読み取りスループットまたは予約済み書き込みスループットが最後に増加された時刻。1970年1月1日00:00:00 (UTC) から経過した秒数で表されます。 last_decrease_time: このテーブルの予約済み読み取りスループットまたは予約済み書き込みスループットが最後に減少された時刻。1970年1月1日00:00:00 (UTC) から経過した秒数で表されます。
table_options	テーブルに関する構成情報。以下の項目が含まれます。 time_to_live: テーブル内のデータの保持期間。この期間はデータの有効期間です。 max_versions: 単一の属性列に対して保持できるデータバージョンの最大数。 deviation_cell_version_in_sec: 最大バージョンオフセット。現在のシステム時刻と書き込まれたデータのタイムスタンプの最大差です。
stream_details	テーブルに関する Stream 情報。以下の項目が含まれます。 enable_stream: テーブルに対して Stream が有効になっているかどうかを示します。 stream_id: テーブルの Stream ID。 expiration_time: データテーブルの Stream データの有効期限。単位：時間。古い変更レコードは削除されます。 last_enable_time: Stream が最後に有効になった時刻。

レスポンス構文

[
    'table_meta' => [
        'table_name' => '<string>',
        'primary_key_schema' => [
            ['<string>', <PrimaryKeyType>],
            ['<string>', <PrimaryKeyType>, <PrimaryKeyOption>]
        ],
        'defined_column'=> [
            ['<string>', <DefinedColumnType>] 
        ]
    ],
    'capacity_unit_details' => [
        'capacity_unit' => [
            'read' => <integer>,
            'write' => <integer>
        ],
        'last_increase_time' => <integer>,
        'last_decrease_time' => <integer>
    ],
    'table_options' => [
        'time_to_live' => <integer>,
        'max_versions' => <integer>,
        'deviation_cell_version_in_sec => <integer>
    ],
    'stream_details' => [
        'enable_stream' => true || false,
        'stream_id' => '<string>',
        'expiration_time' => <integer>,
        'last_enable_time' => <integer>
    ]
]

例

次のサンプルコードは、テーブルの説明をクエリする方法の例を示しています:

$result = $client->describeTable([
        'table_name' => 'mySampleTable',
        ]);
        var_dump($result);

参照

テーブルの説明をクエリするために呼び出すことができる API オペレーションについては、DescribeTable を参照してください。