1 Star 0 Fork 0

kinchuam/laravel-scout-elasticsearch

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
kinchuam u 049d698 2年前
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

laravel-scout-elasticsearch

Elasticsearch Driver for Laravel Scout


Installation

You can install the package via composer:

composer require kinch/laravel-scout-elasticsearch:"^2.0"

Setting up Elasticsearch configuration

vendor:publish

php artisan vendor:publish --provider="Kinch\LaravelScoutElasticsearch\LaravelScoutElasticsearchServiceProvider"

After you've published the Laravel Scout package configuration, you need to set your driver to elasticsearch and add its configuration:

// config/elasticsearch.php
<?php

return [
    'host' => env('ELASTICSEARCH_HOST'),
    'user' => env('ELASTICSEARCH_USER'),
    'password' => env('ELASTICSEARCH_PASSWORD'),
    'cert' => storage_path(env('ELASTICSEARCH_CERT')),

    'cloud_id' => env('ELASTICSEARCH_CLOUD_ID'),
    'api_key' => env('ELASTICSEARCH_API_KEY'),
    'queue' => [
        'timeout' => env('SCOUT_QUEUE_TIMEOUT'),
    ],
    
    // index_ is followed by the index name
    'index_article' => [
        'settings' => [
            'number_of_shards' => 5,
            'number_of_replicas' => 1,
        ],
        'mappings' => [
            "properties" => [
                "title" => [
                    "type" => "text",
                    "analyzer" => "ik_max_word",
                    "search_analyzer" => "ik_smart",
                    "fields" => ["keyword" => ["type" => "keyword", "ignore_above" => 256]],
                ],
            ],
        ],
    ],
];

Usage

Set env variables

SCOUT_DRIVER=Kinch\LaravelScoutElasticsearch\Engines\ElasticsearchEngine
ELASTICSEARCH_HOST=host:port
ELASTICSEARCH_USER=elastic
ELASTICSEARCH_PASSWORD=
ELASTICSEARCH_CERT=certs/http_ca.crt

Set ELASTICSEARCH_HOST env variable

ELASTICSEARCH_HOST=host:port,host:port
console
// create index
php artisan scout:index article

// delete index
php artisan scout:delete-index article

// batch update data to es
php artisan scout:import "App\Models\Article"

search example
use App\Models\Article;

// $condition = "test";
// ... or
// $condition = [
//     "title" => "test",
//     "abstract" => "test"
// ];
// ... or
$keyword = "test";
$source = [1,2];
$startTime = '2023-05-01T00:00:00.000+0800';
$endTime = '2023-05-20T00:00:00.000+0800';
$condition = [
    "_customize_body" => 1,
    "bool" => [
        "should" => [
            [
                "match" => [
                    "title" => ["query" => $keyword, 'boost' => 5]
                ]
            ],
            [
                "match" => [
                    "abstract" => ["query" => $keyword, 'boost' => 3]
                ]
            ],
        ],
        "must" => [
            [
                "terms" => ["source" => $source]
            ],
            [
                "range" => [
                    "created_at" => [
                        'gte' => $startTime,
                        'lte' => $endTime
                    ]
                ]
            ]
        ]
    ],
     
];

$data = Article::search($condition)
        ->orderBy('_score', 'desc')
        ->paginate(10);

More please see Laravel Scout official documentation.

License

The MIT License (MIT).

The MIT License (MIT) Copyright (c) Taylor Otwell Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

laravel-scout-elasticsearch 展开 收起
PHP
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/kinchuam/laravel-scout-elasticsearch.git
git@gitee.com:kinchuam/laravel-scout-elasticsearch.git
kinchuam
laravel-scout-elasticsearch
laravel-scout-elasticsearch
master

搜索帮助