All Products
Search
Document Center

Tablestore:Terms query

Last Updated:Jul 31, 2024

A terms query functions similarly to a term query but allows you to specify multiple keywords in a query to search for data rows that match at least one of the keywords. This matching mechanism is equivalent to the IN operator in SQL.

Prerequisites

Parameters

Parameter

Description

TableName

The name of the data table.

IndexName

The name of the search index.

Query

The type of the query. Set the query type to TermsQuery.

FieldName

The name of the field that you want to query.

Terms

The keywords that are used to match the field values when you perform a terms query.

A row of data is returned if at least one of the keywords matches the field value.

Limit

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

To query only the number of rows that meet the query conditions without returning specific data, you can set Limit to 0.

ColumnsToGet

Specifies whether to return all columns of each row that meets the query conditions. You can specify the ReturnAll and Columns parameters.

By default, the ReturnAll parameter is set to false, which indicates that not all columns are returned. If the ReturnAll parameter is set to false, you can use the Columns parameter to specify the columns that you want to return. If you do not specify the Columns parameter, only the primary key columns are returned.

If you set the ReturnAll parameter to true, all columns in matching rows are returned.

Examples

The following sample code provides an example on how to query the rows in which the value of the Col_Keyword column exactly matches "hangzhou" or "tablestore".

/**
 * Query the rows in which the value of the Col_Keyword column exactly matches "hangzhou" or "tablestore" in the table. 
 */
func TermsQuery(client *tablestore.TableStoreClient, tableName string, indexName string) {
    searchRequest := &tablestore.SearchRequest{}
    searchRequest.SetTableName(tableName)
    searchRequest.SetIndexName(indexName)
    query := &search.TermsQuery{}   // Set the query type to TermsQuery. 
    query.FieldName = "Col_Keyword" // Set the field used to match the query conditions. 
    terms := make([]interface{}, 0)
    terms = append(terms, "hangzhou")
    terms = append(terms, "tablestore")
    query.Terms = terms // Set the keywords used in the query to match the column values. 
    searchQuery := search.NewSearchQuery()
    searchQuery.SetQuery(query)
    searchQuery.SetLimit(100)
    searchRequest.SetSearchQuery(searchQuery)
    // Return all columns in the rows that meet the query conditions. 
    searchRequest.SetColumnsToGet(&tablestore.ColumnsToGet{
        ReturnAll: true,
    })
    searchResponse, err := client.Search(searchRequest)
    if err != nil {
        fmt.Printf("%#v", err)
        return
    }
    fmt.Println("IsAllSuccess: ", searchResponse.IsAllSuccess) // Check whether all rows that meet the query conditions are returned. 
    fmt.Println("RowCount: ", len(searchResponse.Rows))
    for _, row := range searchResponse.Rows {
        jsonBody, err := json.Marshal(row)
        if err != nil {
            panic(err)
        }
        fmt.Println("Row: ", string(jsonBody))
    }
}

FAQ

References

  • When you use a search index to query data, you can use the following query methods: term query, terms query, match all query, match query, match phrase query, prefix query, range query, wildcard query, geo query, Boolean query, KNN vector query, nested query, and exists query. You can use the query methods provided by the search index to query data from multiple dimensions based on your business requirements.

    You can sort or paginate rows that meet the query conditions by using the sorting and paging features. For more information, see Sorting and paging.

    You can use the collapse (distinct) feature to collapse the result set based on a specific column. This way, data of the specified type appears only once in the query results. For more information, see Collapse (distinct).

  • If you want to analyze data in a data table, you can use the aggregation feature of the Search operation or execute SQL statements. For example, you can obtain the minimum and maximum values, sum, and total number of rows. For more information, see Aggregation and SQL query.

  • If you want to obtain all rows that meet the query conditions without the need to sort the rows, you can call the ParallelScan and ComputeSplits operations to use the parallel scan feature. For more information, see Parallel scan.