xskit/hyperf-scout-elasticsearch

Elasticsearch client for hyperf

2.1.4 2021-01-26 09:33 UTC

Requires

• php: >=7.2
• elasticsearch/elasticsearch: 6.*
• hyperf/guzzle: 2.1.*

Requires (Dev)

• guzzlehttp/ringphp: ~1.0
• phpunit/phpunit: ^9.4
• swoole/ide-helper: dev-master

MIT

• php
• elasticsearch
• swoole

README

Elasticsearch version >= 6 < 7

功能

配置

发布配置文件

php bin/hyperf vendor:publish xskit/hyperf-scout-elasticsearch

命令行工具

索引配置

php bin/hyperf elastic:create-index "App\MyIndexConfigurator"

执行该命令后，您将找到该文件 MyModel.php

<?php

namespace App;

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

class MyModel extends Model
{
    use Searchable;

    protected $indexConfigurator = MyIndexConfigurator::class;

    protected $searchRules = [
        //
    ];

    // Here you can specify a mapping for model fields
    protected $mapping = [
        'properties' => [
            'title' => [
                'type' => 'text',
                // Also you can configure multi-fields, more details you can find here https://www.elastic.co/guide/en/elasticsearch/reference/current/multi-fields.html
                'fields' => [
                    'raw' => [
                        'type' => 'keyword',
                    ]
                ]
            ],
        ]
    ];
}

索引 mapping

php bin/hyperf elastic:update-mapping MyModel

使用

基本搜索使用示例:

// set query string
App\MyModel::search('phone')
    // specify columns to select
    ->select(['title', 'price'])
    // filter 
    ->where('color', 'red')
    // sort
    ->orderBy('price', 'asc')
    // collapse by field
    ->collapse('brand')
    // set offset
    ->from(0)
    // set limit
    ->take(10)
    // get results
    ->get();

如果你只需要一个查询匹配的数量，使用计数方法:

App\MyModel::search('phone') 
    ->count();

稍后更新...