README

🍺 如果你喜欢我的包，买我一杯啤酒吧！点此购买。

项目在 Gitter 上有一个聊天室！

此包提供用于在 Elasticsearch 中搜索和过滤数据的先进功能。查看其功能！

内容

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

功能

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

需求

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

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

安装

使用 composer 安装包

composer require babenkoivan/scout-elasticsearch-driver

如果你使用的是 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 a model fields.
    protected $mapping = [
        'properties' => [
            'text' => [
                'type' => 'text',
                '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;

可用过滤器

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

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

零停机迁移

正如你所知道的，你不能更改已创建字段的类型。在这种情况下，唯一的选择是创建一个新的索引，并带有必要的映射，然后导入你的模型到新的索引中。
迁移过程可能需要相当长的时间，因此为了避免在迁移过程中出现停机，驱动程序会从旧索引读取并写入新索引。迁移完成后，它开始从新索引读取并删除旧索引。这就是 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();

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

lmarttins/scout-elasticsearch-driver

维护者

详细信息