PHP SDK建立多元索引 -

使用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包含如下內容： field_name（必選）：建立索引的欄位名，即列名，類型為String。多元索引中的欄位可以是主鍵列或者屬性列。 field_type（必選）：欄位類型，類型為FieldTypeConst::XXX。更多資訊，請參見資料類型映射。 is_array（可選）：是否為數組，類型為Boolean。如果設定為true，則表示該列是一個數組，在寫入時，必須按照JSON數組格式寫入，例如["a","b","c"]。由於Nested類型是一個數組，當field_type為Nested類型時，無需設定此參數。 index（可選）：是否開啟索引，類型為Boolean。預設為true，表示對該列構建倒排索引或者空間索引；如果設定為false，則不會對該列構建索引。 analyzer（可選）：分詞器類型。當欄位類型為Text時，可以設定此參數；如果不設定，則預設分詞器類型為單字分詞。關於分詞的更多資訊，請參見分詞。 enable_sort_and_agg（可選）：是否開啟排序與統計彙總功能，類型為Boolean。只有enable_sort_and_agg設定為true的欄位才能進行排序。關於排序的更多資訊，請參見排序和翻頁。重要 Nested類型的欄位不支援開啟排序與統計彙總功能，但是Nested類型內部的子列支援開啟排序與統計彙總功能。 store（可選）：是否在多元索引中附加儲存該欄位的值，類型為Boolean。
index_setting	索引設定，包含routing_fields設定。 routing_fields（可選）：自訂路由欄位。可以選擇部分主鍵列作為路由欄位，在進行索引資料寫入時，會根據路由欄位的值計算索引資料的分布位置，路由欄位的值相同的記錄會被索引到相同的資料分區中。
index_sort	索引預排序設定，包含sorters設定。如果不設定，則預設按照主鍵排序。說明含有Nested類型的索引不支援index_sort，沒有預排序。 sorters（必選）：索引的預排序方式，支援按照主鍵排序和欄位值排序。關於排序的更多資訊，請參見排序和翻頁。 PrimaryKeySort表示按照主鍵排序，包含如下設定： order：排序的順序，可按升序或者降序排序，預設為升序（SortOrderConst::SORT_ORDER_ASC）。 FieldSort表示按照欄位值排序，包含如下設定：只有建立索引且開啟排序與統計彙總功能的欄位才能進行預排序。 field_name：排序的欄位名。 order：排序的順序，可按照升序或者降序排序，預設為升序（SortOrderConst::SORT_ORDER_ASC）。 mode：當欄位存在多個值時的排序方式。

樣本

以下樣本用於建立一個多元索引。該多元索引包含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);

：建立多元索引

前提條件

注意事項

介面

參數

樣本

常見問題

相關文檔