Laravel Elasticsearch – Elasticsearch integration

Projects Inventory

2 months ago

Integrating Elasticsearch with your Laravel application can enhance search capabilities significantly.

Step 1: Install Elasticsearch

If you haven’t installed Elasticsearch yet, you can do so by following the instructions on the official Elasticsearch website. Make sure it’s running on your local machine or server.

Step 2: Install the Elasticsearch PHP Client

You can install the Elasticsearch PHP client via Composer. Run the following command in your terminal:

bash

composer require elasticsearch/elasticsearch

1	composer require elasticsearch/elasticsearch

Step 3: Configure Elasticsearch in Laravel

To connect Laravel with Elasticsearch, you should create a configuration file. You can do this by creating a new config file:

Create a configuration file at config/elasticsearch.php:

php

<?php

return [
    'hosts' => [
        env('ELASTICSEARCH_HOST', 'localhost:9200'), // Default host and port
    ],
];

<?php

return [

'hosts' => [

env('ELASTICSEARCH_HOST', 'localhost:9200'), // Default host and port

];

Add the Elasticsearch host configuration in your .env file:

plaintext

ELASTICSEARCH_HOST=localhost:9200

1	ELASTICSEARCH_HOST=localhost:9200

Step 4: Create a Service Provider

Create a service provider to encapsulate Elasticsearch functionality. You can do this with the following command:

bash

php artisan make:provider ElasticsearchServiceProvider

1	php artisan make:provider ElasticsearchServiceProvider

In the ElasticsearchServiceProvider, set up the Elasticsearch client:

php

php artisan make:provider ElasticsearchServiceProvider

1	php artisan make:provider ElasticsearchServiceProvider

<?php

namespace App\Providers;

use Elasticsearch\ClientBuilder;
use Illuminate\Support\ServiceProvider;

class ElasticsearchServiceProvider extends ServiceProvider
{
    public function register()
    {
        $this->app->singleton('Elasticsearch', function ($app) {
            $config = $app['config']['elasticsearch'];
            return ClientBuilder::create()->setHosts($config['hosts'])->build();
        });
    }

    public function boot()
    {
        //
    }
}

<?php

namespace App\Providers;

use Elasticsearch\ClientBuilder;

use Illuminate\Support\ServiceProvider;

class ElasticsearchServiceProvider extends ServiceProvider

{

public function register()

{

$this->app->singleton('Elasticsearch', function ($app) {

$config = $app['config']['elasticsearch'];

return ClientBuilder::create()->setHosts($config['hosts'])->build();

});

}

public function boot()

{

}

Step 5: Register the Service Provider

Next, you need to register your new service provider. Open config/app.php and add your ElasticsearchServiceProvider to the providers array:

php

'providers' => [
    // Other Service Providers
    App\Providers\ElasticsearchServiceProvider::class,
],

'providers' => [

// Other Service Providers

App\Providers\ElasticsearchServiceProvider::class,

Step 6: Create an Index

Now, create an index in Elasticsearch where you will store your documents. You can do this via a controller or directly using artisan commands.

Here’s an example of how to create an index using a controller:

Create a controller with the command:

bash

php artisan make:controller ElasticsearchController

1	php artisan make:controller ElasticsearchController

In the ElasticsearchController, add methods to create an index:

php

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class ElasticsearchController extends Controller
{
    public function createIndex()
    {
        $client = app('Elasticsearch');

        $params = [
            'index' => 'my_index',
            'body' => [
                'settings' => [
                    'number_of_shards' => 1,
                    'number_of_replicas' => 0,
                ],
                'mappings' => [
                    'properties' => [
                        'title' => ['type' => 'text'],
                        'content' => ['type' => 'text'],
                    ],
                ],
            ],
        ];

        $response = $client->indices()->create($params);

        return response()->json($response);
    }
}

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class ElasticsearchController extends Controller

{

public function createIndex()

{

$client = app('Elasticsearch');

$params = [

'index' => 'my_index',

'body' => [

'settings' => [

'number_of_shards' => 1,

'number_of_replicas' => 0,

'mappings' => [

'properties' => [

'title' => ['type' => 'text'],

'content' => ['type' => 'text'],

];

$response = $client->indices()->create($params);

return response()->json($response);

}

Step 7: Define Routes

Define routes to access the Elasticsearch functionality in routes/web.php:

php

use App\Http\Controllers\ElasticsearchController;

Route::get('/create-index', [ElasticsearchController::class, 'createIndex'])->name('create.index');

use App\Http\Controllers\ElasticsearchController;

Route::get('/create-index', [ElasticsearchController::class, 'createIndex'])->name('create.index');

Step 8: Testing the Index Creation

Start your Laravel development server:

bash

php artisan serve

1	php artisan serve

Visit http://localhost:8000/create-index in your browser. You should see a JSON response indicating the success of the index creation.

Step 9: Indexing Documents

Now, you can index documents in Elasticsearch. Update your ElasticsearchController to include a method for indexing documents:

php

public function indexDocument()
{
    $client = app('Elasticsearch');

    $params = [
        'index' => 'my_index',
        'id'    => '1', // Specify a document ID
        'body'  => [
            'title' => 'Sample Title',
            'content' => 'This is the content of the sample document.',
        ],
    ];

    $response = $client->index($params);

    return response()->json($response);
}

public function indexDocument()

{

$client = app('Elasticsearch');

$params = [

'index' => 'my_index',

'id' => '1', // Specify a document ID

'body' => [

'title' => 'Sample Title',

'content' => 'This is the content of the sample document.',

];

$response = $client->index($params);

return response()->json($response);

}

Step 10: Define a Route for Indexing Documents

Add a route to handle document indexing in routes/web.php:

php

Route::get('/index-document', [ElasticsearchController::class, 'indexDocument'])->name('index.document');

1	Route::get('/index-document', [ElasticsearchController::class, 'indexDocument'])->name('index.document');

Step 11: Testing Document Indexing

Visit http://localhost:8000/index-document in your browser to index a sample document. You should see a JSON response indicating the success of the indexing.

Step 12: Searching Documents

You can also search for documents in your Elasticsearch index. Update your ElasticsearchController to include a search method:

php

public function searchDocument(Request $request)
{
    $client = app('Elasticsearch');

    $params = [
        'index' => 'my_index',
        'body'  => [
            'query' => [
                'match' => [
                    'title' => $request->input('query'),
                ],
            ],
        ],
    ];

    $response = $client->search($params);

    return response()->json($response);
}

public function searchDocument(Request $request)

{

$client = app('Elasticsearch');

$params = [

'index' => 'my_index',

'body' => [

'query' => [

'match' => [

'title' => $request->input('query'),

];

$response = $client->search($params);

return response()->json($response);

}

Step 13: Define a Route for Searching Documents

Add a route for searching in routes/web.php:

php

Route::get('/search-document', [ElasticsearchController::class, 'searchDocument'])->name('search.document');

1	Route::get('/search-document', [ElasticsearchController::class, 'searchDocument'])->name('search.document');

Step 14: Testing Document Search

To search for documents, you can access the search route with a query parameter, for example:

bash

http://localhost:8000/search-document?query=Sample

1	http://localhost:8000/search-document?query=Sample

Summary

You have successfully integrated Elasticsearch into your Laravel application! Here’s a quick recap of the steps:

Install Elasticsearch and the Elasticsearch PHP client.
Create a configuration file for Elasticsearch settings.
Create a service provider to manage the Elasticsearch client.
Register the service provider in the app configuration.
Create an index and methods for indexing and searching documents.
Define routes for creating indexes and searching documents.
Test the functionality through your browser.

Step 1: Install Elasticsearch

Step 2: Install the Elasticsearch PHP Client

Step 3: Configure Elasticsearch in Laravel

Step 4: Create a Service Provider

Step 5: Register the Service Provider

Step 6: Create an Index

Step 7: Define Routes

Step 8: Testing the Index Creation

Step 9: Indexing Documents

Step 10: Define a Route for Indexing Documents

Step 11: Testing Document Indexing

Step 12: Searching Documents

Step 13: Define a Route for Searching Documents

Step 14: Testing Document Search

Summary

Related Posts: