A lightweight Meilisearch client for Elixir.
If available in Hex, the package can be installed
by adding meilisearch to your list of dependencies in mix.exs:
def deps do
[
{:meilisearch, "~> 1.0.0"}
]
end# Create Index
Meilisearch.Indexes.create("index_name")
# Create Index and set primary key
Meilisearch.Indexes.create("index_name", primary_key: "key_name")
# Insert documents
documents = [
%{
"id" => 1,
"tagline" => "In space no one can hear you scream",
"title" => "Alien"
},
%{
"id" => 2,
"tagline" => "You'll never go in the water again",
"title" => "Jaws"
},
%{
"id" => 3,
"tagline" => "Be Afraid. Be very afraid.",
"title" => "The Fly"
}
]
Meilisearch.Documents.add_or_replace("index_name", documents)
# Search
Meilisearch.Search.search("water")This API should enable you to call all API calls that are defined in the API reference.
Client settings can be configured in your application config or with environment variables.
Note: environment variables will override values in the application config.
config :meilisearch,
endpoint: "http://127.0.0.1:7700",
api_key: "test_api_key"MEILISEARCH_ENDPOINT=http://localhost:7700 mix test
MEILISEARCH_API_KEY=test_api_key_very_secure mix testThe 1.0.X versions of this client have been tested against the following versions of Meilisearch:
- v1.0.0
- v1.0.1
In general: The minor versions of this client should be compatible to the same minor version of Meilisearch.
You will need Meilisearch running locally for development and testing. You can do this via Docker:
$ docker run -it --rm -p 7700:7700 -e MEILI_MASTER_KEY=test_api_key_very_secure getmeili/meilisearch:latest /bin/sh -c /bin/meilisearch
Or using the provided devcontainer configuration.
And then just run your tests, as you usual would:
$ mix test
meilisearch-elixir is released under the MIT license. Please refer to LICENSE for details.