guandeng/elasticsearch

A component for elasticsearch

dev-main 2024-06-05 06:12 UTC

Requires

• php: >=8.1
• elasticsearch/elasticsearch: ^7.12
• hyperf/guzzle: ~3.1.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• hyperf/collection: ~3.1.0
• hyperf/command: ~3.1.0
• hyperf/di: ~3.1.0
• hyperf/pool: ~3.1.0
• hyperf/utils: ~3.1.0
• phpstan/phpstan: ^0.12

MIT

• guandeng

README

A component for elasticsearch

Installation

composer require guandeng/elasticsearch

Publish configure

php bin/hyperf.php vendor:publish guandeng/elasticsearch

Usage

Index

• Create

namespace App\Indices;

use Guandeng\Elasticsearch\Index\AbstractIndex;

class Test extends AbstractIndex
{
    protected $index = 'test';
}

• Create by command

php bin/hyperf.php gen:index test

• Query

use App\Indices\Test;

Test::query()->where(...)->search();

• UpdateByQuery

use App\Indices\Test;

Test::query()->where(...)->script(['source' => 'ctx.source.xxx = value'])->updateByQuery();

• Count

use App\Indices\Test;

Test::query()->where(...)->count();

Migrate

• Index

namespace App\Indices;

use Guandeng\Elasticsearch\Index\AbstractIndex;

class Test extends AbstractIndex
{
    protected $index = 'test';
    protected $type = '_doc';
    protected $settings = [
        // your settings
    ];
    protected $properties = [
        // your properties
    ];

    public function getMigration(): Closure
    {
        return function ($index) {
            // migrate data
        };
    }
}

• Run migrate

php bin/hyperf.php elasticsearch:migrate "App\\Indices\\Test" [--migrate] [--update] [--recreate]

ClientProxy

namespace App\Proxy;

use Guandeng\Elasticsearch\ClientProxy;

class FooClient extends ClientProxy
{
    protected $poolName = 'foo';
}