Meili.Export (Meili v0.2.0)

Copy Markdown View Source

Triggers data export creation in Meilisearch.

Summary

Functions

create(client_or_params, params_or_opts \\ [], opts \\ [])

Triggers a data export creation process.

create!(client_or_params, params_or_opts \\ [], opts \\ [])

Triggers a data export creation process, raising on error.

Functions

create(client_or_params, params_or_opts \\ [], opts \\ [])

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

Triggers a data export creation process.

Examples

Meili.Export.create(%{url: "http://remote-meili:7700"})
Meili.Export.create(client, %{url: "http://remote-meili:7700"})

create!(client_or_params, params_or_opts \\ [], opts \\ [])

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

Triggers a data export creation process, raising on error.

Examples

Meili.Export.create!(%{url: "http://remote-meili:7700"})
Meili.Export.create!(client, %{url: "http://remote-meili:7700"})