View Source Meilisearch.Settings (meilisearch_ex v1.0.0)
Link to this section Summary
Link to this section Types
@type t() :: %Meilisearch.Settings{ __meta__: Ecto.Schema.Metadata.t(), displayedAttributes: [String.t()], distinctAttribute: String.t() | nil, faceting: Meilisearch.Settings.Faceting.t(), filterableAttributes: [String.t()], pagination: Meilisearch.Settings.Pagination.t(), rankingRules: [String.t()], searchableAttributes: [String.t()], sortableAttributes: [String.t()], stopWords: [String.t()], synonyms: map(), typoTolerance: Meilisearch.Settings.TypeTolerence.t() }
Link to this section Functions
@spec get(Tesla.Client.t(), String.t()) :: {:ok, t()} | {:error, Meilisearch.Client.error()}
Get 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.get(client, "movies")
{:ok, %{
uid: "movies",
primaryKey: "id",
createdAt: ~U[2021-08-12 10:00:00],
updatedAt: ~U[2021-08-12 10:00:00]
}}
@spec reset(Tesla.Client.t(), String.t()) :: {:ok, Meilisearch.SummarizedTask.t()} | {:error, Meilisearch.Client.error()}
Reset settings of an Index in your Meilsiearch instance. meili doc
examples
Examples
iex> client = Meilisearch.Client.new(endpoint: "http://localhost:7700", key: "master_key_test")
iex> Meilisearch.Settings.reset(client, "movies")
{:ok, %{
taskUid: 0,
indexUid: "movies",
status: :enqueued,
type: :settingsUpdate,
enqueuedAt: ~U[2021-08-12 10:00:00]
}}
@spec update(Tesla.Client.t(), String.t(), t()) :: {:ok, Meilisearch.SummarizedTask.t()} | {:error, Meilisearch.Client.error()}
Update settings of an Index in your Meilsiearch instance. meili doc
examples
Examples
iex> client = Meilisearch.Client.new(endpoint: "http://localhost:7700", key: "master_key_test")
iex> Meilisearch.Settings.update(client, "movies", %{displayedAttributes: ["title"]})
{:ok, %{
taskUid: 0,
indexUid: "movies",
status: :enqueued,
type: :settingsUpdate,
enqueuedAt: ~U[2021-08-12 10:00:00]
}}