You can use asterisks (*) and question marks (?) to search for data that matches wildcards. An asterisk (*) represents any number of characters. A question mark (?) represents any single character. The matched value can start with asterisks (*) or question marks (?). For example, if you search for string "table*e", you can retrieve query results such as "tablestore".

Prerequisites

  • The OTSClient instance is initialized. For more information, see Initialization.
  • A data table is created and data is written to the table.
  • A search index is created for the table. For more information, see Create search indexes.

Parameters

Parameter Description
query The query type. Set this parameter to WildcardQuery.
field_name The name of the column.
value The string that contains wildcards. The string can be up to 10 bytes in length.
table_name The name of the table.
index_name The name of the search index.
limit The maximum number of rows that the current query returns.
get_total_count Specifies whether to return the total number of matched rows. Default value: False.

Query performance is affected when this parameter is set to true.
ColumnsToGet Specifies whether to return all columns of each matched row.
  • If you set return_type to ColumnReturnType.SPECIFIED, you must specify the columns to return.
  • If you set return_type to ColumnReturnType.ALL, all columns are returned.
  • If you set return_type to ColumnReturnType.NONE, only the primary key columns are returned.

Examples

query = WildcardQuery('k', 'key00*')
rows, next_token, total_count, is_all_succeed = client.search(
    table_name, index_name, 
    SearchQuery(query, limit=100, get_total_count=True), 
    ColumnsToGet(return_type=ColumnReturnType.ALL)
)