使用DescribeTable接口可以查詢指定表的結構、預留讀/寫吞吐量詳情等信息。
API說明請參見DescribeTable。
前提條件
已初始化Client。更多信息，請參見初始化OTSClient。
已創建數據表。更多信息，請參見創建數據表。
接口
/**
* 獲取一個表的信息，包括表的結構信息、配置信息、預留讀/寫吞吐量詳情和Stream設置信息。
* @api
* @param [] $request 請求參數。
* @return [] 請求返回。
* @throws OTSClientException 當參數檢查出錯或服務端返回校驗出錯時拋出異常。
* @throws OTSServerException 當OTS服務端返回錯誤時拋出異常。
*/
public function describeTable(array $request);參數
請求信息
請求參數
參數 | 說明 |
table_name | 表名。 |
請求格式
$result = $client->describeTable([
'table_name' => '<string>', //設置表名，必須設置。
]);響應信息
響應參數
參數 | 說明 |
table_meta | 表的結構信息，包括如下內容：
|
capacity_unit_details | 表的預留讀寫吞吐量配置詳情，包括如下內容：
|
table_options | 表的配置信息，包括如下內容：
|
stream_details | 數據表的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。
如果要讀寫表中數據，您可以通過調用讀寫數據接口實現。具體操作，請參見基礎數據操作。
如果要修改表的數據生命周期、最大版本數等信息，您可以通過更新表實現。具體操作，請參見更新數據表。
如果不再使用數據表，您可以刪除數據表。具體操作，請參見刪除數據表。