wannanbigpig/laravel-scout-elastic

Elastic Driver for Laravel Scout

v1.1.1 2023-06-02 08:03 UTC

Requires

• php: ^8.0|^8.1|^8.2
• elasticsearch/elasticsearch: ^7.9
• laravel/scout: ^9.3|^10.0

Requires (Dev)

• mockery/mockery: ^1.0
• phpunit/phpunit: ^8.0|^9.3

Suggests

• elasticsearch/elasticsearch: Required to use the Elasticsearch engine (^7.9).

MIT

• wannanbigpig

• elasticsearch
• laravel
• elastic
• scout

README

Elastic Driver for Laravel Scout

Installation

You can install the package via composer:

composer require wannanbigpig/laravel-scout-elastic

Setting up Elasticsearch configuration

After installing, you should publish the Scout configuration file using the vendor:publish Artisan command. This command will publish the scout.php configuration file to your application's config directory:

php artisan vendor:publish --provider="Laravel\Scout\ScoutServiceProvider"

After you've published the Laravel Scout package configuration, you need to set your driver to elasticsearch and add its configuration:

// config/scout.php
<?php

return [
    // ...
    
    'driver' => env('SCOUT_DRIVER', 'elasticsearch'),
    
    // ...
    
    /*
    |--------------------------------------------------------------------------
    | Elasticsearch Configuration
    |--------------------------------------------------------------------------
    |
    | Here you may configure your Elasticsearch settings.
    |
    */

    'elasticsearch' => [
        'hosts' => [env('ELASTICSEARCH_HOST', 'http://127.0.0.1:9200')],
        // 'auth' => [
        //     'username' => 'elastic',
        //     'password' => 'password copied during Elasticsearch start',
        // ],
        // index_ is followed by the index name. If you do not need to customize the index analyzer, skip the following Settings
        'index_article' => [
            'settings' => [
                'number_of_shards' => 5,
                'number_of_replicas' => 1,
            ],
            'mappings' => [
                "properties" => [
                    "title" => [
                        "type" => "text",
                        "analyzer" => "ik_max_word",
                        "search_analyzer" => "ik_smart",
                        "fields" => ["keyword" => ["type" => "keyword", "ignore_above" => 256]],
                    ],
                ],
            ],
        ],
    ],
];

Usage

console

// create index
php artisan scout:index article

// delete index
php artisan scout:delete-index article

// batch update data to es
php artisan scout:import "App\Models\Article"

search example

use App\Models\Article;

// $condition = "test";
// ... or
// $condition = [
//     "title" => "test",
//     "abstract" => "test"
// ];
// ... or
$keyword = "test";
$source = [1,2];
$startTime = '2023-05-01T00:00:00.000+0800';
$endTime = '2023-05-20T00:00:00.000+0800';
$condition = [
    "_customize_body" => 1,
    "query" => [
        "bool" => [
            "should" => [
                [
                    "match" => [
                        "title" => ["query" => $keyword, 'boost' => 5],
                    ],
                ],
                [
                    "match" => [
                        "abstract" => ["query" => $keyword, 'boost' => 3],
                    ],
                ],
            ],
            "must" => [
                [
                    "terms" => ["source" => $source],
                ],
                [
                    "range" => [
                        "created_at" => [
                            'gte' => $startTime,
                            'lte' => $endTime,
                        ],
                    ],
                ],
            ],
        ],
    ],
];

$data = Article::search($condition)
        ->orderBy('_score', 'desc')
        ->paginate(10);

More please see Laravel Scout official documentation.

Reference：

https://github.com/ErickTamayo/laravel-scout-elastic

https://github.com/laravel/scout/tree/10.x

https://github.com/medcl/elasticsearch-analysis-ik

License

The MIT License (MIT).