[DEPRECATED] MeiliSearch Laravel Scout

MeiliSearch |Documentation |Slack |Roadmap |Website |FAQ

Table of Contents

📖 Documentation

🔧 Installation

Install the Plugin

composer require meilisearch/meilisearch-laravel-scout

Install the HTTP Client

composer require guzzlehttp/guzzle

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

composer require php-http/guzzle6-adapter

composer require symfony/http-client nyholm/psr7

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

Export Configuration

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

Update the.env file

SCOUT_DRIVER=meilisearchMEILISEARCH_HOST=http://127.0.0.1:7700MEILISEARCH_KEY=masterKey

Run MeiliSearch

docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey

🚀 Getting Started

Indexes

Create an Index

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

Add Documents

<?phpuseLaravel\Scout\Searchable;class Bookextends Model{use Searchable;}

<?phpclass BookControllerextends Controller{publicfunctionstore()    {$book =newBook();$book->title ='Pride and Prejudice';...$book->save();    }}

php artisan scout:import"App\Book"

Search in an Index

class BookControllerextends Controller{publicfunctionsearch()    {// 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

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

php artisan scout:flush"App\Book"

Delete an Index

php artisan scout:index -d books

Search

Custom Search

useMeiliSearch\Endpoints\Indexes;class BookControllerextends Controller{publicfunctioncustomSearch()    {        Book::search('prince',function (Indexes$meilisearch,$query,$options) {$options['filters'] ='author="Antoine de Saint-Exupéry"';return$meilisearch->search($query,$options);        })->take(3)->get();    }}

Pagination

class BookControllerextends Controller{publicfunctionsearch()    {        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

💡 Learn More

Development Workflow and Contributing