README

使用 MySQL 的 FULLTEXT 索引或 WHERE LIKE '%:search% 语句搜索 Eloquent 模型。

安装
用法
模式
控制台命令
配置

安装

注意：任何你打算使用此驱动程序进行搜索的模型都必须使用 MySQL MyISAM 或 InnoDB 表。

如果你还没有安装 Laravel Scout，你应该将 Laravel\Scout\Searchable 特性应用到任何你希望可以搜索的 Eloquent 模型上。

使用 Composer 安装此包

composer require yab/laravel-scout-mysql-driver

如果你的 Laravel 版本是 5.4，请将下面的 ServiceProvider 添加到 config/app.php 文件中的 Providers 数组

        /*
         * Package Service Providers...
         */
        Yab\MySQLScout\Providers\MySQLScoutServiceProvider::class,

将默认配置添加到 config/scout.php

    'mysql' => [
        'mode' => 'NATURAL_LANGUAGE',
        'model_directories' => [app_path()],
        'min_search_length' => 0,
        'min_fulltext_search_length' => 4,
        'min_fulltext_search_fallback' => 'LIKE',
        'query_expansion' => false
    ]

在 .env 文件中设置 SCOUT_DRIVER=mysql

请注意，此 Laravel Scout 驱动程序不需要在模型更改时更新索引，因为这是由 MySQL 本地处理的。因此，你可以安全地在 config/scout.php 中禁用队列。

    /*
    |--------------------------------------------------------------------------
    | Queue Data Syncing
    |--------------------------------------------------------------------------
    |
    | This option allows you to control if the operations that sync your data
    | with your search engines are queued. When this is set to "true" then
    | all automatic data syncing will get queued for better performance.
    |
    */

    'queue' => false,

此外，不需要使用 php artisan scout:import 命令。但是，如果你计划在 NATURAL_LANGUAGE 或 BOOLEAN 模式下使用此驱动程序，你应该首先运行提供的控制台命令以创建所需的 FULLTEXT 索引。

用法

只需在你的 Searchable 模型上调用 search() 方法

$beers = App\Drink::search('beer')->get();

或者使用分页

$beers = App\Drink::search('beer')->paginate(15);

可以使用 where() 构建器方法应用简单的约束（每个额外的 WHERE 将使用 AND 应用）。

$beers = App\Drink::search('beer')->where('in_stock', 1)->get();

以下运算符可以应用于 WHERE 语句：<> != = <= < >= >（如果没有指定运算符，将使用 =）

$beers = App\Drink::search('beer')->where('abv >', 10)->get();

有关更多信息，请参阅Laravel Scout 文档。

模式

此驱动程序可以执行不同类型的搜索查询，具体取决于在 Laravel 配置值 scout.mysql.mode 中设置的模式。目前支持 4 种不同的模式：NATURAL_LANGUAGE、BOOLEAN、LIKE 和 LIKE_EXPANDED。

NATURAL_LANGUAGE 和 BOOLEAN 模式

在 NATURAL_LANGUAGE 和 BOOLEAN 模式下，驱动程序将分别运行 MySQL 的 WHERE MATCH() AGAINST() 查询。

两种模式的搜索查询将包括从模型的 toSearchableArray() 方法返回的所有与模型兼容的 FULLTEXT 字段（CHAR、VARCHAR、TEXT）。对于这些字段需要有一个 FULLTEXT 索引。你可以使用提供的控制台命令创建此索引。

例如，在一个具有以下数据库结构的 POST 模型上运行搜索

在 NATURAL_LANGUAGE 模式下会产生以下查询

select * from `posts` where MATCH(content,meta) AGAINST(? IN NATURAL LANGUAGE MODE)

在 BOOLEAN 模式下会产生以下查询

select * from `posts` where MATCH(content,meta) AGAINST(? IN BOOLEAN MODE)

BOOLEAN 模式的运算符应该作为搜索字符串的一部分传递。

有关更多信息，请参阅MySQL 的全文搜索函数文档。

LIKE 和 LIKE_EXPANDED 模式

LIKE 和 LIKE_EXPANDED 模式将运行 WHERE LIKE %?% 查询，这将包含从 toSearchableArray() 返回的模型的所有字段。LIKE_EXPANDED 模式将使用搜索字符串中的每个单独的词来查询每个字段。

例如，对具有以下数据库结构的 Customer 模型进行搜索

在 LIKE 模式下将产生以下查询（给定搜索字符串 "John"）

SELECT * FROM `customers` WHERE (`id` LIKE '%John%' OR `first_name` LIKE '%John%' OR `last_name` LIKE '%JOHN%')

在 LIKE_EXPANDED 模式下将产生以下查询（给定搜索字符串 "John Smith"）

SELECT * FROM `customers` WHERE (`id` LIKE '%John%' OR `id` LIKE '%Smith%' OR `first_name` LIKE '%John%' OR `first_name` LIKE '%Smith%' OR `last_name` LIKE '%John%' OR `last_name` LIKE '%Smith%')

控制台命令

包含用于管理 FULLTEXT 索引的命令 php artisan scout:mysql-index {model?}，这些索引对于 NATURAL_LANGUAGE 和 BOOLEAN 模式是必需的。

如果省略了模型参数，则命令将运行所有具有 Laravel\Scout\Searchable 特性和 MySQL 连接的模型，这些模型在 Laravel 配置值 scout.mysql.model_directories 定义的目录中。

创建索引

传递一个模型给命令以创建一个针对模型的所有 FULLTEXT 兼容字段（CHAR、VARCHAR、TEXT）的 FULLTEXT 索引，这些字段来自模型的 toSearchableArray() 方法。索引名称将是模型 searchableAs() 方法的输出。

如果模型已存在索引并且模型包含不在现有索引中的新可搜索字段，则将删除并重新创建索引。

php artisan scout:mysql-index App\\Post

删除索引

传递 -D 或 --drop 选项来删除模型现有的索引。

php artisan scout:mysql-index App\\Post --drop

配置

可以通过修改 scout.mysql Laravel 配置值来更改行为。

scout.mysql.mode - 确定驱动程序如何运行搜索查询的模式。可接受值为 NATURAL_LANGUAGE、BOOLEAN、LIKE 和 LIKE_EXPANDED。
scout.mysql.model_directories - 如果未提供模型参数给包含的 php artisan scout:mysql-index 命令，则将在此处定义的目录中搜索具有 Laravel\Scout\Searchable 特性和 MySQL 连接的模型。
scout.mysql.min_search_length - 如果搜索字符串的长度小于此值，则不会运行搜索查询，并将返回空集合。
scout.mysql.min_fulltext_search_length - 如果使用 NATURAL_LANGUAGE 或 BOOLEAN 模式，并且搜索字符串的长度小于此值，则驱动程序将回退到默认模式。默认情况下，MySQL 要求搜索字符串长度至少为 4 才能运行 FULLTEXT 查询。有关更改此设置的信息，请参阅 MySQL 全文搜索优化文档。
scout.mysql.min_fulltext_search_fallback - 当 NATURAL_LANGUAGE 或 BOOLEAN 模式中的搜索字符串长度小于 scout.mysql.min_fulltext_search_length 时将用作回退模式的模式。可接受值为 LIKE 和 LIKE_EXPANDED。
scout.mysql.query_expansion - 如果设置为 true，则将在搜索查询中使用 MySQL 查询扩展。仅适用于 NATURAL_LANGUAGE 模式。有关更多信息，请参阅 MySQL 全文搜索与查询扩展文档。

derworth / laravel-scout-mysql-driver

维护者

详情