Elastix.Mapping (Elastix v0.10.0) View Source

The mapping API is used to define how documents are stored and indexed.

Elastic documentation

Link to this section Summary

Functions

get(elastic_url, index_names, type_names, query_params \\ [])

Gets info on one or a list of mappings for one or a list of indices.

get_all(elastic_url, query_params \\ [])

Gets info on every mapping.

get_all_with_type(elastic_url, type_names, query_params \\ [])

Gets info on every given mapping.

put(elastic_url, index_names, type_name, data, query_params \\ [])

Creates a new mapping.

Link to this section Functions

get(elastic_url, index_names, type_names, query_params \\ [])

Specs

get(
  elastic_url :: String.t(),
  index_names :: String.t() | list(),
  type_names :: String.t() | list(),
  query_params :: Keyword.t()
) :: Elastix.HTTP.resp()

Gets info on one or a list of mappings for one or a list of indices.

Examples

iex> Elastix.Mapping.get("http://localhost:9200", "twitter", "tweet")
{:ok, %HTTPoison.Response{...}}

get_all(elastic_url, query_params \\ [])

Specs

get_all(elastic_url :: String.t(), query_params :: Keyword.t()) ::
  Elastix.HTTP.resp()

Gets info on every mapping.

Examples

iex> Elastix.Mapping.get_all("http://localhost:9200")
{:ok, %HTTPoison.Response{...}}

get_all_with_type(elastic_url, type_names, query_params \\ [])

Specs

get_all_with_type(
  elastic_url :: String.t(),
  type_names :: String.t() | list(),
  query_params :: Keyword.t()
) :: Elastix.HTTP.resp()

Gets info on every given mapping.

Examples

iex> Elastix.Mapping.get_all("http://localhost:9200", ["tweet", "user"])
{:ok, %HTTPoison.Response{...}}

put(elastic_url, index_names, type_name, data, query_params \\ [])

Specs

put(
  elastic_url :: String.t(),
  index_names :: String.t() | list(),
  type_name :: String.t(),
  data :: map(),
  query_params :: Keyword.t()
) :: Elastix.HTTP.resp()

Creates a new mapping.

Examples

iex> mapping = %{properties: %{user: %{type: "text"}, post_date: %{type: "date"}, message: %{type: "text"}}}
iex> Elastix.Mapping.put("http://localhost:9200", "twitter", "tweet", mapping)
{:ok, %HTTPoison.Response{...}}