Manages Meilisearch task batches.
Summary
Functions
Retrieves a single batch by UID.
Retrieves a single batch, raising on error.
Lists all task batches.
Lists all task batches, raising on error.
Functions
@spec get(Meili.Client.t() | integer() | String.t(), integer() | String.t() | nil) :: {:ok, map()} | {:error, Meili.Error.t()}
Retrieves a single batch by UID.
Examples
Meili.Batch.get(1)
Meili.Batch.get(client, 1)
@spec get!(Meili.Client.t() | integer() | String.t(), integer() | String.t() | nil) :: map() | no_return()
Retrieves a single batch, raising on error.
Examples
Meili.Batch.get!(1)
Meili.Batch.get!(client, 1)
@spec list(Meili.Client.t() | Keyword.t() | nil, Keyword.t()) :: {:ok, map()} | {:error, Meili.Error.t()}
Lists all task batches.
Supports optional query params for filtering and pagination.
Examples
Meili.Batch.list()
Meili.Batch.list(limit: 5)
Meili.Batch.list(client, limit: 5)
@spec list!(Meili.Client.t() | Keyword.t() | nil, Keyword.t()) :: map() | no_return()
Lists all task batches, raising on error.
Examples
Meili.Batch.list!()
Meili.Batch.list!(limit: 5)
Meili.Batch.list!(client, limit: 5)