ExAliyunOts.search
You're seeing just the function
search
, go back to ExAliyunOts module for more information.
Specs
search(instance(), table_name(), index_name(), options()) :: result()
The one entrance to use search index functions, please see ExAliyunOts.Search
module for details.
Official document in Chinese | English
Options
:search_query
, required, the main option to use query and sort.:query
, required, bind to the query functions:ExAliyunOts.Search.bool_query/1
ExAliyunOts.Search.exists_query/1
ExAliyunOts.Search.geo_bounding_box_query/3
ExAliyunOts.Search.geo_distance_query/3
ExAliyunOts.Search.geo_polygon_query/2
ExAliyunOts.Search.match_all_query/0
ExAliyunOts.Search.match_phrase_query/2
ExAliyunOts.Search.match_query/3
ExAliyunOts.Search.nested_query/3
ExAliyunOts.Search.prefix_query/2
ExAliyunOts.Search.range_query/2
ExAliyunOts.Search.term_query/2
ExAliyunOts.Search.terms_query/2
ExAliyunOts.Search.wildcard_query/2
:sort
, optional, by default it is usepk_sort/1
, bind to the Sort functions::aggs
, optional, please see official document in Chinese | English.:group_bys
, optional, please see official document in Chinese | English.:limit
, optional, the limited size of query.:offset
, optional, the offset size of query. When the total rows are less or equal than 2000, can both used:limit
and:offset
to pagination.:get_total_count
, optional, return the total count of the all matched rows, by default it istrue
.:token
, optional, when do not load all the matched rows in a single request, there will return anext_token
value in that result, and then we can pass it to:token
in the next same search query to continue load the rest rows.:collapse
, optional, duplicate removal by the specified field, please see official document in Chinese, please NOTICE that currently there does not support use:collapse
with:token
together.
:columns_to_get
, optional, fetch the special fields, by default it returns all fields, here are available options::all
, return all attribute column fields;:none
, do not return any attribute column fields;["field1", "field2"]
, specifies the expected return attribute column fields.