Need help with meilisearch-laravel-scout?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

meilisearch
453 Stars 35 Forks MIT License 191 Commits 7 Opened issues

Description

MeiliSearch integration for Laravel Scout

Services available

!
?

Need anything else?

Contributors list

MeiliSearch Laravel Scout

MeiliSearch Laravel Scout

MeiliSearch | Documentation | Slack | Roadmap | Website | FAQ

Latest Stable Version Actions Status License Bors enabled

⚡ The MeiliSearch driver for Laravel Scout

MeiliSearch Laravel Scout is a MeiliSearch driver for Laravel.

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

Table of Contents <!-- omit in toc -->

📖 Documentation

See our Documentation or our API References.

Also, take a look at the Wiki of this repository!

🔧 Installation

Install the Plugin <!-- omit in toc -->

composer require meilisearch/meilisearch-laravel-scout

Install the HTTP Client <!-- omit in toc -->

You could use any PSR-18 compatible client to use with this SDK. No additional configurations are required.
A list of compatible HTTP clients and client adapters can be found at php-http.org.

If you use Laravel 8 you can skip this section as laravel pre-install Guzzle 7 by default.

Guzzle 7:

bash
composer require guzzlehttp/guzzle

If you already have guzzle installed with a version < 7, don't forget to update the version inside your composer.json

json
"require": {
  "guzzlehttp/guzzle": "^7.0"
}

Guzzle 6:

composer require php-http/guzzle6-adapter

Symfony Http Client:

composer require symfony/http-client nyholm/psr7

Curl:

composer require php-http/curl-client nyholm/psr7

Export Configuration <!-- omit in toc -->

php artisan vendor:publish --provider="Laravel\Scout\ScoutServiceProvider"
php artisan vendor:publish --provider="Meilisearch\Scout\MeilisearchServiceProvider" --tag="config"

Update the
.env
file <!-- omit in toc -->

SCOUT_DRIVER=meilisearch
MEILISEARCH_HOST=http://127.0.0.1:7700
MEILISEARCH_KEY=masterKey

Run MeiliSearch <!-- omit in toc -->

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

For example, if you use Docker:

bash
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

Indexes

Create an Index <!-- omit in toc -->

// Create an index
php artisan scout:index books
// Create an index and give the primary-key
php artisan scout:index books --key book_id

Add Documents <!-- omit in toc -->

class Book extends Model
{
    use Searchable;
}
title = 'Pride and Prejudice';
        ...
        $book->save();
    }
}

You can also import all your table to meilisearch by using the artisan command:

bash
php artisan scout:import "App\Book"

Search in an Index <!-- omit in toc -->

class BookController extends Controller
{
    public function search()
    {
        // MeiliSearch is typo-tolerant:
        Book::search('harry pottre')->get();
        // Or if you want to get the result from meilisearch:
        Book::search('harry pottre')->raw();
    }
}

Delete Documents <!-- omit in toc -->

class BookController extends Controller
{
    public function destroy($id)
    {
        // Delete one document
        Book::find($id)->delete();
        // Delete several documents
        Book::destroy([1, 42]);
        // Delete all documents /!\
        Book::query()->delete();
    }
}

or you can use the artisan command to delete all documents from an index:

bash
php artisan scout:flush "App\Book"

Delete an Index <!-- omit in toc -->

php artisan scout:index -d books

Search

Custom Search <!-- omit in toc -->

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

use MeiliSearch\Endpoints\Indexes;

class BookController extends Controller { public function customSearch() { Book::search('prince', function (Indexes $meilisearch, $query, $options) { $options['filters'] = 'author="Antoine de Saint-Exupéry"';

        return $meilisearch-&gt;search($query, $options);
    })-&gt;take(3)-&gt;get();
}

}

Pagination <!-- omit in toc -->

class BookController extends Controller
{
    public function search()
    {
        Book::search('mustang')->paginate();
        // with a limit of items per page:
        Book::search('mustang')->paginate(5);
        // using meilisearch response:
        Book::search('mustang')->paginateRaw();
    }
}

🤖 Compatibility with MeiliSearch

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

💡 Learn More

If you're not familiar with MeiliSerach yet, the following sections may interest you:

💡 You can use more advance function by reading the documentation of MeiliSearch PHP Client.

👍 This package is a custom engine of Laravel Scout.

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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.