最佳使用方式

請(qǐng)根據(jù)實(shí)際查詢需求確定在一張數(shù)據(jù)表中創(chuàng)建多元索引的個(gè)數(shù)。

例如一張數(shù)據(jù)表有5個(gè)字段，分別為id、name、age、city、sex，需要按照name、age或city查詢數(shù)據(jù)時(shí)，有兩種創(chuàng)建多元索引的方式。

• 方法一：一個(gè)字段建立一個(gè)多元索引

  按照name、age或city字段分別創(chuàng)建多元索引，名稱分別為name_index、age_index、city_index。

  • 如果按照城市查詢學(xué)生，則查詢city_index，如果按照年齡查詢學(xué)生，則查詢age_index。

  • 如果查詢年齡小于12歲且城市是成都的學(xué)生，此種方式就無法查詢。

  此方式的實(shí)現(xiàn)類似于全局二級(jí)索引，使用此方式創(chuàng)建多元索引會(huì)帶來更高的費(fèi)用，因此不建議使用此方式創(chuàng)建多元索引。

• 方法二（推薦）：多個(gè)字段創(chuàng)建在一個(gè)多元索引中

  將name、age和city字段創(chuàng)建在一個(gè)多元索引中，名稱為student_index。

  • 如果按照城市查詢學(xué)生，則查詢student_index中city字段；如果按照年齡查詢學(xué)生，則查詢student_index中age字段。

  • 如果查詢年齡小于12歲且城市是成都的學(xué)生，則查詢student_index中age和city字段。

  此方式才能發(fā)揮多元索引最大優(yōu)勢(shì)，不僅功能更豐富，而且價(jià)格會(huì)更低。極力推薦使用此方式創(chuàng)建多元索引。

使用限制

• 創(chuàng)建索引的時(shí)效性

  創(chuàng)建多元索引后，需要等幾秒鐘才能使用，但是此過程中不影響數(shù)據(jù)寫入，只影響索引元信息的查詢和索引查詢。

• 創(chuàng)建多元索引時(shí)，請(qǐng)確保多元索引中的字段類型與表中的字段類型相匹配。更多信息，請(qǐng)參見基礎(chǔ)數(shù)據(jù)類型及映射。

• 數(shù)量限制

  更多信息，請(qǐng)參見多元索引限制。

參數(shù)

創(chuàng)建多元索引時(shí)，需要指定數(shù)據(jù)表名稱（tableName）、多元索引名稱（indexName）和索引的結(jié)構(gòu)信息（indexSchema），其中indexSchema包含fieldSchemas（Index所有字段的設(shè)置）、indexSetting（索引設(shè)置）和indexSort（索引預(yù)排序設(shè)置）。詳細(xì)參數(shù)說明請(qǐng)參見下表。

注意事項(xiàng)

• 當(dāng)要實(shí)現(xiàn)全文檢索時(shí)，您可以在多元索引中將字段設(shè)置為可分詞字符串（TEXT）類型并為TEXT類型的字段設(shè)置分詞，然后使用匹配查詢或短語匹配查詢功能查詢數(shù)據(jù)。關(guān)于分詞的更多信息，請(qǐng)參見分詞。

• 在不修改表格存儲(chǔ)的存儲(chǔ)結(jié)構(gòu)及數(shù)據(jù)的情況下，當(dāng)要實(shí)現(xiàn)新字段和新數(shù)據(jù)類型的查詢功能時(shí)，您可以在多元索引中將字段設(shè)置為虛擬列。更多信息，請(qǐng)參見虛擬列。

• 當(dāng)要使用日期數(shù)據(jù)類型進(jìn)行數(shù)據(jù)查詢時(shí)，您可以在多元索引中將數(shù)據(jù)表中的整型（Integer）或字符串（String）類型的數(shù)據(jù)映射為日期數(shù)據(jù)類型。更多信息，請(qǐng)參見日期時(shí)間類型。

• 當(dāng)要使用數(shù)值向量進(jìn)行近似最近鄰查詢時(shí)，您可以在多元索引中將字段設(shè)置為向量類型，然后使用向量檢索介紹與使用功能查詢數(shù)據(jù)。

