前缀查询 - 表格存储

前缀查询（PrefixQuery）是通过指定前缀条件查询索引中的数据。

功能概述

前缀查询主要用于查找以特定字符串开头的数据。使用PrefixQuery功能查询数据时，您需要指定前缀值。

目前支持用于PrefixQuery的数据类型包括Keyword、FuzzyKeyword和Text。

Keyword类型：字符串基础数据类型，在中大规模数据上执行PrefixQuery等模糊查询的性能较差，且性能会随着数据规模增长而下降。
FuzzyKeyword类型：专门为PrefixQuery等模糊查询功能优化过的数据类型，在小、中、大规模数据上的查询性能均会更好更稳定，且性能基本不会随着数据规模增长而下降。
Text类型：只要Text类型字段值分词后的词条中有词条满足前缀条件即可，但是，由于分词存在不确定性，一般不会在Text类型上使用PrefixQuery。当前只是为了兼容性才支持此方式，请慎重使用。

接口

前缀查询的接口为Search或者ParallelScan，具体的Query类型为PrefixQuery。

参数

参数	说明
query	设置查询类型为PrefixQuery。
fieldName	要匹配的字段。
prefix	前缀值。对于Text类型字段，只要分词后的词条中有词条满足前缀条件即可。
getTotalCount	是否返回匹配的总行数，默认为false，表示不返回。返回匹配的总行数会影响查询性能。
weight	查询权重，用于全文检索场景中的score排序。查询时指定列的算分权重，值越大，结果中分数的值会越大。取值范围为正浮点数。使用此参数不会影响返回的结果数，只会影响返回的结果中的分数。
tableName	数据表名称。
indexName	多元索引名称。
columnsToGet	是否返回所有列，包含returnAll和columns设置。 returnAll默认为false，表示不返回所有列，此时可以通过columns指定返回的列；如果未通过columns指定返回的列，则只返回主键列。当设置returnAll为true时，表示返回所有列。

使用方式

您可以使用控制台、命令行工具或者SDK进行前缀查询。进行前缀查询之前，您需要完成如下准备工作。

重要

目前基于FuzzyKeyword类型的PrefixQuery只支持使用表格存储SDK实现。

使用阿里云账号或者使用具有表格存储操作权限的RAM用户进行操作。如果需要为RAM用户授权表格存储操作权限，请参见通过RAM Policy为RAM用户授权进行配置。
使用SDK方式和命令行工具方式进行操作时，如果当前无可用AccessKey，则需要为阿里云账号或者RAM用户创建AccessKey。具体操作，请参见创建AccessKey。
已创建数据表。具体操作，请参见数据表操作。
已为数据表创建多元索引。具体操作，请参见创建多元索引。
使用SDK方式进行操作时，还需要完成初始化Client。具体操作，请参见初始化OTSClient。
使用命令行工具方式进行操作前，还需要完成下载并启动命令行工具，然后配置接入实例信息并选择要操作的表。具体操作，请参见下载命令行工具、启动并配置接入信息和数据表操作。

使用控制台

进入索引管理页签。
1. 登录表格存储控制台。
2. 在页面上方，选择资源组和地域。
3. 在概览页面，单击实例名称或在操作列单击实例管理。
4. 在实例详情页签下的数据表列表页签，单击数据表名称或在操作列单击索引管理。
在索引管理页签，单击目标多元索引操作列的搜索。
在查询数据对话框，查询数据。
1. 系统默认返回所有列，如需显示指定属性列，关闭获取所有列并输入需要返回的属性列，多个属性列之间用半角逗号（,）隔开。
  说明
  系统默认会返回数据表的主键列。
2. 根据需要选择逻辑操作符为And、Or或者Not。
  当选择逻辑操作符为And时，返回满足指定条件的数据。当选择逻辑操作符为Or时，如果配置了单个条件，则返回满足指定条件的数据；如果配置了多个条件，则返回满足任意一个条件的数据。当选择逻辑操作符为Not时，返回不满足指定条件的数据。
3. 选择索引字段，单击添加。
4. 设置索引字段的查询类型为前缀查询（PrefixQuery）和输入要查询的值。
5. 系统默认关闭排序功能，如需根据指定字段对返回结果进行排序，打开是否排序开关后，根据需要添加要进行排序的字段并配置排序方式。
6. 系统默认关闭统计功能，如需对指定字段进行数据统计，打开是否统计开关后，根据需要添加要进行统计的字段和配置统计信息。
单击确定。
符合查询条件的数据会显示在索引管理页签中。

使用命令行工具

通过命令行工具执行search命令使用多元索引查询数据。更多信息，请参见多元索引。

重要

目前命令行工具仅支持Keyword类型的PrefixQuery，不支持FuzzyKeyword类型。

执行search命令使用search_index多元索引查询表中数据，并返回所有建立索引的列。
```
search -n search_index --return_all_indexed
```

根据系统提示输入查询条件，示例如下：

{
    "Offset": -1,
    "Limit": 10,
    "Collapse": null,
    "Sort": null,
    "GetTotalCount": true,
    "Token": null,
    "Query": {
        "Name": "PrefixQuery",
        "Query": {
            "FieldName": "col_keyword",
            "Prefix": "hangzhou"
        }
    }
}

使用SDK

您可以通过Java SDK、Go SDK、Python SDK、Node.js SDK、.NET SDK和PHP SDK使用前缀查询。此处以Java SDK为例介绍前缀查询的使用。

说明

实际使用时，不论是Keyword类型还是FuzzyKeyword类型，查询语句是完全相同的，只是查询列的类型不同。

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

/**
 * 查询表中Col_Keyword列中前缀为"hangzhou"的数据。
 * @param client
 */
private static void prefixQuery(SyncClient client) {
    SearchQuery searchQuery = new SearchQuery();
    PrefixQuery prefixQuery = new PrefixQuery(); //设置查询类型为PrefixQuery。
    searchQuery.setGetTotalCount(true);
    prefixQuery.setFieldName("Col_Keyword");
    prefixQuery.setPrefix("hangzhou");
    searchQuery.setQuery(prefixQuery);
    //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("ColName1","ColName2")); //设置为返回指定列。
    //searchRequest.setColumnsToGet(columnsToGet);

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

计费说明

使用多元索引查询数据时会消耗读吞吐量。更多信息，请参见多元索引计量计费。

表格存储：前缀查询

功能概述

接口

参数

使用方式

计费说明

常见问题

相关文档