表格存储 Java SDK 通配符查询 - 表格存储

前提条件

安装Tablestore Java SDK并初始化客户端。

功能说明

通配符查询通过包含通配符的模式匹配索引字段，匹配语义与 SQL LIKE 类似，但使用 * 和 ? 作为通配符。对于 Keyword 和 FuzzyKeyword 类型字段，查询模式与完整字段值进行匹配；对于 Text 类型字段，查询模式与字段分词后的单个词条进行匹配，查询模式本身不会被分词。通配符查询支持的字段类型请参见字符串类型。匹配区分大小写。

查询模式可以通配符开头，并支持以下通配符：

*：匹配 0 个或多个字符。
?：匹配任意单个字符。

例如，table*e 可以匹配 tablestore；hang*u 可以匹配 hangu 和 hangzhou；hang?u 可以匹配 hangxu，但不能匹配 hangu。

如果需要查询包含指定字符串的数据，例如使用 *word* 形式的查询模式（等同于 SQL WHERE field_a LIKE '%word%'），可使用基于分词的通配符查询。该方式可避免查询性能随数据量增加而下降。

说明

如需排除与模式匹配的数据，将 WildcardQuery 添加到 BoolQuery.mustNotQueries，可实现与 SQL NOT LIKE 相同的排除效果。有关 BoolQuery 的配置方法，请参见多条件组合查询。

调用 search 方法时，将查询类型设置为 WildcardQuery，并通过 SearchQuery 配置返回数量、总行数统计和其他通用查询行为。

SearchResponse search(SearchRequest request)

以下示例查询 Keyword 类型的 product_name 字段值与 table*e 模式匹配的数据，返回最多 10 行数据及匹配总行数。

String tableName = "example_table";
String indexName = "example_index";

WildcardQuery wildcardQuery = new WildcardQuery();
wildcardQuery.setFieldName("product_name");
wildcardQuery.setValue("table*e");

SearchQuery searchQuery = new SearchQuery();
searchQuery.setQuery(wildcardQuery);
searchQuery.setLimit(10);
searchQuery.setTrackTotalCount(SearchQuery.TRACK_TOTAL_COUNT);

SearchRequest request = new SearchRequest(tableName, indexName, searchQuery);
SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
columnsToGet.setReturnAll(true);
request.setColumnsToGet(columnsToGet);

SearchResponse response = client.search(request);
System.out.println(response.getTotalCount());
System.out.println(response.getRows());

参数说明

查询请求

request 的类型为 SearchRequest，包含以下参数。

名称	类型	说明
tableName（必选）	String	数据表名称。
indexName（必选）	String	多元索引名称。
searchQuery（必选）	SearchQuery	查询条件和通用查询配置。
columnsToGet（可选）	SearchRequest.ColumnsToGet	返回列配置。未设置时只返回主键列。
timeoutInMillisecond（可选）	int	请求级查询超时时间，单位为毫秒。默认值为 `-1`，表示不单独设置查询超时时间。
routingValues（可选）	`List<PrimaryKey>`	自定义路由字段对应的主键值列表。未配置自定义路由时无需设置。

查询配置

request.searchQuery 的类型为 SearchQuery，包含以下参数。

名称	类型	说明
query（必选）	Query	查询条件。通配符查询设置为 `WildcardQuery`。
offset（可选）	Integer	本次查询的起始位置。
limit（可选）	Integer	本次查询返回的最大行数。设置为 `0` 时不返回具体行。
highlight（可选）	Highlight	`Text` 字段的摘要与高亮配置。有关配置方法，请参见摘要与高亮。
collapse（可选）	Collapse	结果折叠配置，用于按指定列对返回结果去重。有关配置方法，请参见折叠（去重）。
sort（可选）	Sort	返回结果的排序方式。有关配置方法，请参见排序和翻页。
trackTotalCount（可选）	int	期望统计的最大匹配行数。默认值为 `TRACK_TOTAL_COUNT_DISABLED`，表示不统计；设置为 `TRACK_TOTAL_COUNT` 时统计全部匹配行。值越小，查询性能越高。
filter（可选）	SearchFilter	对 `query` 的查询结果进行过滤。
aggregationList（可选）	`List<Aggregation>`	统计聚合配置。有关配置方法，请参见统计聚合。
groupByList（可选）	`List<GroupBy>`	分组配置。有关配置方法，请参见统计聚合。
token（可选）	byte[]	翻页凭证。将上一次响应的 `nextToken` 设置为该参数可继续读取后续数据。设置 `token` 时，SDK 会清除 `sort`，因为翻页凭证中已包含排序条件。

查询条件

request.searchQuery.query 的类型为 WildcardQuery，包含以下参数。

名称	类型	说明
fieldName（必选）	String	要查询的 `Keyword`、`Text` 或 `FuzzyKeyword` 类型索引字段名称。
value（必选）	String	包含通配符的查询模式，最长为 32 个字符，匹配区分大小写。对于 `Keyword` 和 `FuzzyKeyword` 字段，查询模式与完整字段值匹配；对于 `Text` 字段，查询模式与分词后的单个词条匹配，查询模式本身不会被分词。
weight（可选）	float	查询条件的相关性权重，必须为正浮点数。值越大，该查询条件对 BM25 相关性评分的贡献越高。该参数不影响匹配结果和返回行数，仅在使用 `ScoreSort` 按相关性评分排序时影响结果顺序。默认值为 `1.0`。

返回列

request.columnsToGet 的类型为 SearchRequest.ColumnsToGet，包含以下参数。

名称	类型	说明
columns（可选）	`List<String>`	要返回的属性列名称。仅 `returnAll` 和 `returnAllFromIndex` 均为 `false` 时需要设置；未设置时只返回主键列。
returnAll（可选）	boolean	是否返回数据表中的全部属性列。默认值为 `false`。
returnAllFromIndex（可选）	boolean	是否返回已建立索引的全部属性列。默认值为 `false`。不能与 `returnAll` 同时设置为 `true`。

返回值

search 方法返回 SearchResponse。核心字段如下。

名称	类型	说明
totalCount	long	匹配行数，通过 `getTotalCount()` 获取。返回值取决于 `trackTotalCount` 配置。
rows	`List<Row>`	本次查询返回的行数据，通过 `getRows()` 获取。返回数量不超过 `limit`。
searchHits	`List<SearchHit>`	查询命中结果，通过 `getSearchHits()` 获取。配置 `highlight` 后，从该字段读取行数据和摘要与高亮结果。
nextToken	byte[]	下一页凭证，通过 `getNextToken()` 获取。值不为 `null` 时，将其设置到下一次请求的 `token` 中继续读取。
isAllSuccess	boolean	是否已成功查询全部索引分区，通过 `isAllSuccess()` 获取。值为 `false` 时，返回的是部分结果，`totalCount` 可能小于实际匹配行数。