CreateSearchIndex
If a table needs to support complex queries, you must create a search index for the table. When creating a search index, you must specify the table_name, index_name, and index_meta parameters.
- table_name: the name of the table for which the search index is created.
- index_name: the name of the search index to be created.
- index_meta: the index schema, including the index_setting, field_schemas, and index_sort
parameters.
- field_schemas: the list of FieldSchemas. Each FieldSchema contains the following parameters:
- (Required) field_fame: String. The name of the field to be indexed, that is, the column name. The field can be a primary key column or an attribute column.
- (Required) field_type: FieldTypeConst::XXX. For more information, see the description of field types for a search index.
- (Optional) is_array: Boolean. Specifies whether the column is an array. A value of true indicates that the column is an array. Data written to the column must be a JSON array, such as ["a","b","c"]. You do not need to explicitly specify this parameter for nested columns because they are arrays.
- (Optional) index: Boolean. Specifies whether to index the column.
- (Optional) index_options: the index configuration options.
- (Optional) analyzer: the tokenizer.
- (Optional) enable_sort_and_agg: Boolean. Specifies whether to enable sorting and statistics collection.
- (Optional) store: Boolean. Specifies whether to store the values of the field in the search index. A value of true indicates that you can read the values of the field directly from the search index without the need to query the table. This optimizes query performance.
- (Optional) index_setting:
- (Optional, advanced feature) routing_fields: the custom routing fields. You can specify some primary key columns as routing fields. Table Store distributes data that is written to a search index to different partitions based on the specified routing fields. The data with the same routing field values is distributed to the same partition.
- (Optional) index_sort: specifies how the index is sorted. The index is sorted in the
same way as the primary key of the table by default.
- sorters: The array of sorting methods. Valid values: primary_key_sort and field_sort.
- primary_key_sort:
- order: Default value: SortOrderConst::SORT_ORDER_ASC.
- field_sort: specifies a field for index sorting.
- field_name: the field for index sorting.
- order: Default value: SortOrderConst::SORT_ORDER_ASC.
- primary_key_sort:
- sorters: The array of sorting methods. Valid values: primary_key_sort and field_sort.
- field_schemas: the list of FieldSchemas. Each FieldSchema contains the following parameters:
/**
* Create a search index.
* @api
*
* @param [] $request
* The request parameters, including the table name and index configuration.
* @return [] The response.
* @throws OTSClientException The exception that is thrown when a parameter check error occurs or the Table Store server returns a verification error.
* @throws OTSServerException The exception that is thrown when the Table Store server returns an error.
* @example "src/examples/CreateSearchIndex.php"
*/
public function createSearchIndex(array $request)$request = array(
'table_name' => 'php_sdk_test',
'index_name' => 'php_sdk_test_search_index',
'schema' => array(
'field_schemas' => array(
array(
'field_name' => 'keyword',
'field_type' => FieldTypeConst::KEYWORD,
'index' => true,
'enable_sort_and_agg' => true,
'store' => true,
'is_array' => false
),
array(
'field_name' => 'text',
'field_type' => FieldTypeConst::TEXT,
'analyzer' => 'single_word',
'index' => true,
'enable_sort_and_agg' => false,
'store' => true,
'is_array' => false
),
array(
'field_name' => 'geo',
'field_type' => FieldTypeConst::GEO_POINT,
'index' => true,
'index_options' => 'DOCS',
'enable_sort_and_agg' => true,
'store' => true,
'is_array' => false
),
array(
'field_name' => 'long',
'field_type' => FieldTypeConst::LONG,
'index' => true,
'enable_sort_and_agg' => true,
'store' => true,
'is_array' => false
),
array(
'field_name' => 'double',
'field_type' => FieldTypeConst::DOUBLE,
'index' => true,
'enable_sort_and_agg' => true,
'store' => true,
'is_array' => false
),
array(
'field_name' => 'boolean',
'field_type' => FieldTypeConst::BOOLEAN,
'index' => true,
'enable_sort_and_agg' => false,
'store' => true,
'is_array' => false
),
array(
'field_name' => 'array',
'field_type' => FieldTypeConst::KEYWORD,
'index' => true,
'enable_sort_and_agg' => false,
'store' => true,
'is_array' => true
),
array(
'field_name' => 'nested',
'field_type' => FieldTypeConst::NESTED,
'index' => false,
'enable_sort_and_agg' => false,
'store' => false,
'field_schemas' => array(
array(
'field_name' => 'nested_keyword',
'field_type' => FieldTypeConst::KEYWORD,
'index' => false,
'enable_sort_and_agg' => false,
'store' => false,
'is_array' => false
)
)
),
),
'index_setting' => array(
'routing_fields' => array("pk1")
),
// "index_sort" => array(// You cannot specify this parameter for nested columns.
// array(
// 'field_sort' => array(
// 'field_name' => 'keyword',
// 'order' => SortOrderConst::SORT_ORDER_ASC,
// 'mode' => SortModeConst::SORT_MODE_AVG,
// )
// ),
// array(
// 'pk_sort' => array(
// 'order' => SortOrderConst::SORT_ORDER_ASC
// )
// ),
// )
)
);
$response = $otsClient->createSearchIndex();