Learn how to set up Laravel Scout in Laravel 11 with this detailed guide. Explore the installation process, configuration options, and search driver setup to boost your application’s search functionality.<\/p>\n
In today’s web applications, having effective search features is key to improving user experience. Laravel Scout is a handy tool that works with Laravel 11 to offer full-text search capabilities. This guide will walk you through the process of setting up Laravel Scout, configuring it with Meilisearch, and refining your search setup with advanced techniques.<\/p>\n
To begin, make sure you have Laravel installed on your system. You can add Laravel Scout to your project using Composer. Open your terminal and run the following command:<\/p>\n
composer require laravel\/scout <\/code><\/pre>\nThis command will add Laravel Scout to your project, allowing you to integrate it with your Laravel application.<\/p>\n
Step 2: Configure Scout<\/h3>\n
After the installation is finished, you’ll need to publish the Scout configuration file to customize its settings according to your needs.<\/p>\n
php artisan vendor:publish --provider=\"Laravel\\Scout\\ScoutServiceProvider\" <\/code><\/pre>\nThis will generate a config\/scout.php file where you can customize the default settings to fit your requirements.<\/p>\n
Step 3: Choose a Search Driver<\/h3>\n
Laravel Scout works with different search engines, with Algolia being the default option. To use a different search driver, simply update the config\/scout.php file.<\/p>\n
'driver' => env('SCOUT_DRIVER', 'algolia'), <\/code><\/pre>\nFor this tutorial, we will use Meilisearch. Update your .env file to set:<\/p>\n
SCOUT_DRIVER=meilisearch <\/code><\/pre>\nStep 4: Set Up Meilisearch<\/h3>\n
If you opt for Meilisearch, follow the official Meilisearch documentation to install and configure it. After installation, configure Meilisearch in your .env file:<\/p>\n
MEILISEARCH_HOST=http:\/\/127.0.0.1:7700 <\/code><\/pre>\nEnsure you have set SCOUT_DRIVER=meilisearch to use Meilisearch as your search engine.<\/p>\n
Step 5: Add the Searchable Trait to Your Model<\/h3>\n
To enable search functionality for an Eloquent model, use the Searchable trait. For example, modify your Post model as follows:<\/p>\n
\r\n namespace App\\Models;\r\n\r\n use Illuminate\\Database\\Eloquent\\Model;\r\n use Laravel\\Scout\\Searchable;\r\n \r\n class Post extends Model\r\n {\r\n use Searchable;\r\n \r\n \/\/ Additional model code...\r\n }\r\n \r\n<\/code><\/pre>\nAdding this trait allows Laravel Scout to index and search the Post model’s records. <\/p>\n
Step 6: Index Your Data<\/h3>\n
Populate your search index by running the scout:import Artisan command:<\/p>\n
php artisan scout:import \"App\\Models\\Post\" <\/code><\/pre>\nThis command syncs all existing records of the Post model with your search engine, making them searchable.<\/p>\n
Step 7: Performing Searches<\/h3>\n
With indexing complete, you can perform searches on your model. Here’s how to search for posts by a keyword:<\/p>\n
$posts = App\\Models\\Post::search('keyword')->get(); <\/code><\/pre>\nThis query retrieves all posts that match the specified keyword.<\/p>\n
Step 8: Customizing Search Behavior<\/h3>\n
To customize how models are indexed, override the toSearchableArray method in your model:<\/p>\n
\r\n class Post extends Model\r\n {\r\n use Searchable;\r\n \r\n public function toSearchableArray()\r\n {\r\n $array = $this->toArray();\r\n \r\n \/\/ Customize array...\r\n \r\n return $array;\r\n }\r\n } \r\n<\/code><\/pre>\nThis method allows you to tailor the data indexed by Scout.<\/p>\n
Step 9: Handling Indexing in Background<\/h3>\n
To handle indexing in the background, use Laravel’s queue system. Enable this by setting SCOUT_QUEUE to true in your .env file:<\/p>\n
SCOUT_QUEUE=true <\/code><\/pre>\nEnsure your queue worker is running with:<\/p>\n
php artisan queue:work <\/code><\/pre>\nThis setup enhances performance by handling indexing tasks in the background.<\/p>\n
Step 10: Testing Your Search Implementation<\/h3>\n
Make sure your search feature performs correctly by writing tests. Here\u2019s a simple example using PHPUnit:<\/p>\n
\r\n use Illuminate\\Foundation\\Testing\\RefreshDatabase;\r\n use App\\Models\\Post;\r\n \r\n class SearchTest extends TestCase\r\n {\r\n use RefreshDatabase;\r\n \r\n public function test_search_returns_expected_results()\r\n {\r\n Post::factory()->create(['title' => 'Laravel Scout Tutorial']);\r\n Post::factory()->create(['title' => 'Another Post']);\r\n \r\n $results = Post::search('Laravel')->get();\r\n \r\n $this->assertCount(1, $results);\r\n }\r\n } \r\n<\/code><\/pre>\nTesting helps verify that your search setup works properly and delivers the results you expect.<\/p>\n