View Source Meilisearch.Settings.Pagination (meilisearch_ex v1.0.0)

Link to this section Summary

Functions

Get pagination settings of an Index of your Meilsiearch instance. meili doc

Reset pagination settings of an Index of your Meilsiearch instance. meili doc

Update pagination settings of an Index of your Meilsiearch instance. meili doc

Link to this section Types

@type t() :: %Meilisearch.Settings.Pagination{
  __meta__: Ecto.Schema.Metadata.t(),
  maxTotalHits: integer()
}

Link to this section Functions

Link to this function

changeset(mod \\ %__MODULE__{}, data)

View Source
@spec get(Tesla.Client.t(), String.t()) ::
  {:ok, t()} | {:error, Meilisearch.Client.error()}

Get pagination settings of an Index of your Meilsiearch instance. meili doc

examples

Examples

iex> client = Meilisearch.Client.new(endpoint: "http://localhost:7700", key: "master_key_test")
iex> Meilisearch.Settings.Pagination.get(client, "movies")
{:ok, %Meilisearch.Settings.Pagination{maxTotalHits: 1000}}
Link to this function

reset(client, index_uid)

View Source

Reset pagination settings of an Index of your Meilsiearch instance. meili doc

examples

Examples

iex> client = Meilisearch.Client.new(endpoint: "http://localhost:7700", key: "master_key_test")
iex> Meilisearch.Settings.Pagination.reset(client, "movies")
{:ok, %{
  taskUid: 0,
  indexUid: "movies",
  status: :enqueued,
  type: :settingsUpdate,
  enqueuedAt: ~U[2021-08-12 10:00:00]
}}
Link to this function

update(client, index_uid, params)

View Source
@spec update(Tesla.Client.t(), String.t(), %{maxTotalHits: integer()}) ::
  {:ok, Meilisearch.SummarizedTask.t()} | {:error, Meilisearch.Client.error()}

Update pagination settings of an Index of your Meilsiearch instance. meili doc

examples

Examples

iex> client = Meilisearch.Client.new(endpoint: "http://localhost:7700", key: "master_key_test")
iex> Meilisearch.Settings.Pagination.update(client, "movies", %{maxTotalHits: 100})
{:ok, %{
  taskUid: 0,
  indexUid: "movies",
  status: :enqueued,
  type: :settingsUpdate,
  enqueuedAt: ~U[2021-08-12 10:00:00]
}}