Use Tablestore SDK for .NET to perform a term query - Tablestore

You can use term query to query the rows in which the value of a specific field exactly matches the specified keyword. Term queries is similar to queries based on string matching conditions. If a TEXT field is used to match the keyword and at least one of the tokens in a row exactly matches the keyword, the row meets the query conditions. The keyword is not tokenized.

Prerequisites

An OTSClient instance is initialized. For more information, see Initialize an OTSClient instance.
A data table is created and data is written to the data table. For more information, see Create data tables and Write data.
A search index is created for the data table. For more information, see Create search indexes.

Parameters

Parameter	Description
FieldName	The name of the field that you want to match.
Term	The keyword that is used to match the value of the field when you perform a term query. This word is not tokenized. Instead, the entire word is used to match the field values. If the type of the field is TEXT, Tablestore tokenizes the string and uses the tokens to match the keyword. A row meets the query conditions when at least one of the tokens in the row exactly matches the keyword. For example, if the value of a field of the TEXT type in a row is "tablestore is cool", the value can be tokenized into "tablestore", "is", and "cool". The row meets the query conditions if you specify "tablestore", "is", or "cool" as the keyword to match the value of the field.
GetTotalCount	Specifies whether to return the total number of rows that meet the query conditions. The default value of this parameter is false, which specifies 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 query type. To use term query, set this parameter to TermQuery.
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 ReturnAll, Columns, and ReturnAllFromIndex for this parameter. 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.

Examples

The following sample code provides an example on how to query the rows in which the value of the Keyword_type_col column exactly matches SearchIndex:

/// <summary>
/// Search the table for rows in which the value of the Keyword_type_col column exactly matches SearchIndex. 
/// </summary>
/// <param name="otsClient"></param>
public static void TermQuery(OTSClient otsClient)
{
    var searchQuery = new SearchQuery();
    // Specify that the total number of rows that meet the query conditions is returned. 
    searchQuery.GetTotalCount = true;
    // Set the query type to TermQuery, the field that you want to match to Keyword_type_col, and the keyword to SearchIndex. 
    searchQuery.Query = new TermQuery("Keyword_type_col", new ColumnValue("SearchIndex"));

    var request = new SearchRequest(TableName, IndexName, searchQuery);
    // You can configure the ColumnsToGet parameter to specify the columns that you want to return, specify that all columns are returned, or specify that all columns in the search index are returned. If you do not configure this parameter, only the primary key columns are returned. 
    request.ColumnsToGet = new ColumnsToGet()
    {
        // Specify that all columns in the search index are returned. 
        ReturnAllFromIndex = true
        // Specify the columns that you want to return. 
        //Columns = new List<string>() { Long_type_col, Text_type_col, Keyword_type_col }
        // Specify that all columns are returned. 
        //ReturnAll = true         
    };

    var response = otsClient.Search(request);
    // Check the value of NextToken. 
}

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.