All Products
Search
Document Center

Tablestore:Prefix query

Last Updated:Apr 30, 2026

You can perform a prefix query to query data that matches the specified prefix. If the field used to match the prefix condition is a TEXT field, the field values are tokenized. A row meets the query conditions when at least one token contains the specified prefix.

Prerequisites

Parameters

Parameter

Description

TableName

The name of the data table.

IndexName

The name of the search index.

Query

The query type. Set this parameter to PrefixQuery.

FieldName

The name of the field to match against.

Prefix

The prefix to match.

If the target field is a TEXT field, its values are tokenized before matching. A row meets the query conditions when at least one token starts with the specified prefix.

GetTotalCount

Specifies whether to return the total number of rows that match the query conditions. Default value: false.

Setting this to true degrades query performance.

ColumnsToGet

Controls which columns are returned. Configure using the ReturnAll and Columns sub-parameters.

By default, ReturnAll is false and only primary key columns are returned. To return specific non-primary-key columns, set ReturnAll to false and list the columns in Columns.

To return all columns, set ReturnAll to true.

Sample code

The following example queries rows where the Col_Keyword column value starts with hangzhou:

/**
 * Query the rows in which the value of the Col_Keyword column contains the "hangzhou" prefix in a table. 
 */
func PrefixQuery(client *tablestore.TableStoreClient, tableName string, indexName string) {
    searchRequest := &tablestore.SearchRequest{}
    searchRequest.SetTableName(tableName)
    searchRequest.SetIndexName(indexName)
    query := &search.PrefixQuery{} // Set the query type to PrefixQuery. 
    query.FieldName = "Col_Keyword" // Specify the name of the field that you want to match. 
    query.Prefix = "hangzhou" // Specify the prefix that is used to match the value of the column. 
    searchQuery := search.NewSearchQuery()
    searchQuery.SetQuery(query)
    searchQuery.SetGetTotalCount(true)
    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("TotalCount: ", searchResponse.TotalCount) // Display the total number of rows that meet the query conditions instead of the number of returned rows. 
    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 (deduplicate).

  • 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 Perform a parallel scan.