本文將通過參數說明和示例代碼為您介紹如何使用 PHP SDK 創建數據表。在創建數據表時,您需要指定數據表的結構信息和配置信息。CU 模式(原按量模式)下高性能型實例中的數據表還可以根據需要設置預留讀寫吞吐量。
注意事項
創建數據表后需要幾秒鐘進行加載,在此期間對該數據表的讀寫數據操作均會失敗。請等待數據表加載完畢后再進行數據操作。
如果您有主鍵數據自增的需求,例如電商網站的商品 ID、論壇帖子的 ID 等場景,可以在創建數據時配置主鍵列自增。具體操作,請參見主鍵列自增。
前提條件
已通過控制臺創建實例。具體操作,請參見創建實例。
已初始化 OTSClient。具體操作,請參見初始化 OTSClient。
接口
/**
* 根據指定表結構信息創建數據表。
* 當創建一個數據表后,通常需要等待幾秒鐘時間使partition load完成,才能進行各種操作。
* @param [] $request 請求參數。
* @return [] 返回為空。
* @throws OTSClientException 當參數檢查出錯或服務端返回校驗出錯時拋出異常。
* @throws OTSServerException 當OTS服務端返回錯誤時拋出異常。
*/
public function createTable(array $request);
參數說明
request
包含以下參數:
參數 | 說明 |
table_meta(必選) | 數據表的結構信息,包括如下內容:
|
table_options(必選) | 數據表的配置信息,包括如下內容:
|
index_metas(可選) | 索引列表。每個索引包含以下內容:
|
reserved_throughput(必選) | 預留讀寫吞吐量,單位為 CU。默認值為 0。 重要 僅 CU 模式下高性能型實例支持設置數據表的預留讀寫吞吐量為非零值。 |
stream_spec(可選) | 數據表的 Stream 配置信息,包括如下內容:
|
示例
創建數據表
以下示例用于創建數據表。
$result = $client->createTable([
'table_meta' => [
//設置數據表名稱。
'table_name' => '<TABLE_NAME>',
//設置數據表主鍵列。主鍵為pk1(String類型)和pk2(Integer類型),其中pk1主鍵列為分區鍵,pk2主鍵列為自增列。
'primary_key_schema' => [
['pk1', PrimaryKeyTypeConst::CONST_STRING],
['pk2', PrimaryKeyTypeConst::CONST_INTEGER, PrimaryKeyOptionConst::CONST_PK_AUTO_INCR]
]
],
'table_options' => [
//數據的過期時間,-1表示永不過期。
'time_to_live' => -1,
//最大版本數,屬性列值最多保留1個版本,即保存最新的版本。
'max_versions' => 1,
//有效版本偏差,寫入數據的時間戳與系統當前時間的偏差不能超過86400秒(即1天)。
'deviation_cell_version_in_sec' => 86400
],
'reserved_throughput' => [
//設置預留讀寫吞吐量,容量型實例中的數據表只能設置為0,高性能型實例中的數據表可以設置為非零值。
'capacity_unit' => [
'read' => 0,
'write' => 0
]
]
]);
創建數據表時配置二級索引
創建數據表時配置全局二級索引
以下示例用于同時創建數據表和全局二級索引。
$request = array (
'table_meta' => array (
//設置數據表名稱。
'table_name' => '<TABLE_NAME>',
//設置數據表主鍵列。主鍵為pk1(String類型)和pk2(Integer類型)。
'primary_key_schema' => array (
array('pk1', PrimaryKeyTypeConst::CONST_STRING),
array('pk2', PrimaryKeyTypeConst::CONST_INTEGER)
),
//設置數據表預定義列。預定義列為defcol1(String類型)和defcol2(Integer類型)。
'defined_column' => array(
array('defcol1', DefinedColumnTypeConst::DCT_STRING),
array('defcol2', DefinedColumnTypeConst::DCT_INTEGER)
)
),
'table_options' => [
//數據的過期時間,-1表示永不過期。
'time_to_live' => -1,
//最大版本數,屬性列值最多保留1個版本,即保存最新的版本。
'max_versions' => 1,
//有效版本偏差,寫入數據的時間戳與系統當前時間的偏差不能超過86400秒(即1天)。
'deviation_cell_version_in_sec' => 86400
],
'reserved_throughput' => array (
//設置預留讀寫吞吐量,容量型實例中的數據表只能設置為0,高性能型實例中的數據表可以設置為非零值。
'capacity_unit' => array (
'read' => 0,
'write' => 0
)
),
'index_metas' => array(
array(
//設置索引名稱。
'name' => '<INDEX_NAME>',
//為索引添加主鍵。主鍵列為defcol1、pk1和pk2。
'primary_key' => array('defcol1', 'pk1', 'pk2'),
//為索引添加預定義列。預定義列為defcol2。
'defined_column' => array('defcol2'),
//設置索引類型為全局二級索引。
'index_type' => IndexTypeConst::GLOBAL_INDEX,
//設置索引更新模式為異步更新。
'index_update_mode' => IndexUpdateModeConst::ASYNC_INDEX
),
)
);
//調用創建表方法。
$result = $client->createTable($request);
創建數據表時配置本地二級索引
以下示例用于同時創建數據表和本地二級索引。
$request = array (
'table_meta' => array (
//設置數據表名稱。
'table_name' => '<TABLE_NAME>',
//設置數據表主鍵列。主鍵為pk1(String類型)和pk2(Integer類型)。
'primary_key_schema' => array (
array('pk1', PrimaryKeyTypeConst::CONST_STRING),
array('pk2', PrimaryKeyTypeConst::CONST_INTEGER)
),
//設置數據表預定義列。預定義列為defcol1(String類型)和defcol2(Integer類型)。
'defined_column' => array(
array('defcol1', DefinedColumnTypeConst::DCT_STRING),
array('defcol2', DefinedColumnTypeConst::DCT_INTEGER)
)
),
'table_options' => [
//數據的過期時間,-1表示永不過期。
'time_to_live' => -1,
//最大版本數,屬性列值最多保留1個版本,即保存最新的版本。
'max_versions' => 1,
//有效版本偏差,寫入數據的時間戳與系統當前時間的偏差不能超過86400秒(即1天)。
'deviation_cell_version_in_sec' => 86400
],
'reserved_throughput' => array (
//設置預留讀寫吞吐量,容量型實例中的數據表只能設置為0,高性能型實例中的數據表可以設置為非零值。
'capacity_unit' => array (
'read' => 0,
'write' => 0
)
),
'index_metas' => array(
array(
//設置索引名稱。
'name' => '<INDEX_NAME>',
//為索引添加主鍵。主鍵列為pk1、defcol1和pk2。
'primary_key' => array('pk1', 'defcol1', 'pk2'),
//為索引添加預定義列。預定義列為defcol2。
'defined_column' => array('defcol2'),
//設置索引類型為本地二級索引。
'index_type' => IndexTypeConst::LOCAL_INDEX,
//設置索引更新模式為同步更新。
'index_update_mode' => IndexUpdateModeConst::SYNC_INDEX
),
)
);
//調用創建表方法。
$result = $client->createTable($request);