DescribeTable オペレーションを呼び出すことで、スキーマ情報、予約済み読み取りスループット、予約済み書き込みスループットなど、テーブルの記述をクエリできます。
前提条件
OTSClient インスタンスが初期化されていること。詳細については、OTSClient インスタンスの初期化を参照してください。
データテーブルが作成されていること。詳細については、データテーブルの作成を参照してください。
API オペレーション
// テーブル名を使用してテーブルの記述をクエリします。
DescribeTable(request *DescribeTableRequest) (*DescribeTableResponse, error)
パラメーター
パラメーター | 必須 | 説明 |
TableName | はい | テーブルの名前 |
例
次のサンプルコードは、テーブルの最大バージョン数と有効期限 (TTL) をクエリする方法の例を示しています:
func DescribeTableSample(client *tablestore.TableStoreClient, tableName string){
describeTableReq := new(tablestore.DescribeTableRequest)
describeTableReq.TableName = tableName
describ, err := client.DescribeTable(describeTableReq)
if err != nil {
fmt.Println("failed to update table with error:", err) // エラーが発生してテーブルを更新できませんでした:
} else {
fmt.Println("DescribeTableSample finished. Table meta:", describ.TableOption.MaxVersion, describ.TableOption.TimeToAlive) // DescribeTableSample が完了しました。テーブルメタデータ:
}
}
参照
テーブルの記述をクエリするために呼び出すことができる API オペレーションについては、DescribeTable を参照してください。詳細なサンプルコードについては、DescribeTable@GitHub をご覧ください。