All Products
Search
Document Center

Tablestore:SearchQuery

Last Updated:May 13, 2024

SearchQuery specifies the query configurations when you call the Search operation.

Data structure

message SearchQuery {
    optional int32 offset = 1;
    optional int32 limit = 2;
    optional Query query = 4;
    optional Collapse collapse = 5;
    optional Sort sort = 6;
    optional bool getTotalCount = 8;
    optional bytes token = 9;
    optional Aggregations aggs = 10;
    optional GroupBys group_bys = 11;
}

Parameter

Type

Required

Description

offset

int32

No

The position from which the current query starts.

limit

int32

No

The maximum number of rows that you want the current query to return.

query

Query

Yes

The query conditions.

collapse

Collapse

No

Specifies that the returned results are collapsed based on the specified column.

sort

Sort

No

The sorting method of the results.

getTotalCount

bool

No

Specifies whether to return the total number of rows that meet the query conditions. The default value of this parameter is false, which indicates that the total number of rows that meet the query conditions is not returned.

If you set this parameter to true, the query performance is compromised.

token

bytes

No

If Tablestore cannot read full data that meets the query conditions, Tablestore returns next_token. You can use next_token to continue reading the subsequent data.

aggs

Aggregations

No

The aggregation configurations.

group_bys

GroupBys

No

The grouping configurations.

Related operations

Search