文档

全匹配查询

更新时间:

全匹配查询(MatchAllQuery)可以匹配所有行,常用于查询表中数据总行数,或者随机返回几条数据。

接口

全匹配查询的接口为Search或者ParallelScan,具体的Query类型为MatchAllQuery

参数

参数

说明

query

设置查询类型为MatchAllQuery。

tableName

数据表名称。

indexName

多元索引名称。

limit

本次查询需要返回的最大数量。

如果要随机获取几行数据,请设置limit为正整数。

如果只为了获取行数,无需具体数据,可以设置limit=0,即不返回任意一行数据。

columnsToGet

是否返回所有列,包含returnAll和columns设置。

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

当设置returnAll为true时,表示返回所有列。

getTotalCount

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

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

使用方式

您可以使用命令行工具或者SDK进行全匹配查询。进行全匹配查询之前,您需要完成如下准备工作。

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

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

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

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

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

  • 使用命令行工具方式进行操作前,还需要完成下载并启动命令行工具,然后配置接入实例信息并选择要操作的表。具体操作,请参见下载命令行工具启动并配置数据表操作

使用命令行工具

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

  1. 执行search命令使用search_index多元索引查询表中数据,并返回所有建立索引的列。

    search -n search_index --return_all_indexed
  2. 根据系统提示输入查询条件,示例如下:

    {
        "Offset": -1,
        "Limit": 10,
        "Collapse": null,
        "Sort": null,
        "GetTotalCount": true,
        "Token": null,
        "Query": {
            "Name": "MatchAllQuery",
            "Query": {
            }
        }
    }

使用SDK

您可以通过Java SDKGo SDKPython SDKNode.js SDK.NET SDKPHP SDK使用全匹配查询。此处以Java SDK为例介绍全匹配查询的使用。

以下示例用于通过MatchAllQuery查询表中数据的总行数。

/**
 * 通过MatchAllQuery查询表中数据的总行数。
 * @param client
 */
private static void matchAllQuery(SyncClient client) {
    SearchQuery searchQuery = new SearchQuery();

    /**
    * 设置查询类型为MatchAllQuery。
    */
    searchQuery.setQuery(new MatchAllQuery()); 

    /**
     * MatchAllQuery结果中的TotalCount可以表示表中数据的总行数。
     * 如果要随机获取几行数据,请设置limit为正整数。
     * 如果只为了获取行数,但不需要具体数据,可以设置limit=0,即不返回任意一行数据。
     */
    searchQuery.setLimit(0);
    SearchRequest searchRequest = new SearchRequest("<TABLE_NAME>", "<SEARCH_INDEX_NAME>", searchQuery);

    /**
    * 设置返回匹配的总行数。
    */ 
    searchQuery.setGetTotalCount(true);
    SearchResponse resp = client.search(searchRequest);
    /**
     * 判断返回的结果是否完整,当isAllSuccess为false时,表示可能存在部分节点查询失败,返回的是部分数据。
     */
    if (!resp.isAllSuccess()) {
        System.out.println("NotAllSuccess!");
    }
    System.out.println("IsAllSuccess: " + resp.isAllSuccess());
    System.out.println("TotalCount: " + resp.getTotalCount()); //打印总行数。
    System.out.println(resp.getRequestId());
}
            

计费说明

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

常见问题

如何查看表的总行数

相关文档