Elasticsearch API
v0.1.0
  • Pages
  • Modules

    View Source ElasticsearchApi (Elasticsearch API v0.1.0)

    Provides some shortcuts to the most common functions.

    Summary

    Types

    opts()
    query()
    response()

    Functions

    extract_body!(result)

    See ElasticsearchApi.Utils.extract_body!/1.

    extract_hits!(result)

    See ElasticsearchApi.Utils.extract_hits!/1.

    search(query, opts \\ [])

    See ElasticsearchApi.Search.Core.search/2.

    Types

    Link to this type

    opts()

    View Source
    @type opts() :: ElasticsearchApi.Client.opts()
    Link to this type

    query()

    View Source
    @type query() :: map()
    Link to this type

    response()

    View Source
    @type response() :: ElasticsearchApi.Client.response()

    Functions

    Link to this function

    extract_body!(result)

    View Source
    @spec extract_body!({:ok, response()}) :: any()

    See ElasticsearchApi.Utils.extract_body!/1.

    Link to this function

    extract_hits!(result)

    View Source
    @spec extract_hits!({:ok, response()} | {:error, any()}) :: [map()]

    See ElasticsearchApi.Utils.extract_hits!/1.

    Link to this function

    search(query, opts \\ [])

    View Source
    @spec search(query(), opts()) :: {:ok, response()}

    See ElasticsearchApi.Search.Core.search/2.

    Hex Package Hex Preview (current file)

    Built using ExDoc (v0.30.3) for the Elixir programming language