このトピックでは、Tablestore SDK for PHP を使用して、パラメーターとサンプルコードを使用してデータテーブルを作成する方法について説明します。データテーブルを作成するときは、データテーブルに関するスキーマ情報と構成情報を指定する必要があります。、高性能インスタンスのデータテーブルに対して予約済み読み取りスループットと書き込みスループットを指定できます。
Usage notes
After you create a data table, a few seconds are required to load the data table. During this period, all read and write operations on the data table fail. Perform operations on the data table after the data table is loaded.
In scenarios that require an auto-increment primary key column, such as item IDs on e-commerce websites and post IDs in forums, you can specify an auto-increment primary key column when you create a data table. For more information, see Configure an auto-increment primary key column.
Prerequisites
An instance is created in the Tablestore console. For more information, see Create an instance.
An OTSClient instance is initialized. For more information, see Initialize an OTSClient instance.
API operation
/**
* Create a data table based on the specified table schema.
* After you create a data table, several seconds are required to load the partitions in the data table. You can perform operations on the data table only after the partitions are loaded.
* @param [] $request The request parameters.
* @return [] The response is empty.
* @throws OTSClientException The exception that is thrown when a parameter error occurs or the Tablestore server returns a verification error.
* @throws OTSServerException The exception that is thrown when the Tablestore server returns an error.
*/
public function createTable(array $request); パラメーター
次の表に、request に含まれるパラメーターを示します。
パラメーター | 説明 |
table_meta (必須) | データテーブルに関するスキーマ情報。スキーマ情報を指定するには、次のパラメーターを設定します。
|
table_options (必須) | データテーブルに関する構成情報。構成情報を指定するには、次のパラメーターを設定します。
|
index_metas (オプション) | インデックスのリスト。各インデックスについて、次のパラメーターを設定できます。
|
reserved_throughput (必須) | 予約済み読み取り/書き込みスループット。単位：キャパシティユニット（CU）。デフォルト値：0。 重要 高性能インスタンスのデータテーブルの場合のみ、予約済み読み取りスループットまたは書き込みスループットを 0 以外の値に設定できます。 |
stream_spec (オプション) | データテーブルに関する Stream 構成情報。Stream 構成情報を指定するには、次のパラメーターを設定します。
|
Examples
Create a data table
The following sample code provides an example on how to create a data table:
$result = $client->createTable([
'table_meta' => [
// Specify the name of the data table.
'table_name' => '<TABLE_NAME>',
// Specify the primary key columns of the data table. The table contains the pk1 primary key column of the String type and the pk2 primary key column of the Integer type. The pk1 primary key column is the partition key. The pk2 primary key column is an auto-increment primary key column.
'primary_key_schema' => [
['pk1', PrimaryKeyTypeConst::CONST_STRING],
['pk2', PrimaryKeyTypeConst::CONST_INTEGER, PrimaryKeyOptionConst::CONST_PK_AUTO_INCR]
]
],
'table_options' => [
// Specify the time to live (TTL) of data in the data table. A value of -1 specifies that data in the data table never expires.
'time_to_live' => -1,
// Specify the maximum number of versions that can be retained for data in each attribute column of the data table. In this example, only the latest version of data can be retained for each attribute column.
'max_versions' => 1,
// Specify the maximum difference between the current system time and the timestamp of the written data. In this example, the maximum difference is set to 86,400 seconds (one day).
'deviation_cell_version_in_sec' => 86400
],
'reserved_throughput' => [
// Specify the reserved read or write throughput. You can set the reserved read or write throughput only to 0 for a data table in a capacity instance. You can set the reserved read or write throughput to a value other than 0 for a data table in a high-performance instance.
'capacity_unit' => [
'read' => 0,
'write' => 0
]
]
]);Create a data table and a secondary index
Create a data table and a global secondary index
The following sample code provides an example on how to create a data table and a global secondary index for the data table at the same time:
$request = array (
'table_meta' => array (
// Specify the name of the data table.
'table_name' => '<TABLE_NAME>',
// Specify the primary key columns of the data table. The data table contains the pk1 primary key column of the String type and the pk2 primary key column of the Integer type.
'primary_key_schema' => array (
array('pk1', PrimaryKeyTypeConst::CONST_STRING),
array('pk2', PrimaryKeyTypeConst::CONST_INTEGER)
),
// Specify the predefined columns of the data table. The predefined columns of the data table are the defcol1 column of the String type and the defcol2 column of the Integer type.
'defined_column' => array(
array('defcol1', DefinedColumnTypeConst::DCT_STRING),
array('defcol2', DefinedColumnTypeConst::DCT_INTEGER)
)
),
'table_options' => [
// Specify the TTL of data in the data table. A value of -1 specifies that data in the data table never expires.
'time_to_live' => -1,
// Specify the maximum number of versions that can be retained for data in each attribute column of the data table. In this example, only the latest version of data can be retained for each attribute column.
'max_versions' => 1,
// Specify the maximum difference between the current system time and the timestamp of the written data. In this example, the maximum difference is set to 86,400 seconds (one day).
'deviation_cell_version_in_sec' => 86400
],
'reserved_throughput' => array (
// Specify the reserved read or write throughput. You can set the reserved read or write throughput only to 0 for a data table in a capacity instance. You can set the reserved read or write throughput to a value other than 0 for a data table in a high-performance instance.
'capacity_unit' => array (
'read' => 0,
'write' => 0
)
),
'index_metas' => array(
array(
// Specify the name of the index.
'name' => '<INDEX_NAME>',
// Add primary key columns to the index. The primary key columns of the index are defcol1, pk1, and pk2.
'primary_key' => array('defcol1', 'pk1', 'pk2'),
// Add predefined columns to the index. The predefined column of the index is defcol2.
'defined_column' => array('defcol2'),
// Set the index type to global secondary index.
'index_type' => IndexTypeConst::GLOBAL_INDEX,
// Set the index update mode to asynchronous update.
'index_update_mode' => IndexUpdateModeConst::ASYNC_INDEX
),
)
);
// Call the method to create the table.
$result = $client->createTable($request);Create a data table and a local secondary index
The following sample code provides an example on how to create a data table and a local secondary index for the data table at the same time:
$request = array (
'table_meta' => array (
// Specify the name of the data table.
'table_name' => '<TABLE_NAME>',
// Specify the primary key columns of the data table. The data table contains the pk1 primary key column of the String type and the pk2 primary key column of the Integer type.
'primary_key_schema' => array (
array('pk1', PrimaryKeyTypeConst::CONST_STRING),
array('pk2', PrimaryKeyTypeConst::CONST_INTEGER)
),
// Specify the predefined columns of the data table. The predefined columns of the data table are the defcol1 column of the String type and the defcol2 column of the Integer type.
'defined_column' => array(
array('defcol1', DefinedColumnTypeConst::DCT_STRING),
array('defcol2', DefinedColumnTypeConst::DCT_INTEGER)
)
),
'table_options' => [
// Specify the TTL of data in the data table. A value of -1 specifies that data in the data table never expires.
'time_to_live' => -1,
// Specify the maximum number of versions that can be retained for data in each attribute column of the data table. In this example, only the latest version of data can be retained for each attribute column.
'max_versions' => 1,
// Specify the maximum difference between the current system time and the timestamp of the written data. In this example, the maximum difference is set to 86,400 seconds (one day).
'deviation_cell_version_in_sec' => 86400
],
'reserved_throughput' => array (
// Specify the reserved read or write throughput. You can set the reserved read or write throughput only to 0 for a data table in a capacity instance. You can set the reserved read or write throughput to a value other than 0 for a data table in a high-performance instance.
'capacity_unit' => array (
'read' => 0,
'write' => 0
)
),
'index_metas' => array(
array(
// Specify the name of the index.
'name' => '<INDEX_NAME>',
// Add primary key columns to the index. The primary key columns of the index are pk1, defcol1, and pk2.
'primary_key' => array('pk1', 'defcol1', 'pk2'),
// Add predefined columns to the index. The predefined column of the index is defcol2.
'defined_column' => array('defcol2'),
// Set the index type to local secondary index.
'index_type' => IndexTypeConst::LOCAL_INDEX,
// Set the index update mode to synchronous update.
'index_update_mode' => IndexUpdateModeConst::SYNC_INDEX
),
)
);
// Call the method to create the table.
$result = $client->createTable($request);References
For information about the API operation that you can call to create a data table, see CreateTable.
For information about data versions and TTL, secondary indexes, and reserved read and write throughput, see Data versions and TTL, Overview, and What is reserved read and write throughput?
After you create a data table, you can perform the following operations:
Operations on the table. For more information, see Table operations.
Operations on data. For more information, see Basic operations on data.