README

此包为在 Elasticsearch 中搜索和过滤数据提供高级功能。查看其特性！

内容

特性
要求
安装
配置
索引配置器
可搜索模型
用法
控制台命令
搜索规则
可用过滤器
零停机迁移
调试

特性

一种简单的方式来配置和创建 Elasticsearch 索引。
每个模型的完全可配置映射。
自动或使用 Artisan 命令将新字段添加到现有映射的方式。
多种方式实现搜索算法：使用搜索规则或原始搜索。
提供多种过滤类型，使搜索查询更具体。
从旧索引到新索引的零停机迁移。
批量索引，请参阅配置部分。

要求

该包已在以下配置下进行了测试

PHP 版本 >= 7.1.3
Laravel 框架版本 >= 5.6
Elasticsearch 版本 >= 6

安装

使用 composer 安装包

composer require linshunwei/laravel-scout-elasticsearch

如果您正在使用 Laravel 版本 <= 5.4 或禁用了包发现，请将以下提供者在 config/app.php 中添加

'providers' => [
    Laravel\Scout\ScoutServiceProvider::class,
    ScoutElastic\ScoutElasticServiceProvider::class,
]

配置

要配置此包，您需要首先发布设置

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

然后，在 config/scout.php 文件中将驱动设置设置为 elastic，并在 config/scout_elastic.php 文件中配置驱动程序本身。可用的选项包括

注意，如果您使用批量文档索引，您可能希望更改块大小，您可以在 config/scout.php 文件中这样做。

索引配置器

使用索引配置器类来设置 Elasticsearch 索引的设置。要创建新的索引配置器，请使用以下 artisan 命令

php artisan make:index-configurator MyIndexConfigurator

它将在您的项目的 app 文件夹中创建 MyIndexConfigurator.php 文件。您可以根据以下示例指定索引名称和设置

<?php

namespace App;

use ScoutElastic\IndexConfigurator;

class MyIndexConfigurator extends IndexConfigurator
{
    // It's not obligatory to determine name. By default it'll be a snaked class name without `IndexConfigurator` part.
    protected $name = 'my_index';  
    
    // You can specify any settings you want, for example, analyzers. 
    protected $settings = [
        'analysis' => [
            'analyzer' => [
                'es_std' => [
                    'type' => 'standard',
                    'stopwords' => '_spanish_'
                ]
            ]    
        ]
    ];
}

有关索引设置的信息，您可以在 Elasticsearch 文档的索引管理部分中找到。

要创建索引，只需运行 artisan 命令

php artisan elastic:create-index App\\MyIndexConfigurator

注意，每个可搜索模型都需要其自己的索引配置器。

在 Elasticsearch 6.0.0 或更高版本中创建的索引可能只能包含一个映射类型。在 5.x 中使用多个映射类型创建的索引将继续在 Elasticsearch 6.x 中按以前的方式运行。映射类型将在 Elasticsearch 7.0.0 中完全删除。

有关更多信息，请参阅这里。

可搜索模型

要创建一个可以在 Elasticsearch 索引中执行搜索请求的模型，请使用以下命令

php artisan make:searchable-model MyModel --index-configurator=MyIndexConfigurator

执行命令后，您将在 app 文件夹中找到 MyModel.php 文件。

<?php

namespace App;

use ScoutElastic\Searchable;
use Illuminate\Database\Eloquent\Model;

class MyModel extends Model
{
    use Searchable;

    protected $indexConfigurator = MyIndexConfigurator::class;

    protected $searchRules = [
        //
    ];

    // Here you can specify a mapping for model fields
    protected $mapping = [
        'properties' => [
            'title' => [
                'type' => 'text',
                // Also you can configure multi-fields, more details you can find here https://elastic.ac.cn/guide/en/elasticsearch/reference/current/multi-fields.html
                'fields' => [
                    'raw' => [
                        'type' => 'keyword',
                    ]
                ]
            ],
        ]
    ];
}

每个可搜索的模型代表一个 Elasticsearch 类型。默认情况下，类型名称与表名相同，但您可以通过 searchableAs 方法设置任何类型名称。您还可以通过 toSearchableArray 方法指定将被驱动程序索引的字段。有关这些选项的更多信息，请参阅 scout 官方文档。

在 MyModel 类中可以设置的最后一个重要选项是 $searchRules 属性。它允许您为模型设置不同的搜索算法。我们将在搜索规则部分仔细研究它。

在您的模型中设置映射后，您可以更新 Elasticsearch 类型映射。

php artisan elastic:update-mapping App\\MyModel

用法

一旦创建了索引配置器、Elasticsearch 索引和可搜索模型，您就可以开始了。现在您可以根据文档进行索引和搜索数据。

基本搜索使用示例

// set query string
App\MyModel::search('phone')
    // specify columns to select
    ->select(['title', 'price'])
    // filter 
    ->where('color', 'red')
    // sort
    ->orderBy('price', 'asc')
    // collapse by field
    ->collapse('brand')
    // set offset
    ->from(0)
    // set limit
    ->take(10)
    // get results
    ->get();

如果只需要查询的匹配数量，请使用 count 方法。

App\MyModel::search('phone') 
    ->count();

如果需要加载关系，请使用 with 方法。

