/meilisearch-ruby

Ruby wrapper for the MeiliSearch API

Primary LanguageRubyMIT LicenseMIT

MeiliSearch-Ruby

MeiliSearch Ruby

MeiliSearch | Website | Blog | Twitter | Documentation | FAQ

Latest Stable Version Test License Slack

⚡ Lightning Fast, Ultra Relevant, and Typo-Tolerant Search Engine MeiliSearch client written in Ruby 💎

MeiliSearch Ruby is a client for MeiliSearch written in Ruby. MeiliSearch is a powerful, fast, open-source, easy to use and deploy search engine. Both searching and indexing are highly customizable. Features such as typo-tolerance, filters, and synonyms are provided out-of-the-box.

Table of Contents

🔧 Installation

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')
index = client.create_index('books') # If your index does not exist
index = client.index('books')        # If you already created your index

documents = [
  { book_id: 123,  title: 'Pride and Prejudice' },
  { book_id: 456,  title: 'Le Petit Prince' },
  { book_id: 1,    title: 'Alice In Wonderland' },
  { book_id: 1344, title: 'The Hobbit' },
  { book_id: 4,    title: 'Harry Potter and the Half-Blood Prince' },
  { book_id: 42,   title: 'The Hitchhiker\'s Guide to the Galaxy' }
]
index.add_documents(documents) # => { "updateId": 0 }

With the updateId, you can check the status (processed or failed) of your documents addition thanks to this method.

Search in index 

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

Output:

{
  "hits" => [{
    "book_id" => 4,
    "title" => "Harry Potter and the Half-Blood Prince"
  }],
  "offset" => 0,
  "limit" => 20,
  "processingTimeMs" => 1,
  "query" => "harry pottre"
}

🤖 Compatibility with MeiliSearch

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

🎬 Examples

All HTTP routes of MeiliSearch are accessible via methods in this SDK.
You can check out the API documentation.

Client

# Default client
client = MeiliSearch::Client.new('http://127.0.0.1:7700', 'masterKey')
# Custom client
client = MeiliSearch::Client.new('http://127.0.0.1:7700', 'masterKey', timeout: 2, max_retries: 2)

timeout - default value: 1 second
The time in seconds before a Timeout::Error is raised.

max_retries - default value: 0
If the HTTP request times out, this number of retries will be applied.

Indexes

Create an index 

# Create an index
client.create_index('books')
# Create an index and give the primary-key
client.create_index('books', primaryKey: 'book_id')
# Create an index or get the already existing one
client.create_index('books')
client.get_or_create_index('books', primaryKey: 'book_id')

List all indexes 

client.indexes

Get an index object 

client.index('books')

Documents

Fetch documents 

# Get one document
index.document(123)
# Get documents by batch
index.documents(offset: 10 , limit: 20)

Add documents 

index.add_documents({ book_id: 2, title: 'Madame Bovary' })

Response:

{
    "updateId": 1
}

With this updateId you can track your operation update.

Delete documents 

# Delete one document
index.delete_document(2)
# Delete several documents
index.delete_documents([1, 42])
# Delete all documents /!\
index.delete_all_documents

Update status

# Get one update status
# Parameter: the updateId got after an asynchronous request (e.g. documents addition)
index.get_update_status(1)
# Get all update satus
index.get_all_update_status

Search

Basic search 

index.search('prince')
{
    "hits": [
        {
            "book_id": 456,
            "title": "Le Petit Prince"
        },
        {
            "book_id": 4,
            "title": "Harry Potter and the Half-Blood Prince"
        }
    ],
    "offset": 0,
    "limit": 20,
    "processingTimeMs": 13,
    "query": "prince"
}

Custom search

All the supported options are described in this documentation section.

index.search('prince', { limit: 1, attributesToHighlight: '*' })
{
    "hits": [
        {
            "book_id": 456,
            "title": "Le Petit Prince",
            "_formatted": {
                "book_id": 456,
                "title": "Le Petit <em>Prince</em>"
            }
        }
    ],
    "offset": 0,
    "limit": 1,
    "processingTimeMs": 0,
    "query": "prince"
}

⚙️ 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.