• 當(dāng)要使用數(shù)組類型存儲(chǔ)數(shù)據(jù)時(shí)，您可以在數(shù)據(jù)表中以String類型字段存儲(chǔ)數(shù)據(jù)，然后在多元索引中將字段設(shè)置為數(shù)組。

  在寫入數(shù)據(jù)到數(shù)據(jù)表中時(shí)，數(shù)組類型字段的值必須按照J(rèn)SON數(shù)組格式寫入，例如["a","b","c"]。

  說明

  數(shù)組類型僅是多元索引中的概念，數(shù)據(jù)表中還不支持?jǐn)?shù)組。更多信息，請(qǐng)參見數(shù)組和嵌套類型。

• 當(dāng)要使用單字段存儲(chǔ)存在層次關(guān)系或者一對(duì)多關(guān)系的數(shù)據(jù)時(shí)，您可以在多元索引中將字段設(shè)置為嵌套類型，然后使用嵌套類型查詢功能查詢數(shù)據(jù)。

  在寫入數(shù)據(jù)到數(shù)據(jù)表中時(shí)，嵌套類型字段的值必須按照J(rèn)SON數(shù)組格式寫入，例如[{"tagName":"tag1", "score":0.8}, {"tagName":"tag2", "score":0.2}]。

• 當(dāng)要存儲(chǔ)的數(shù)據(jù)為地理位置信息時(shí)，您可以在多元索引中將字段設(shè)置為地理位置（Geo-point）類型，然后使用地理距離查詢、地理長方形范圍查詢或地理多邊形范圍查詢功能查詢數(shù)據(jù)。

• 系統(tǒng)默認(rèn)使用分區(qū)鍵作為路由鍵，當(dāng)要使用其他主鍵列作為路由鍵來定向搜索指定數(shù)據(jù)分區(qū)，以減少長尾對(duì)延遲的影響時(shí)，您可以修改路由字段配置。更多信息，請(qǐng)參見多元索引路由字段的使用。

• 多元索引默認(rèn)按照主鍵升序的排序方式返回查詢結(jié)果，當(dāng)要按照指定字段值或主鍵降序進(jìn)行預(yù)排序時(shí)，您可以修改預(yù)排序方式。更多信息，請(qǐng)參見索引預(yù)排序。

• 當(dāng)要實(shí)現(xiàn)自動(dòng)清理多元索引中的歷史數(shù)據(jù)時(shí)，您可以使用多元索引的數(shù)據(jù)生命周期（TTL）功能有效地管理數(shù)據(jù)，減少數(shù)據(jù)存儲(chǔ)空間，降低存儲(chǔ)成本。更多信息，請(qǐng)參見生命周期管理。

• 當(dāng)要在查詢結(jié)果中高亮突出顯示匹配到的關(guān)鍵詞時(shí)，您可以使用查詢高亮功能實(shí)現(xiàn)。更多信息，請(qǐng)參見查詢高亮。

使用方式

您可以使用控制臺(tái)、命令行工具或者SDK進(jìn)行創(chuàng)建多元索引操作。

進(jìn)行多元索引創(chuàng)建之前，您需要完成如下準(zhǔn)備工作。

• 使用阿里云賬號(hào)或者具有表格存儲(chǔ)操作權(quán)限的RAM用戶進(jìn)行操作。如果需要為RAM用戶授權(quán)表格存儲(chǔ)操作權(quán)限，請(qǐng)參見通過RAM Policy為RAM用戶授權(quán)進(jìn)行配置。

  使用SDK方式和命令行工具方式進(jìn)行操作時(shí)，如果當(dāng)前無可用AccessKey，則需要為阿里云賬號(hào)或者RAM用戶創(chuàng)建AccessKey。具體操作，請(qǐng)參見創(chuàng)建AccessKey。

• 已創(chuàng)建數(shù)據(jù)表。具體操作，請(qǐng)參見數(shù)據(jù)表操作。

• 使用SDK方式進(jìn)行操作時(shí)，還需要完成初始化Client。具體操作，請(qǐng)參見初始化OTSClient。

