All Products
Search
Document Center

Tablestore:Perform a Boolean query

Last Updated:Aug 19, 2024

A Boolean query consists of one or more subqueries. Tablestore returns the rows that meet the specified subquery conditions. A subquery can be of any type, including Boolean query.

Prerequisites

Parameters

Parameter

Description

MustQueries

The list of subquery conditions. Only rows that meet all subquery conditions are returned. This parameter is equivalent to the AND operator.

MustNotQueries

The list of subquery conditions. Only rows that do not meet any subquery conditions are returned. This parameter is equivalent to the NOT operator.

FilterQueries

The list of subquery conditions. Only rows that meet all subfilters are returned. A filter is similar to a query except that no relevance score is calculated in a filter based on the number of subfilters that a row meets.

ShouldQueries

The list of subquery conditions. Not all the subquery conditions need to be met for the query results to return. This parameter is equivalent to the OR operator.

Only rows that meet the minimum number of subquery conditions specified by the ShouldQueries parameter are returned.

A higher overall relevance score indicates that more subquery conditions specified by the ShouldQueries parameter are met.

MinimumShouldMatch

The minimum number of subquery conditions specified by the ShouldQueries parameter that the returned rows must meet. If no other subquery conditions except the subquery conditions specified by the ShouldQueries parameter are specified, the default value of the MinimumShouldMatch parameter is 1. If other subquery conditions, such as subquery conditions specified by the MustQueries, MustNotQueries, or FilterQueries parameter, are specified, the default value of the MinimumShouldMatch parameter is 0.

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 perform a Boolean query that consists of Boolean subqueries. In this example, the rows in which the value of the Keyword_type_col column is "SearchIndex" or "TableStore" are queried. All columns in the search index are returned.

/// <summary>
/// A Boolean query contains one or more subqueries. Each subquery has its own type. 
/// MustQueries: The rows must meet all subquery conditions. 
/// ShouldQueries: More than one condition is specified by the ShouldQueries parameter. If a row meets at least one condition, the row meets the query conditions. 
/// MustNotQueries: The rows must not meet the conditions. 
/// MinimumShouldMatch: The rows must meet the minimum number of conditions. 
/// </summary>
/// <param name="otsClient"></param>
public static void BoolQuery(OTSClient otsClient)
{
    Console.WriteLine("\n Start bool query...");

    var searchQuery = new SearchQuery();
    // Return the total number of rows that meet the query conditions. 
    searchQuery.GetTotalCount = true;
    var boolQuery = new BoolQuery();
    var shouldQuerys = new List<IQuery>();
    shouldQuerys.Add(new TermQuery(Keyword_type_col, new ColumnValue("SearchIndex")));
    shouldQuerys.Add(new TermQuery(Keyword_type_col, new ColumnValue("TableStore")));
    boolQuery.ShouldQueries = shouldQuerys;
    boolQuery.MinimumShouldMatch = 1;

    searchQuery.Query = boolQuery;

    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. 
    foreach (var row in response.Rows)
    {
        PrintRow(row);
    }
}

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.