MeiliSearch Ruby

MeiliSearch | Documentation | Slack | Roadmap | Website | FAQ

⚡ The MeiliSearch API client written for Ruby 💎

MeiliSearch Ruby is the MeiliSearch API client for Ruby developers.

MeiliSearch is an open-source search engine. Discover what MeiliSearch is!

📖 Documentation
🔧 Installation
🚀 Getting Started
🤖 Compatibility with MeiliSearch
💡 Learn More
⚙️ Development Workflow and Contributing

📖 Documentation

See our Documentation or our API References.

🔧 Installation

This package requires Ruby version 2.6.0 or later.

With gem in command line:

gem install meilisearch

In your Gemfile with bundler:

source 'https://rubygems.org'

gem 'meilisearch'

Run MeiliSearch

There are many easy ways to download and run a MeiliSearch instance.

For example, if you use Docker:

docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey

NB: you can also download MeiliSearch from Homebrew or APT.

🚀 Getting Started

Add documents

require 'meilisearch'

client = MeiliSearch::Client.new('http://127.0.0.1:7700', 'masterKey')

# An index is where the documents are stored.
index = client.index('movies')

documents = [
  { id: 1, title: 'Carol', genres: ['Romance', 'Drama'] },
  { id: 2, title: 'Wonder Woman', genres: ['Action', 'Adventure'] },
  { id: 3, title: 'Life of Pi', genres: ['Adventure', 'Drama'] },
  { id: 4, title: 'Mad Max: Fury Road', genres: ['Adventure', 'Science Fiction'] },
  { id: 5, title: 'Moana', genres: ['Fantasy', 'Action']},
  { id: 6, title: 'Philadelphia', genres: ['Drama'] },
]
# If the index 'movies' does not exist, MeiliSearch creates it when you first add the documents.
index.add_documents(documents) # => { "updateId": 0 }

With the updateId, you can check the status (enqueued, processing, processed or failed) of your documents addition using the update endpoint.

💡 To customize the Client, for example, increasing the default timeout, please check out this section of the Wiki.

Basic Search

# MeiliSearch is typo-tolerant:
puts index.search('carlo')

Output:

{
  "hits" => [{
    "id" => 1,
    "title" => "Carol"
  }],
  "offset" => 0,
  "limit" => 20,
  "processingTimeMs" => 1,
  "query" => "carlo"
}

Custom search

All the supported options are described in the search parameters section of the documentation.

index.search(
  'wonder',
  attributesToHighlight: ['*']
)

JSON output:

{
    "hits": [
        {
            "id": 2,
            "title": "Wonder Woman",
            "_formatted": {
                "id": 2,
                "title": "<em>Wonder</em> Woman"
            }
        }
    ],
    "offset": 0,
    "limit": 20,
    "processingTimeMs": 0,
    "query": "wonder"
}

🤖 Compatibility with MeiliSearch

This package only guarantees the compatibility with the version v0.22.0 of MeiliSearch.

💡 Learn More

The following sections may interest you:

Manipulate documents: see the API references or read more about documents.
Search: see the API references or follow our guide on search parameters.
Manage the indexes: see the API references or read more about indexes.
Configure the index settings: see the API references or follow our guide on settings parameters.

📖 Also, check out the Wiki of this repository to know what this SDK provdes!

⚙️ Development Workflow and Contributing

Any new contribution is more than welcome in this project!

If you want to know more about the development workflow or want to contribute, please visit our contributing guidelines for detailed instructions!

MeiliSearch provides and maintains many SDKs and Integration tools like this one. We want to provide everyone with an amazing search experience for any kind of project. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the integration-guides repository.

toshitapandey/meilisearch-ruby