soeurngsar / laravel-scout-opensearch
OpenSearch 的 Laravel Scout 驱动程序
Requires
- php: ^8.1
- illuminate/support: ^9.0|^10.0
- laravel/framework: ^10.21.0
- laravel/scout: ^8.0|^9.0|^10.0
- opensearch-project/opensearch-php: ^2.0
- roave/better-reflection: ^6.14.0
- shyim/opensearch-php-dsl: ^1.0
This package is auto-updated.
Last update: 2024-09-30 01:43:42 UTC
README
该包提供了将 OpenSearch 集成到 Laravel 应用程序的完美起点。它经过精心设计,以简化在 Laravel 框架 中使用 OpenSearch。
它建立在最新的 Laravel Scout 版本之上,这是官方的 Laravel 搜索包。使用此包,您可以充分利用 Laravel Scout 的所有出色功能,同时利用 OpenSearch 的完整搜索体验。
特性
如果您喜欢这个包,请不要忘记 ⭐。🙏
- Laravel Scout 10.x 支持
- 在多个模型中搜索
- 零停机 重新导入 - 在生产环境中导入数据非常简单。
- 预加载关系 - 加速导入。
- 一次性导入所有可搜索的模型。
- 每个模型都有一套完全可配置的映射。
- 在查询中充分利用 OpenSearch 的全部功能。
要求
- PHP 版本 >= 8.1
- Laravel 框架版本 >= 10.0.0
安装
使用 composer 安装包
composer require soeurngsar/laravel-scout-opensearch
设置环境变量
SCOUT_DRIVER=SoeurngSar\LaravelScoutOpenSearch\Engines\OpenSearchEngine
该包使用官方包中的 \OpenSearch\Client
,但不会尝试配置它,因此您可以在应用程序服务提供程序中自由配置。但如果你现在不想这么做,你可以使用包中的 SoeurngSar\OpenSearchServiceProvider
。将提供程序添加到 config/app.php
'providers' => [ // Other Service Providers \SoeurngSar\LaravelScoutOpenSearch\Providers\OpenSearchServiceProvider::class ],
设置 OPENSEARCH_HOST
环境变量
OPENSEARCH_HOST=host:port
或使用逗号作为分隔符来指定附加节点
OPENSEARCH_HOST=host:port,host:port
OPENSEARCH_HOST_PROVIDER=local or aws
并发布 Elasticsearch 的配置示例 php artisan vendor:publish --tag config
使用
这两个包的所有功能都可以使用。对于此应用程序的使用,我建议您查看 matchish/laravel-scout-elasticsearch 的文档,因为它与干净文档完全兼容。
许可证
Laravel Scout OpenSearch 是一个开源软件,许可证为 MIT 许可证。
致谢
此包是 matchish/laravel-scout-elasticsearch 和 cloudmediasolutions/Laravel-Scout-OpenSearch 的结合。我非常感激他们的辛勤工作,将此包带给社区。