Meili.Network (Meili v0.1.2)

Copy Markdown View Source

Manages multi-node network configurations in Meilisearch.

Summary

Functions

Retrieves multi-node network configuration.

Retrieves multi-node network configuration, raising on error.

Updates multi-node network configuration.

Updates network configuration, raising on error.

Functions

get(client \\ nil)

@spec get(Meili.Client.t() | nil) :: {:ok, map()} | {:error, Meili.Error.t()}

Retrieves multi-node network configuration.

Examples

Meili.Network.get()
Meili.Network.get(client)

get!(client \\ nil)

@spec get!(Meili.Client.t() | nil) :: map() | no_return()

Retrieves multi-node network configuration, raising on error.

update(client_or_params, params_or_nil \\ nil)

@spec update(Meili.Client.t() | map() | Keyword.t(), map() | Keyword.t() | nil) ::
  {:ok, map()} | {:error, Meili.Error.t()}

Updates multi-node network configuration.

Examples

params = %{
  leader: %{
    endpoint: "https://leader.meili.com",
    key: "leader-key"
  }
}
Meili.Network.update(params)
Meili.Network.update(client, params)

update!(client_or_params, params_or_nil \\ nil)

@spec update!(Meili.Client.t() | map() | Keyword.t(), map() | Keyword.t() | nil) ::
  map() | no_return()

Updates network configuration, raising on error.