使用CreateSearchIndex接口在數據表上創建一個多元索引。一個數據表支持創建多個多元索引。創建多元索引時,您需要將要查詢的字段添加到多元索引中,您還可以配置多元索引路由鍵、預排序等高級選項。
前提條件
已初始化Client。具體操作,請參見初始化OTSClient。
已創建數據表,并且數據表的最大版本數(max Versions)必須為1,數據生命周期(Time to Live)為-1。具體操作,請參見創建數據表。
注意事項
創建多元索引時,多元索引中字段的數據類型必須與數據表中字段的數據類型相匹配。更多信息,請參見數據類型映射。
接口
/**
* 創建多元索引。
* @api
*
* @param [] $request
* 請求參數、數據表名稱、索引配置等。
* @return [] 請求返回。
* @throws OTSClientException 當參數檢查出錯或服務端返回校驗出錯時拋出異常。
* @throws OTSServerException 當OTS服務端返回錯誤時拋出異常。
* @example "src/examples/CreateSearchIndex.php"
*/
public function createSearchIndex(array $request)
參數
創建多元索引時,需要指定數據表名稱(table_name)、多元索引名稱(index_name)和索引的結構信息(schema),其中schema包含field_schemas(Index的所有字段的設置)、index_setting(索引設置)和index_sort(索引預排序設置)。詳細參數說明請參見下表。
參數 | 說明 |
table_name | 數據表名稱。 |
index_name | 多元索引名稱。 |
field_schemas | field_schema的列表,每個field_schemas包含如下內容:
|
index_setting | 索引設置,包含routing_fields設置。 routing_fields(可選):自定義路由字段。可以選擇部分主鍵列作為路由字段,在進行索引數據寫入時,會根據路由字段的值計算索引數據的分布位置,路由字段的值相同的記錄會被索引到相同的數據分區中。 |
index_sort | 索引預排序設置,包含sorters設置。如果不設置,則默認按照主鍵排序。 說明 含有Nested類型的索引不支持index_sort,沒有預排序。 sorters(必選):索引的預排序方式,支持按照主鍵排序和字段值排序。關于排序的更多信息,請參見排序和翻頁。
|
示例
以下示例用于創建一個多元索引。該多元索引包含keyword(Keyword類型)、text(Text類型)、geo(Geo-point類型)、long(Long類型)、double(Double類型)、boolean(Boolean類型)、array(Keyword類型)、nested(Nested類型)8列,其中nested列包含一個子列nested_keyword(Keyword類型),按照數據表主鍵進行預排序且數據永不過期。
$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,
'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(//含有Nested類型的索引不支持index_sort,沒有預排序。
// 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($request);
常見問題
相關文檔
創建多元索引后,您可以選擇合適的查詢類型進行多維度數據查詢。多元索引查詢類型包括精確查詢、多詞精確查詢、全匹配查詢、匹配查詢、短語匹配查詢、前綴查詢、范圍查詢、通配符查詢、地理位置查詢、多條件組合查詢、嵌套類型查詢和列存在性查詢。
當通過Search接口查詢數據時,如果要對結果集進行排序或者翻頁,您可以使用排序和翻頁功能來實現。具體操作,請參見排序和翻頁。
當通過Search接口查詢數據時,如果要按照某一列對結果集做折疊,使對應類型的數據在結果展示中只出現一次,您可以使用折疊(去重)功能來實現。具體操作,請參見折疊(去重)。
如果要進行數據分析,例如求最值、求和、統計行數等,您可以使用Search接口的統計聚合功能或者SQL查詢來實現。具體操作,請參見統計聚合和SQL查詢。
如果要快速導出數據,而不關心整個結果集的順序時,您可以使用ParallelScan接口和ComputeSplits接口實現多并發導出數據。具體操作,請參見并發導出數據。
如果要在多元索引中新增、更新或者刪除索引列,您可以使用動態修改schema功能實現。具體操作,請參見動態修改schema。
如果要獲取某個數據表關聯的所有多元索引的列表信息,您可以使用列出多元索引列表功能實現。具體操作,請參見列出多元索引列表。
如果要查詢多元索引的描述信息,包括多元索引的字段信息和索引配置等,您可以使用查詢多元索引描述信息功能實現。具體操作,請參見查詢多元索引描述信息。
如果不再需要使用多元索引,您可以刪除多元索引。具體操作,請參見刪除多元索引。