• 使用命令行工具進(jìn)行操作前，還需要完成下載并啟動(dòng)命令行工具，然后配置接入實(shí)例信息。具體操作，請(qǐng)參見下載命令行工具和啟動(dòng)并配置接入信息。

private static void createSearchIndex(SyncClient client) {
    CreateSearchIndexRequest request = new CreateSearchIndexRequest();
    //設(shè)置數(shù)據(jù)表名稱。
    request.setTableName("<TABLE_NAME>"); 
    //設(shè)置多元索引名稱。
    request.setIndexName("<SEARCH_INDEX_NAME>"); 
    IndexSchema indexSchema = new IndexSchema();
    indexSchema.setFieldSchemas(Arrays.asList(
            //設(shè)置字段名和類型。
            new FieldSchema("Col_Keyword", FieldType.KEYWORD), 
            new FieldSchema("Col_Long", FieldType.LONG),
            // 設(shè)置向量類型。
            new FieldSchema("Col_Vector", FieldType.VECTOR).setIndex(true)
                    // 向量維度為4，相似度算法為點(diǎn)積。
                    .setVectorOptions(new VectorOptions(VectorDataType.FLOAT_32, 4, VectorMetricType.DOT_PRODUCT))
    ));
    request.setIndexSchema(indexSchema);
    //調(diào)用client創(chuàng)建多元索引。
    client.createSearchIndex(request); 
}

private static void createSearchIndexWithIndexSort(SyncClient client) {
    CreateSearchIndexRequest request = new CreateSearchIndexRequest();
    //設(shè)置數(shù)據(jù)表名稱。
    request.setTableName("<TABLE_NAME>"); 
    //設(shè)置多元索引名稱。
    request.setIndexName("<SEARCH_INDEX_NAME>"); 
    IndexSchema indexSchema = new IndexSchema();
    indexSchema.setFieldSchemas(Arrays.asList(
            new FieldSchema("Col_Keyword", FieldType.KEYWORD),
            new FieldSchema("Col_Long", FieldType.LONG),
            new FieldSchema("Col_Text", FieldType.TEXT),
            new FieldSchema("Timestamp", FieldType.LONG)
                    .setEnableSortAndAgg(true)));
    //設(shè)置按照Timestamp列進(jìn)行預(yù)排序。
    indexSchema.setIndexSort(new Sort(
            Arrays.<Sort.Sorter>asList(new FieldSort("Timestamp", SortOrder.ASC))));
    request.setIndexSchema(indexSchema);
    //調(diào)用client創(chuàng)建多元索引。
    client.createSearchIndex(request);
}

// 請(qǐng)使用5.12.0及以上版本的Java SDK。
public static void createIndexWithTTL(SyncClient client) {
    int days = 7;
    CreateSearchIndexRequest request = new CreateSearchIndexRequest();
    //設(shè)置數(shù)據(jù)表名稱。
    request.setTableName("<TABLE_NAME>");
    //設(shè)置多元索引名稱。
    request.setIndexName("<SEARCH_INDEX_NAME>");
    IndexSchema indexSchema = new IndexSchema();
    indexSchema.setFieldSchemas(Arrays.asList(
            //設(shè)置字段名和類型。
            new FieldSchema("Col_Keyword", FieldType.KEYWORD), 
            new FieldSchema("Col_Long", FieldType.LONG)));
    request.setIndexSchema(indexSchema);
    //設(shè)置多元索引TTL。
    request.setTimeToLiveInDays(days);
    //調(diào)用client創(chuàng)建多元索引。
    client.createSearchIndex(request);
}

