All Products
Search
Document Center

Tablestore:Match all query

Last Updated:Aug 21, 2024

You can use match all query to match all rows in a table to query the total number of rows in the table or return multiple random rows.

Prerequisites

Parameters

Parameter

Description

table_name

The name of the data table.

index_name

The name of the search index.

offset

The position from which the current query starts.

limit

The maximum number of rows that you want the current query to return.

To query only the number of rows that meet the query conditions without returning specific data, you can set Limit to 0. This way, Tablestore returns the number of rows that meet the query conditions without specific data from the table.

get_total_count

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 this parameter is set to true, the query performance is compromised.

collapse

Specifies that the returned results are collapsed based on the specified column.

query_type

The query type. To use match query, set this parameter to QueryTypeConst::MATCH_ALL_QUERY.

sort

The method that you want to use to sort the rows in the response. For more information, see Sorting and paging.

columns_to_get

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

  • If you set return_type to ColumnReturnTypeConst::RETURN_SPECIFIED, you can use return_names to specify the columns to return.

  • If you set the return_type parameter to ColumnReturnTypeConst::RETURN_ALL, all columns are returned.

  • If you set return_type to ColumnReturnTypeConst::RETURN_ALL_FROM_INDEX, all columns in the search index are returned.

  • If you set the return_type parameter to ColumnReturnTypeConst::RETURN_NONE, only the primary key columns are returned.

Examples

The following sample code shows how to use a search index to obtain up to 10 unique keyword records in table php_sdk_test and return data in columns col1 and col2.

$request = array(
    'table_name' => 'php_sdk_test',
    'index_name' => 'php_sdk_test_search_index',
    'search_query' => array(
        'offset' => 0,
        'limit' => 10,
        'get_total_count' => true,
        'collapse' => array(
            'field_name' => 'keyword'
        ),
        'query' => array(
            'query_type' => QueryTypeConst::MATCH_ALL_QUERY
        ),
//        'sort' => array(// Specify a specific sorting method if required. 
//            array(
//                'field_sort' => array(
//                    'field_name' => 'keyword',
//                    'order' => SortOrderConst::SORT_ORDER_ASC
//                )
//            ),
//        ),
        'token' => null,
    ),
    'columns_to_get' => array(
        'return_type' => ColumnReturnTypeConst::RETURN_SPECIFIED,
        'return_names' => array('col1', 'col2')
    )
);
$response = $otsClient->search($request);

FAQ

How do I query the total number of rows in a table?

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.

    If you want to sort or paginate the rows that meet the query conditions, you can use the sorting and paging feature. For more information, see Sorting and paging.

    If you want to collapse the result set based on a specific column, you can use the collapse (distinct) feature. 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, such as obtaining the extreme values, sum, and total number of rows, you can perform aggregation operations or execute SQL statements. For more information, see Aggregation and SQL query.

  • If you want to quickly 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.