首页
/ Scout Elasticsearch Driver 使用教程

Scout Elasticsearch Driver 使用教程

2024-09-16 10:49:05作者:田桥桑Industrious

1. 项目介绍

Scout Elasticsearch Driver 是一个为 Laravel Scout 提供的 Elasticsearch 驱动扩展包。它允许你在 Laravel 应用中使用 Elasticsearch 进行高级搜索和数据过滤。该包提供了丰富的功能,包括索引配置、搜索规则、零停机迁移等,使得在 Laravel 项目中集成 Elasticsearch 变得更加简单和高效。

2. 项目快速启动

2.1 安装

首先,使用 Composer 安装 Scout Elasticsearch Driver

composer require babenkoivan/scout-elasticsearch-driver

2.2 配置

安装完成后,需要发布 Scout 和 Scout Elasticsearch Driver 的配置文件:

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

然后,在 config/scout.php 文件中设置驱动为 elastic

'driver' => env('SCOUT_DRIVER', 'elastic'),

2.3 创建索引配置器

使用以下命令创建一个新的索引配置器:

php artisan make:index-configurator MyIndexConfigurator

在生成的 MyIndexConfigurator.php 文件中,你可以配置索引名称和设置:

namespace App;

use ScoutElastic\IndexConfigurator;

class MyIndexConfigurator extends IndexConfigurator
{
    protected $name = 'my_index';

    protected $settings = [
        'analysis' => [
            'analyzer' => [
                'es_std' => [
                    'type' => 'standard',
                    'stopwords' => '_spanish_',
                ],
            ],
        ],
    ];
}

2.4 创建可搜索模型

使用以下命令创建一个新的可搜索模型:

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

在生成的 MyModel.php 文件中,配置模型的索引配置器和映射:

namespace App;

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

class MyModel extends Model
{
    use Searchable;

    protected $indexConfigurator = MyIndexConfigurator::class;

    protected $searchRules = [];

    protected $mapping = [
        'properties' => [
            'title' => [
                'type' => 'text',
                'fields' => [
                    'raw' => [
                        'type' => 'keyword',
                    ],
                ],
            ],
        ],
    ];
}

2.5 创建和更新索引

创建索引:

php artisan elastic:create-index "App\MyIndexConfigurator"

更新模型映射:

php artisan elastic:update-mapping "App\MyModel"

2.6 基本搜索

现在你可以使用 Elasticsearch 进行搜索了:

$results = App\MyModel::search('phone')
    ->select(['title', 'price'])
    ->where('color', 'red')
    ->orderBy('price', 'asc')
    ->collapse('brand')
    ->from(0)
    ->take(10)
    ->get();

3. 应用案例和最佳实践

3.1 高级搜索

Scout Elasticsearch Driver 支持多种高级搜索功能,如布尔查询、地理距离过滤、正则表达式过滤等。以下是一个使用正则表达式过滤的示例:

$results = App\MyModel::search('*')
    ->whereRegexp('name.raw', 'A.+')
    ->get();

3.2 零停机迁移

在需要更改索引映射时,可以使用零停机迁移功能。首先,确保你的索引配置器使用了 ScoutElastic\Migratable 特性:

namespace App;

use ScoutElastic\IndexConfigurator;
use ScoutElastic\Migratable;

class MyIndexConfigurator extends IndexConfigurator
{
    use Migratable;

    protected $name = 'my_index';
}

然后,运行迁移命令:

php artisan elastic:migrate-model "App\MyModel" my_index_v2

4. 典型生态项目

4.1 Elastic Scout Driver

Elastic Scout Driver 是一个通用的 Elasticsearch 驱动,适用于需要简单搜索功能的 Laravel 应用。

4.2 Elastic Scout Driver Plus

Elastic Scout Driver PlusElastic Scout Driver 的扩展,提供了更多高级功能,如布尔查询、高亮显示等。

4.3 Elastic Migrations

Elastic Migrations 是一个用于管理 Elasticsearch 索引模式的工具,类似于 Laravel 的数据库迁移功能。

通过这些生态项目,你可以构建一个完整的 Elasticsearch 搜索解决方案,满足各种复杂搜索需求。

热门项目推荐

项目优选

收起
Python-100-DaysPython-100-Days
Python - 100天从新手到大师
Python
603
114
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
205
55
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
59
48
RuoYi-Cloud-Vue3RuoYi-Cloud-Vue3
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
44
29
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
286
77
Ffit-framework
面向全场景的 Java 企业级插件化编程框架,支持聚散部署和共享内存,以一切皆可替换为核心理念,旨在为用户提供一种灵活的服务开发范式。
Java
112
13
yolo-onnx-javayolo-onnx-java
Java开发视觉智能识别项目 纯java 调用 yolo onnx 模型 AI 视频 识别 支持 yolov5 yolov8 yolov7 yolov9 yolov10,yolov11,paddle ,obb,seg ,detection,包含 预处理 和 后处理 。java 目标检测 目标识别,可集成 rtsp rtmp,车牌识别,人脸识别,跌倒识别,打架识别,车牌识别,人脸识别 等
Java
7
0
cjoycjoy
a fast,lightweight and joy web framework
Cangjie
10
2
frogfrog
这是一个人工生命试验项目,最终目标是创建“有自我意识表现”的模拟生命体。
Java
7
0
mdmd
✍ WeChat Markdown Editor | 一款高度简洁的微信 Markdown 编辑器:支持 Markdown 语法、色盘取色、多图上传、一键下载文档、自定义 CSS 样式、一键重置等特性
Vue
111
25