README

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

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

安装

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

如果您还没有安装 Laravel Scout，请在项目中安装它，并将 Laravel\Scout\Searchable 特性应用于您想要使其可搜索的任何 Eloquent 模型。

通过 Composer 安装此包

composer require yab/laravel-scout-mysql-driver

接下来，将 ServiceProvider 添加到 config/app.php 文件中的包服务提供商

        /*
         * 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() 查询。

两种模式下的搜索查询将包括模型的所有 FULLTEXT 兼容字段（从模型的 toSearchableArray() 方法返回的 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%')

控制台命令

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

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

创建索引

传递一个模型给命令以为模型的 FULLTEXT 兼容字段（从模型的 toSearchableArray() 方法返回的 CHAR、VARCHAR、TEXT）创建一个 FULLTEXT 索引。索引名称将是模型 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 需要 FULLTEXT 查询的搜索字符串长度至少为 4。有关更改此值的更多信息，请参阅 MySQL Full-Text Search Fine-Tuning 文档。
scout.mysql.min_fulltext_search_fallback - 当在 NATURAL_LANGUAGE 或 BOOLEAN 模式下搜索字符串的长度小于 scout.mysql.min_fulltext_search_length 时用作回退的 mode。可接受值是 LIKE 和 LIKE_EXPANDED。
scout.mysql.query_expansion - 如果设置为 true，则将在搜索查询中使用 MySQL 查询扩展。仅适用于使用 NATURAL_LANGUAGE 模式。有关更多信息，请参阅 MySQL Full-Text Searches with Query Expansion 文档。

airnox / laravel-scout-mysql-driver

维护者

详细信息