All Products
Search
Document Center

Tablestore:Perform a prefix query

Last Updated:Aug 19, 2024

You can perform a prefix query to query the data whose prefix matches the specified prefix. If the column used to match the query conditions is of the TEXT type, the value of the column is tokenized. A row meets the query conditions when the tokenized value of the specified column contains at least one term that contains the specified prefix.

Prerequisites

Parameters

Parameter

Description

FieldName

The name of the column that you want to query.

Prefix

The prefix that is used to match the value of the column when you perform a prefix query.

If the column used to match the query conditions is of the TEXT type, the value of the column is tokenized. A row meets the query conditions when the tokenized value of the specified column contains at least one term that contains the specified prefix.

GetTotalCount

Specifies whether to return the total number of rows that meet the query conditions. Default value: 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.

Query

The type of the query. Set this parameter to PrefixQuery.

TableName

The name of the data table.

IndexName

The name of the search index.

ColumnsToGet

Specifies whether to return all columns in the rows that meet the query conditions. You can specify the ReturnAll, Columns, and ReturnAllFromIndex parameters.

The default value of ReturnAll is false, which indicates that not all columns are returned. You can use one of the following methods to specify the columns that you want to return. If you do not use the following methods to specify the columns that you want to return, only the primary key columns are returned.
  • Configure Columns to specify the columns that you want to return.
  • Set ReturnAllFromIndex to true to return all columns from the search index.

If you set ReturnAll to true, all columns are returned.

Example

The following sample code shows how to query the rows in which the value of the Keyword_type_col column contains the "Search" prefix in a table.

/// <summary>
/// Query the rows in which the value of the Keyword_type_col column contains the "Search" prefix in a table. 
/// </summary>
/// <param name="otsClient"></param>
public static void PrefixQuery(OTSClient otsClient)
{
    var searchQuery = new SearchQuery();
    // Set the query type to PrefixQuery, the column that you want to match to Keyword_type_col, and the prefix to "Search". 
    searchQuery.Query = new PrefixQuery("Keyword_type_col", "Search");
    // Return the total number of rows that meet the query conditions. 
    searchQuery.GetTotalCount = true;
    var request = new SearchRequest(TableName, IndexName, searchQuery);
    // You can specify the ColumnsToGet parameter to return the columns that you specify, all columns in the rows that meet the query conditions, or all columns in the search index. If you do not specify this parameter, only the primary key columns are returned. 
    request.ColumnsToGet = new ColumnsToGet()
    {
        // Return all columns in the search index. 
        ReturnAllFromIndex = true
        // Return the columns that you specify. 
        //Columns = new List<string>() { Long_type_col, Text_type_col, Keyword_type_col }
        // Return all columns in the rows that meet the query conditions. 
        //ReturnAll = true         
    };

    var response = otsClient.Search(request);

    Console.WriteLine("Total Count:" + response.TotalCount); // Display the total number of rows that meet the query conditions instead of the number of returned rows. 
}

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, Boolean query, geo query, nested query, and exists query. You can use different query methods 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.