后缀查询

重要

本文中含有需要您注意的重要提示信息,忽略该信息可能对您的业务造成影响,请务必仔细阅读。

后缀查询(SuffixQuery)是通过指定后缀条件查询索引中的数据,例如通过手机尾号后4位查询快递。

功能概述

后缀查询主要用于查找以特定后缀结尾的数据。使用SuffixQuery功能查询数据时,您需要指定后缀值。

当前支持用于SuffixQuery的数据类型只有FuzzyKeyword。FuzzyKeyword是专门为SuffixQuery等模糊查询功能优化过的数据类型,在小、中、大规模数据上的查询性能均会更好更稳定,且性能基本不会随着数据规模增长而下降。

说明

如果希望在Keyword类型上实现后缀查询效果,您可以在写入数据时将数据翻转,然后使用 PrefixQuery功能进行数据查询。

接口

后缀查询的接口为Search或者ParallelScan,具体的Query类型为SuffixQuery。

参数

参数

说明

query

设置查询类型为SuffixQuery。

fieldName

要匹配的字段。

suffix

后缀值。

getTotalCount

是否返回匹配的总行数,默认为false,表示不返回。

返回匹配的总行数会影响查询性能。

weight

查询权重,用于全文检索场景中的score排序。查询时指定列的算分权重,值越大,结果中分数的值会越大。取值范围为正浮点数。

使用此参数不会影响返回的结果数,只会影响返回的结果中的分数。

tableName

数据表名称。

indexName

多元索引名称。

columnsToGet

是否返回所有列,包含returnAllcolumns设置。

returnAll默认为false,表示不返回所有列,此时可以通过columns指定返回的列;如果未通过columns指定返回的列,则只返回主键列。

当设置returnAlltrue时,表示返回所有列。

示例

重要

目前只支持使用Java SDK进行后缀查询。表格存储Java SDK5.17.0版本开始支持后缀查询功能。

进行后缀查询之前,您需要完成如下准备工作。

  • 使用阿里云账号或者具有表格存储操作权限的RAM用户进行操作。如果需要为RAM用户授权表格存储操作权限,请参见通过RAM PolicyRAM用户授权进行配置。

    使用SDK方式进行操作时,如果当前无可用AccessKey,则需要为阿里云账号或者RAM用户创建AccessKey。具体操作,请参见创建AccessKey

    警告

    阿里云账号AccessKey泄露会威胁您所有资源的安全。建议您使用RAM用户AccessKey进行操作,可以有效降低AccessKey泄露的风险。

  • 已创建数据表。具体操作,请参见数据表操作

  • 已为数据表创建多元索引。具体操作,请参见创建多元索引

  • 使用SDK方式进行操作时,还需要完成初始化Client。具体操作,请参见初始化OTSClient

以下示例用于查询表中Col_FuzzyKeyword列的值中后缀为"hangzhou"的数据。

/**
 * 查询表中Col_FuzzyKeyword列中后缀为"hangzhou"的数据。
 * @param client
 */
private static void suffixQuery(SyncClient client) {
    SearchQuery searchQuery = new SearchQuery();
    SuffixQuery suffixQuery = new SuffixQuery(); //设置查询类型为PrefixQuery。
    searchQuery.setGetTotalCount(true);
    suffixQuery.setFieldName("Col_FuzzyKeyword");
    suffixQuery.setSuffix("hangzhou");
    searchQuery.setQuery(suffixQuery);
    //searchQuery.setGetTotalCount(true); //设置返回匹配的总行数。

    SearchRequest searchRequest = new SearchRequest("<TABLE_NAME>", "<SEARCH_INDEX_NAME>", searchQuery);
    //通过设置columnsToGet参数可以指定返回的列或返回所有列,如果不设置此参数,则默认只返回主键列。
    SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
    //columnsToGet.setReturnAll(true); //设置为返回所有列。
    columnsToGet.setColumns(Arrays.asList("Col_FuzzyKeyword")); //设置为返回指定列。
    searchRequest.setColumnsToGet(columnsToGet);

    SearchResponse resp = client.search(searchRequest);
    //System.out.println("TotalCount: " + resp.getTotalCount()); //打印匹配到的总行数,非返回行数。
    System.out.println("Row: " + resp.getRows());
}

计费说明

使用VCU模式(原预留模式)时,使用多元索引查询数据会消耗VCU的计算资源。使用CU模式(原按量模式)时,使用多元索引查询数据会消耗读吞吐量。更多信息,请参见多元索引计量计费

常见问题

相关文档