Meili.Settings (Meili v0.1.0)

Copy Markdown View Source

Manages settings for Meilisearch indexes.

Summary

Functions

Gets settings for a specific index.

Gets settings for a specific index, raising on error.

Resets all settings for a specific index to their default values.

Resets all settings for a specific index, raising on error.

Updates settings for a specific index, raising on error.

Functions

get(client_or_uid, uid_or_nil \\ nil)

Gets settings for a specific index.

Examples

Meili.Settings.get("movies")
Meili.Settings.get(client, "movies")

get!(client_or_uid, uid_or_nil \\ nil)

Gets settings for a specific index, raising on error.

reset(client_or_uid, uid_or_nil \\ nil)

Resets all settings for a specific index to their default values.

Examples

Meili.Settings.reset("movies")
Meili.Settings.reset(client, "movies")

reset!(client_or_uid, uid_or_nil \\ nil)

Resets all settings for a specific index, raising on error.

update(client_or_uid, uid_or_settings \\ [], settings_or_nil \\ [])

Updates settings for a specific index.

Keys are automatically camelized from snake_case to camelCase.

Examples

settings = %{
  searchable_attributes: ["title", "overview"],
  filterable_attributes: ["genre"],
  ranking_rules: ["words", "typo", "proximity"]
}
Meili.Settings.update("movies", settings)
Meili.Settings.update(client, "movies", settings)

update!(client_or_uid, uid_or_settings \\ [], settings_or_nil \\ [])

Updates settings for a specific index, raising on error.