All Products
Search
Document Center

Tablestore:Prefix query

Last Updated:Oct 25, 2024

You can perform a prefix query to query data in an index. When you perform a prefix query, you must specify a prefix.

Description

A prefix query is used to query data that starts with a specific string. When you perform a prefix query, you must specify a prefix.

You can use prefix queries to query data of the Keyword, FuzzyKeyword, and Text data types.

  • Keyword: the basic String data type. This data type delivers poor performance for fuzzy queries, such as prefix queries on medium or large volumes of data. The performance declines as the data size increases.

  • FuzzyKeyword: a data type that is optimized for fuzzy queries, such as prefix queries. This data type delivers high and stable performance for fuzzy queries, such as prefix queries on data of any size. In most cases, the query performance does not decline as the data size increases.

  • Text: If the column that is used to match the prefix condition is a Text column, the column is tokenized. A row meets the query conditions when at least one token contains the specified prefix. Due to the uncertainty of tokenization, prefix queries are not used for queries on data of the Text type in most cases. This data type is supported only for compatibility. Use this data type with caution.

API operation

You can call the Search or ParallelScan operation and set the query type to PrefixQuery to perform a prefix query.

Parameters

Parameter

Description

query

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

fieldName

The name of the column that you want to query.

prefix

The prefix.

If the column that is used to match the prefix condition is a Text column, the column is tokenized. A row meets the query conditions when at least one token contains the specified prefix.

getTotalCount

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

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

weight

The weight that you want to assign to the column that you want to query to calculate the BM25-based keyword relevance score. This parameter is used in full-text search scenarios. A higher weight results in a higher BM25-based keyword relevance score for the column. The value of this parameter is a positive floating point number.

This parameter does not affect the number of rows that are returned. However, this parameter affects the BM25-based keyword relevance scores of the query results.

tableName

The name of the data table.

indexName

The name of the search index.

columnsToGet

Specifies whether to return all columns of each row that meets the query conditions. You can configure the returnAll and columns parameters for this parameter.

The default value of the returnAll parameter is false, which specifies that not all columns are returned. In this case, you can use the columns parameter to specify the columns that you want to return. If you do not specify the columns that you want to return, only the primary key columns are returned.

If you set the returnAll parameter to true, all columns are returned.

Methods

You can use the Tablestore console, Tablestore CLI, or Tablestore SDKs to perform a prefix query. Before you perform a prefix query, make sure that the following preparations are made:

Important

You can use only Tablestore SDKs to perform prefix queries on data of the FuzzyKeyword type.

Use the Tablestore console

  1. Go to the Indexes tab.

    1. Log on to the Tablestore console.

    2. In the top navigation bar, select a resource group and a region.

    3. On the Overview page, click the name of the instance that you want to manage or click Manage Instance in the Actions column of the instance.

    4. On the Tables tab of the Instance Details tab, click the name of the data table or click Indexes in the Actions column of the data table.

  2. On the Indexes tab, find the search index that you want to use to query data and click Manage Data in the Actions column.

  3. In the Search dialog box, specify query conditions.

    1. By default, the system returns all attribute columns. To return specific attribute columns, turn off All Columns and specify the attribute columns that you want to return. Separate multiple attribute columns with commas (,).

      Note

      By default, the system returns all primary key columns of the data table.

    2. Select the And, Or, or Not logical operator based on your business requirements.

      If you select the And logical operator, data that meets the query conditions is returned. If you select the Or operator and specify a single query condition, data that meets the query condition is returned. If you select the Or logical operator and specify multiple query conditions, data that meets one of the query conditions is returned. If you select the Not logical operator, data that does not meet the query conditions is returned.

    3. Select a field and click Add.

    4. Set the Query Type parameter to PrefixQuery(PrefixQuery) and enter the value that you want to query.

    5. By default, the sorting feature is disabled. If you want to sort the query results based on specific fields, turn on Sort and specify the fields based on which you want to sort the query results and the sorting order.

    6. By default, the aggregation feature is disabled. If you want to collect statistics on a specific field, turn on Collect Statistics, specify the field based on which you want to collect statistics, and then configure the information that is required to collect statistics.

  4. Click OK.

    Data that meets the query conditions is displayed in the specified order on the Indexes tab.

Use the Tablestore CLI

You can use the Tablestore CLI to run the search command to query data by using search indexes. For more information, see Search index.

Important

You can use the Tablestore CLI to perform prefix queries only on data of the Keyword type but not the FuzzyKeyword type.

  1. Run the search command to use the search_index search index to query data and return all indexed columns of each row that meets the query conditions.

    search -n search_index --return_all_indexed
  2. Enter the query conditions as prompted by the system:

    {
        "Offset": -1,
        "Limit": 10,
        "Collapse": null,
        "Sort": null,
        "GetTotalCount": true,
        "Token": null,
        "Query": {
            "Name": "PrefixQuery",
            "Query": {
                "FieldName": "col_keyword",
                "Prefix": "hangzhou"
            }
        }
    }

Use Tablestore SDKs

You can perform a prefix query by using the following Tablestore SDKs: Tablestore SDK for Java, Tablestore SDK for Go, Tablestore SDK for Python, Tablestore SDK for Node.js, Tablestore SDK for .NET, and Tablestore SDK for PHP. In this example, Tablestore SDK for Java is used.

Note

The query statement in a wildcard query on data of the Keyword type is the same as the query statement in a wildcard query on data of the FuzzyKeyword type. However, the type of the field that you want to query is different.

The following sample code provides an example on how to query the rows in which the value of the Col_Keyword column contains the prefix "hangzhou" in a table:

/**
 * Search the table for rows in which the value of Col_Keyword contains the prefix "hangzhou". 
 * @param client
 */
private static void prefixQuery(SyncClient client) {
    SearchQuery searchQuery = new SearchQuery();
    PrefixQuery prefixQuery = new PrefixQuery(); // Set the query type to PrefixQuery. 
    searchQuery.setGetTotalCount(true);
    prefixQuery.setFieldName("Col_Keyword");
    prefixQuery.setPrefix("hangzhou");
    searchQuery.setQuery(prefixQuery);
    //searchQuery.setGetTotalCount(true); // Specify that the total number of matched rows is returned. 

    SearchRequest searchRequest = new SearchRequest("<TABLE_NAME>", "<SEARCH_INDEX_NAME>", searchQuery);
    // You can configure the columnsToGet parameter to specify the columns to return or specify that all columns are returned. If you do not configure this parameter, only the primary key columns are returned. 
    //SearchRequest.ColumnsToGet columnsToGet = new SearchRequest.ColumnsToGet();
    //columnsToGet.setReturnAll(true); // Specify that all columns are returned. 
    //columnsToGet.setColumns(Arrays.asList("ColName1","ColName2")); // Specify the columns that you want to return. 
    //searchRequest.setColumnsToGet(columnsToGet);

    SearchResponse resp = client.search(searchRequest);
    //System.out.println("TotalCount: " + resp.getTotalCount()); // Specify that the total number of matched rows instead of the number of returned rows is displayed. 
    System.out.println("Row: " + resp.getRows());
}

Billing rules

When you use a search index to query data, you are charged for the read throughput that is consumed. For more information, see Billable items of search indexes.

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, fuzzy query, Boolean query, geo query, nested query, KNN vector query, and exists query. You can select query methods based on your business requirements to query data from multiple dimensions.

    You can sort or paginate rows that meet the query conditions by using the sorting and paging features. For more information, see Perform 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.