使用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。
如果要讀寫表中資料，您可以通過調用讀寫資料介面實現。具體操作，請參見基礎資料操作。
如果要修改表的資料生命週期、最大版本數等資訊，您可以通過更新表實現。具體操作，請參見更新資料表。
如果不再使用資料表，您可以刪除資料表。具體操作，請參見刪除資料表。