Elastix.Index (Elastix v0.10.0) View Source
The indices APIs are used to manage individual indices, index settings, aliases, mappings, and index templates.
Link to this section Summary
Link to this section Functions
Specs
close(elastic_url :: String.t(), name :: String.t()) :: Elastix.HTTP.resp()
Closes the specified index.
Examples
iex> Elastix.Index.close("http://localhost:9200", "twitter")
{:ok, %HTTPoison.Response{...}}Specs
create(elastic_url :: String.t(), name :: String.t(), data :: map()) :: Elastix.HTTP.resp()
Creates a new index.
Examples
iex> Elastix.Index.create("http://localhost:9200", "twitter", %{})
{:ok, %HTTPoison.Response{...}}Specs
delete(elastic_url :: String.t(), name :: String.t()) :: Elastix.HTTP.resp()
Deletes an existing index.
Examples
iex> Elastix.Index.delete("http://localhost:9200", "twitter")
{:ok, %HTTPoison.Response{...}}Specs
exists?(elastic_url :: String.t(), name :: String.t()) :: {:ok, boolean()} | {:error, HTTPoison.Error.t()}
Returns true if the specified index exists, false otherwise.
Examples
iex> Elastix.Index.exists?("http://localhost:9200", "twitter")
{:ok, false}
iex> Elastix.Index.create("http://localhost:9200", "twitter", %{})
{:ok, %HTTPoison.Response{...}}
iex> Elastix.Index.exists?("http://localhost:9200", "twitter")
{:ok, true}Specs
get(elastic_url :: String.t(), name :: String.t()) :: Elastix.HTTP.resp()
Fetches info about an existing index.
Examples
iex> Elastix.Index.get("http://localhost:9200", "twitter")
{:ok, %HTTPoison.Response{...}}Specs
open(elastic_url :: String.t(), name :: String.t()) :: Elastix.HTTP.resp()
Opens the specified index.
Examples
iex> Elastix.Index.open("http://localhost:9200", "twitter")
{:ok, %HTTPoison.Response{...}}Specs
refresh(elastic_url :: String.t(), name :: String.t()) :: Elastix.HTTP.resp()
Forces the refresh of the specified index.
Examples
iex> Elastix.Index.refresh("http://localhost:9200", "twitter")
{:ok, %HTTPoison.Response{...}}