Specs

bool_query(options :: Keyword.t()) :: map()

Use BoolQuery as the nested :query option of :search_query option in ExAliyunOts.search/4.

Official document in Chinese | English

Example

import MyApp.TableStore

search "table", "index_name",
  search_query: [
    query: bool_query(
      must: range_query("age", from: 20, to: 32),
      must_not: term_query("age", 28)
    )
  ]

The following options can be a single Query or a list of Query to combine the "And | Or | At least" search condition.

Options

• :must, specifies the Queries that the query result must match, this option is equivalent to the AND operator.
• :must_not, specifies the Queries that the query result must not match, this option is equivalent to the NOT operator.
• :should, specifies the Queries that the query result may or may not match, this option is equivalent to the OR operator.
• :minimum_should_match, specifies the minimum number of :should that the query result must match.

Specs

exists_query(field_name :: String.t()) :: map()

Use ExistsQuery as the nested :query option of :search_query option in ExAliyunOts.search/4.

Official document in Chinese | English

Example

import MyApp.TableStore

search "table", "index_name",
  search_query: [
    query: exists_query("values")
  ]

Specs

geo_bounding_box_query(
  field_name :: String.t(),
  top_left :: String.t(),
  bottom_right :: String.t()
) :: map()

Use GeoBoundingBoxQuery as the nested :query option of :search_query option in ExAliyunOts.search/4.

Official document in Chinese | English

Example

import MyApp.TableStore
search "table", "index_name",
  search_query: [
    query: geo_bounding_box_query("location", "10,-10", "-10,10")
  ]

Please notice that all geographic coordinates are in "$latitude,$longitude" format.

Specs

geo_distance_query(
  field_name :: String.t(),
  distance :: float() | integer(),
  center_point :: String.t()
) :: map()

Use GeoDistanceQuery as the nested :query option of :search_query option in ExAliyunOts.search/4.

Official document in Chinese | English

Example

import MyApp.TableStore
search "table", "index_name",
  search_query: [
    query: geo_distance_query("location", 500_000, "5,5")
  ]

Please notice that all geographic coordinates are in "$latitude,$longitude" format.

Specs

geo_polygon_query(field_name :: String.t(), geo_points :: list()) :: map()

Use GeoPolygonQuery as the nested :query option of :search_query option in ExAliyunOts.search/4.

Official document in Chinese | English

Example

import MyApp.TableStore

search "table", "index_name",
  search_query: [
    query: geo_polygon_query("location", ["11,11", "0,0", "1,5"])
  ]

Please notice that all geographic coordinates are in "$latitude,$longitude" format.

Specs

match_all_query() :: map()

Use MatchAllQuery as the nested :query option of :search_query option in ExAliyunOts.search/4.

Example

import MyApp.TableStore

search "table", "index_name",
  search_query: [
    query: match_all_query()
  ]

Official document in Chinese | English

Specs

match_phrase_query(field_name :: String.t(), text :: String.t()) :: map()

Use MatchPhraseQuery as the nested :query option of :search_query option in ExAliyunOts.search/4.

Similar to MatchQuery, however, the location relationship of multiple terms after word segmentation will be considered, multiple terms after word segmentation must exist in the same order and location in the row data to be hit this query.

Official document in Chinese | English

Example

import MyApp.TableStore

search "table", "index_name",
  search_query: [
    query: match_phrase_query("content", "tablestore")
  ]

Specs

match_query(
  field_name :: String.t(),
  text :: String.t(),
  options :: Keyword.t()
) :: map()

Use MatchQuery as the nested :query option of :search_query option in ExAliyunOts.search/4.

Example

import MyApp.TableStore
search "table", "index_name",
  search_query: [
    query: match_query("age", 28)
  ]

Official document in Chinese | English

Options

• :minimum_should_match, the minimum number of terms that the value of the fieldName field in a row contains when Table Store returns this row in the query result, by default it's 1.
• :operator, the operator used in a logical operation, by default it's Or, it means that as long as several terms after the participle are partially hit, they are considered hit this query.

Specs

nested_query(
  path :: String.t(),
  query :: map() | Keyword.t(),
  options :: Keyword.t()
) :: map()

Use NestedQuery as the nested :query option of :search_query option in ExAliyunOts.search/4, the target field need to be a nested type, it is used to query sub documents of nested type.

Official document in Chinese | English

Example

import MyApp.TableStore

search "table", "index_name",
  search_query: [
    query: nested_query(
      "content",
      term_query("content.header", "header1")
    )
  ]

Options

• :score_mode, available options have :none | :avg | :max | :total | :min, by default it's :none.

Specs

prefix_query(field_name :: String.t(), prefix :: String.t()) :: map()

Use PrefixQuery as the nested :query option of :search_query option in ExAliyunOts.search/4.

Official document in Chinese | English

Example

import MyApp.TableStore

search "table", "index_name",
  search_query: [
    query: prefix_query("name", "n")
  ]

Specs

range_query(field_name :: String.t(), options :: Keyword.t()) :: map()

Use RangeQuery as the nested :query option of :search_query option in ExAliyunOts.search/4.

Official document in Chinese | English

Example

import MyApp.TableStore

search "table", "index_name",
  search_query: [
    query: range_query(
      "score",
      from: 60,
      to: 80,
      include_upper: false,
      include_lower: false
    )
  ]

Options

• :from, the value of the start position.
• :to, the value of the end position.
• :include_lower, specifies whether to include the :from value in the result, available options are true | false, by default it's true.
• :include_upper, specifies whether to include the :to value in the result, available options are true | false, by default it's true.

Specs

term_query(field_name :: String.t(), term :: String.t()) :: map()

Use TermQuery as the nested :query option of :search_query option in ExAliyunOts.search/4.

Official document in Chinese | English

Example

import MyApp.TableStore

search "table", "index_name",
  search_query: [
    query: term_query("age", 28)
  ]

Specs

terms_query(field_name :: String.t(), terms :: list()) :: map()

Use TermsQuery as the nested :query option of :search_query option in ExAliyunOts.search/4.

Official document in Chinese | English

Example

import MyApp.TableStore
search "table", "index_name",
  search_query: [
    query: terms_query("age", [28, 29, 30])
  ]

Specs

wildcard_query(field_name :: String.t(), value :: String.t()) :: map()

Use WildcardQuery as the nested :query option of :search_query option in ExAliyunOts.search/4.

Official document in Chinese | English

Example

import MyApp.TableStore

search "table", "index_name",
  search_query: [
    query: wildcard_query("name", "n*")
  ]