使用虚拟列功能时,您可以通过修改多元索引Schema或者新建多元索引来实现新字段新数据类型的查询功能,而无需修改表格存储的存储结构及数据。

前提条件

  • 已初始化Client。具体操作,请参见初始化
  • 已创建数据表,且数据表的数据生命周期(timeToLive)必须为-1,最大版本数(maxVersions)必须为1。

注意事项

  • 虚拟列支持不同类型到字符串类型的相互转换,转换规则请参见下表。
    数据表中字段类型 虚拟列字段类型
    String Keyword(含数组)
    String Text(含数组)
    String Long(含数组)
    String Double(含数组)
    String Geo-point(含数组)
    Long Keyword
    Long Text
    Double Keyword
    Double Text
  • 虚拟列目前仅支持用在查询语句中,不能用在ColumnsToGet返回列值,如果需要返回列值,可以指定返回该虚拟列的原始列。

参数

更多信息,请参见创建多元索引

示例

  1. 创建多元索引时指定虚拟列。
    创建一个多元索引,多元索引包含Col_Keyword和Col_Long两列,同时创建虚拟列Col_Keyword_Virtual_Long和Col_Long_Virtual_Keyword。Col_Keyword_Virtual_Long映射为数据表中Col_Keyword列,虚拟列Col_Long_Virtual_Keyword映射为数据表中Col_Long列。
    private static void createSearchIndex(SyncClient client) {
        CreateSearchIndexRequest request = new CreateSearchIndexRequest();
        request.setTableName("tableName"); //设置数据表名称。
        request.setIndexName("indexName"); //设置多元索引名称。
        IndexSchema indexSchema = new IndexSchema();
        indexSchema.setFieldSchemas(Arrays.asList(
            new FieldSchema("Col_Keyword", FieldType.KEYWORD) //设置字段名和类型。
                .setIndex(true) //设置开启索引。
                .setEnableSortAndAgg(true) //设置开启排序和统计功能。
                .setStore(true),
            new FieldSchema("Col_Keyword_Virtual_Long", FieldType.LONG) //设置字段名和类型。
                .setIndex(true)
                .setEnableSortAndAgg(true)
                .setStore(true)
                .setVirtualField(true) //设置字段是否为虚拟列。
                .setSourceFieldName("Col_Keyword"), //虚拟列对应的数据表中字段。
            new FieldSchema("Col_Long", FieldType.LONG)
                .setIndex(true)
                .setEnableSortAndAgg(true)
                .setStore(true),
            new FieldSchema("Col_Long_Virtual_Keyword", FieldType.KEYWORD)
                .setIndex(true)
                .setEnableSortAndAgg(true)
                .setStore(true)
                .setVirtualField(true)
                .setSourceFieldName("Col_Long")));
        request.setIndexSchema(indexSchema);
        client.createSearchIndex(request); //调用client创建多元索引。
    }
  2. 使用虚拟列查询数据。

    查询表中Col_Long_Virtual_Keyword列的值能够匹配"1000"的数据,返回匹配到的总行数和一些匹配成功的行。

    private static void query(SyncClient client) {
        SearchQuery searchQuery = new SearchQuery();
        TermsQuery termsQuery = new TermsQuery(); //设置查询类型为TermsQuery。
        termsQuery.setFieldName("Col_Long_Virtual_Keyword"); //设置要匹配的字段。
        termsQuery.addTerm(ColumnValue.fromString("1000")); //设置要匹配的值。
        searchQuery.setQuery(termsQuery);
        searchQuery.setGetTotalCount(true); //设置返回匹配的总行数。
        SearchRequest searchRequest = new SearchRequest("tableName", "indexName", searchQuery);
        SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
        columnsToGet.setReturnAll(true); //设置返回所有列,不支持返回虚拟列。
        searchRequest.setColumnsToGet(columnsToGet);
    
        SearchResponse resp = client.search(searchRequest);
        System.out.println("TotalCount: " + resp.getTotalCount()); //匹配到的总行数,非返回行数。
        System.out.println("Row: " + resp.getRows());
    }