private static void createSearchIndex(SyncClient client) {
    CreateSearchIndexRequest request = new CreateSearchIndexRequest();
    //設(shè)置數(shù)據(jù)表名稱。
    request.setTableName("<TABLE_NAME>"); 
    //設(shè)置多元索引名稱。
    request.setIndexName("<SEARCH_INDEX_NAME>"); 
    IndexSchema indexSchema = new IndexSchema();
    indexSchema.setFieldSchemas(Arrays.asList(
        //設(shè)置字段名和類型。
        new FieldSchema("Col_Keyword", FieldType.KEYWORD), 
        //設(shè)置字段名和類型。
        new FieldSchema("Col_Keyword_Virtual_Long", FieldType.LONG) 
             //設(shè)置字段是否為虛擬列。
            .setVirtualField(true) 
             //虛擬列對(duì)應(yīng)的數(shù)據(jù)表中字段。
            .setSourceFieldName("Col_Keyword"), 
        new FieldSchema("Col_Long", FieldType.LONG),
        new FieldSchema("Col_Long_Virtual_Keyword", FieldType.KEYWORD)
            .setVirtualField(true)
            .setSourceFieldName("Col_Long")));
    request.setIndexSchema(indexSchema);
    //調(diào)用client創(chuàng)建多元索引。
    client.createSearchIndex(request); 
}

private static void createSearchIndexwithHighlighting(SyncClient client) {
    CreateSearchIndexRequest request = new CreateSearchIndexRequest();
    //設(shè)置數(shù)據(jù)表名稱。
    request.setTableName("<TABLE_NAME>"); 
    //設(shè)置多元索引名稱。
    request.setIndexName("<SEARCH_INDEX_NAME>"); 
    IndexSchema indexSchema = new IndexSchema();
    indexSchema.setFieldSchemas(Arrays.asList(
            //設(shè)置字段名和類型。
            new FieldSchema("Col_Keyword", FieldType.KEYWORD), 
            new FieldSchema("Col_Long", FieldType.LONG),
            //為字段開啟查詢高亮功能。
            new FieldSchema("Col_Text", FieldType.TEXT).setIndex(true).setEnableHighlighting(true)
    ));
    request.setIndexSchema(indexSchema);
    //調(diào)用client創(chuàng)建多元索引。
    client.createSearchIndex(request); 
}

后續(xù)操作

創(chuàng)建多元索引后，您可以通過多元索引進(jìn)行數(shù)據(jù)查詢、數(shù)據(jù)分析與數(shù)據(jù)導(dǎo)出。

相關(guān)文檔

創(chuàng)建多元索引后，請(qǐng)根據(jù)需要執(zhí)行相應(yīng)操作。

• 如果希望清理多元索引中的歷史數(shù)據(jù)或者希望延長數(shù)據(jù)保存時(shí)間，您可以修改多元索引的數(shù)據(jù)生命周期。具體操作，請(qǐng)參見生命周期管理。

• 如果要在多元索引中新增、更新或者刪除索引列，您可以使用動(dòng)態(tài)修改schema功能實(shí)現(xiàn)。具體操作，請(qǐng)參見動(dòng)態(tài)修改schema。

• 如果要獲取某個(gè)數(shù)據(jù)表關(guān)聯(lián)的所有多元索引的列表信息，您可以使用列出多元索引列表功能實(shí)現(xiàn)。具體操作，請(qǐng)參見列出多元索引列表。

• 如果要查詢多元索引的描述信息，包括多元索引的字段信息和索引配置等，您可以使用查詢多元索引描述信息功能實(shí)現(xiàn)。具體操作，請(qǐng)參見查詢多元索引描述信息。

• 如果不再需要使用多元索引，您可以刪除多元索引。具體操作，請(qǐng)參見刪除多元索引。

• 您還可以使用SQL查詢功能或者通過MaxCompute、Spark、Hive或者HadoopMR、函數(shù)計(jì)算、Flink、PrestoDB等計(jì)算引擎計(jì)算與分析表中數(shù)據(jù)。具體操作，請(qǐng)參見SQL查詢和計(jì)算與分析概述。

附錄：距離度量算法說明

向量的距離度量算法說明請(qǐng)參見下表，其中評(píng)分公式的值越大表示的相似度越大。

向量歸一化的示例代碼如下：

  public static float[] l2normalize(float[] v, boolean throwOnZero) {
    double squareSum = 0.0f;
    int dim = v.length;
    for (float x : v) {
      squareSum += x * x;
    }
    if (squareSum == 0) {
      if (throwOnZero) {
        throw new IllegalArgumentException("can't normalize a zero-length vector");
      } else {
        return v;
      }
    }
    double length = Math.sqrt(squareSum);
    for (int i = 0; i < dim; i++) {
      v[i] /= length;
    }
    return v;
  }