Meili.DynamicSearchRules (Meili v0.1.0)

Manages Meilisearch experimental dynamic search rules.

Summary

Functions

delete(client_or_uid, uid_or_nil \\ nil)

Deletes a dynamic search rule by UID.

delete!(client_or_uid, uid_or_nil \\ nil)

Deletes a dynamic search rule, raising on error.

get(client_or_uid, uid_or_nil \\ nil)

Retrieves a single dynamic search rule by UID.

get!(client_or_uid, uid_or_nil \\ nil)

Retrieves a single dynamic search rule, raising on error.

list(client_or_opts \\ nil, opts \\ [])

Lists all dynamic search rules.

list!(client_or_opts \\ nil, opts \\ [])

Lists all dynamic search rules, raising on error.

update(client_or_uid, uid_or_params \\ nil, params_or_nil \\ nil)

Creates or updates a dynamic search rule (upsert).

update!(client_or_uid, uid_or_params \\ nil, params_or_nil \\ nil)

Creates or updates a dynamic search rule, raising on error.

Functions

delete(client_or_uid, uid_or_nil \\ nil)

Deletes a dynamic search rule by UID.

Examples

Meili.DynamicSearchRules.delete("rule-1")
Meili.DynamicSearchRules.delete(client, "rule-1")

delete!(client_or_uid, uid_or_nil \\ nil)

Deletes a dynamic search rule, raising on error.

get(client_or_uid, uid_or_nil \\ nil)

Retrieves a single dynamic search rule by UID.

Examples

Meili.DynamicSearchRules.get("rule-1")
Meili.DynamicSearchRules.get(client, "rule-1")

get!(client_or_uid, uid_or_nil \\ nil)

Retrieves a single dynamic search rule, raising on error.

list(client_or_opts \\ nil, opts \\ [])

Lists all dynamic search rules.

Queries the rules via POST.

Examples

Meili.DynamicSearchRules.list()
Meili.DynamicSearchRules.list(limit: 5)
Meili.DynamicSearchRules.list(client, limit: 5)

list!(client_or_opts \\ nil, opts \\ [])

Lists all dynamic search rules, raising on error.

update(client_or_uid, uid_or_params \\ nil, params_or_nil \\ nil)

Creates or updates a dynamic search rule (upsert).

Examples

params = %{
  description: "Promote support docs",
  conditions: [%{scope: "query", contains: "help"}]
}
Meili.DynamicSearchRules.update("rule-1", params)
Meili.DynamicSearchRules.update(client, "rule-1", params)

update!(client_or_uid, uid_or_params \\ nil, params_or_nil \\ nil)

Creates or updates a dynamic search rule, raising on error.