App\MyModel::search('phone') 
    ->with('makers')
    ->get();

除了标准功能外，该包还为您提供了一种在未指定查询字符串的情况下过滤 Elasticsearch 数据的可能性。

App\MyModel::search('*')
    ->where('id', 1)
    ->get();

您还可以覆盖模型的搜索规则。

App\MyModel::search('Brazil')
    ->rule(App\MySearchRule::class)
    ->get();

您可以使用多种 where 条件。

App\MyModel::search('*')
    ->whereRegexp('name.raw', 'A.+')
    ->where('age', '>=', 30)
    ->whereExists('unemployed')
    ->get();

最后，如果您想发送自定义请求，可以使用 searchRaw 方法。

App\MyModel::searchRaw([
    'query' => [
        'bool' => [
            'must' => [
                'match' => [
                    '_all' => 'Brazil'
                ]
            ]
        ]
    ]
]);

此查询将返回原始响应。

控制台命令

下面列出了可用的 artisan 命令。

要获取详细说明和所有可用选项，请在命令行中运行 php artisan help [command]。

搜索规则

搜索规则是一个描述搜索查询如何执行的类。要创建搜索规则，请使用以下命令：

php artisan make:search-rule MySearchRule

在文件 app/MySearchRule.php 中，您将找到类定义。

<?php

namespace App;

use ScoutElastic\SearchRule;

class MySearch extends SearchRule
{
    // This method returns an array, describes how to highlight the results.
    // If null is returned, no highlighting will be used. 
    public function buildHighlightPayload()
    {
        return [
            'fields' => [
                'name' => [
                    'type' => 'plain'
                ]
            ]
        ];
    }
    
    // This method returns an array, that represents bool query.
    public function buildQueryPayload()
    {
        return [
            'must' => [
                'match' => [
                    'name' => $this->builder->query
                ]
            ]
        ];
    }
}

您可以在这里阅读有关 bool 查询的更多信息，以及在这里阅读有关高亮显示的更多信息。

默认搜索规则返回以下负载。

return [
   'must' => [
       'query_string' => [
           'query' => $this->builder->query
       ]
   ]
];

这意味着默认情况下，当您在模型上调用 search 方法时，它会尝试在任意字段中查找查询字符串。

要确定模型的默认搜索规则，只需添加一个属性即可。

<?php

namespace App;

use ScoutElastic\Searchable;
use Illuminate\Database\Eloquent\Model;

class MyModel extends Model
{
    use Searchable;
    
    // You can set several rules for one model. In this case, the first not empty result will be returned.
    protected $searchRules = [
        MySearchRule::class
    ];
}

您也可以在查询构建器中设置搜索规则。

// You can set either a SearchRule class
App\MyModel::search('Brazil')
    ->rule(App\MySearchRule::class)
    ->get();
    
// or a callable
App\MyModel::search('Brazil')
    ->rule(function($builder) {
        return [
            'must' => [
                'match' => [
                    'Country' => $builder->query
                ]
            ]
        ];
    })
    ->get();

要获取高亮显示，请使用模型的 highlight 属性。

// Let's say we highlight field `name` of `MyModel`.
$model = App\MyModel::search('Brazil')
    ->rule(App\MySearchRule::class)
    ->first();

// Now you can get raw highlighted value:
$model->highlight->name;

// or string value:
 $model->highlight->nameAsString;

可用过滤器

您可以使用不同类型的过滤器。

在大多数情况下，最好使用原始字段来过滤记录，即未分析的字段。

按距离排序

orderGeoDistanceBy($field, $points, $direction = 'asc', $unit = 'km', $distance_type = 'arc')

零停机迁移

如您所知，您不能更改已创建的字段在 Elasticsearch 中的类型。在这种情况下，唯一的选择是创建一个具有必要映射的新索引，并将您的模型导入到新索引中。
迁移可能需要相当长的时间，因此为了避免在过程中停机，驱动程序从旧索引中读取并写入新索引。一旦迁移完成，它开始从新索引中读取，并删除旧索引。这是 artisan elastic:migrate 命令的工作方式。

在运行命令之前，请确保您的索引配置器使用了 ScoutElastic\Migratable 特性。如果没有，请添加该特性，并使用索引配置器类名作为参数，运行 artisan elastic:update-index 命令。

php artisan elastic:update-index App\\MyIndexConfigurator

准备好后，在模型映射中做出更改，并使用模型类作为第一个参数，所需索引名作为第二个参数，运行 elastic:migrate 命令。

php artisan elastic:migrate App\\MyModel my_index_v2

注意，如果您只需要在映射中添加新字段，请使用 elastic:update-mapping 命令。

调试

有两种方法可以帮助您分析搜索查询的结果

explain

App\MyModel::search('Brazil')
    ->explain();

profile

App\MyModel::search('Brazil')
    ->profile();

这两种方法都会从 ES 返回原始数据。

此外，您可以通过调用 buildPayload 方法来获取将被发送到 ES 的查询负载。

App\MyModel::search('Brazil')
    ->buildPayload();

注意，由于一个查询中可能使用多个搜索规则，该方法返回的是一个负载集合。

linshunwei / laravel-scout-elasticsearch

维护者

详细信息