vae/php-elasticsearch-orm

Adapt the orm query method of elasticsearch for >=php7.4

v1.0.6 2023-09-06 08:01 UTC

Requires

• php: >=7.4
• elasticsearch/elasticsearch: ^7.0
• illuminate/support: ^5.3|^6.0|^7.0|^8.0|^9.0|^10.0
• ramsey/uuid: ^4.1

Requires (Dev)

• phpunit/phpunit: ^9.4
• symfony/var-dumper: ^5.2

MIT

• vae

README

Install

composer require vae/php-elasticsearch-orm

Support Elasticsearch Version

more than 7.0

Use

PHP

    //require elasticsearch config
    $config = require "elasticsearch.php";
    //instance
    $builder = Factory::builder($config);

Laravel framework

Add the service provider config in config/app.php

    'providers' => [
        Vae\PhpElasticsearchOrm\Laravel\ElasticsearchOrm\OrmProvider::class,
    ] 

Use in Code

    $builder = app(\Vae\PhpElasticsearchOrm\Builder::class);

Hyperf framework

Use in Code

OrmElasticsearchClientFactory

    use \Vae\PhpElasticsearchOrm\Builder;
    use \Vae\PhpElasticsearchOrm\Query;
    use \Vae\PhpElasticsearchOrm\Grammar;
    class OrmElasticsearchClientFactory{
        public static function builder()
        {
            // 如果在协程环境下创建，则会自动使用协程版的 Handler，非协程环境下无改变
            $hyperfBuilder = ApplicationContext::getContainer()->get(ClientBuilderFactory::class)->create();
            $client = $hyperfBuilder->setHosts(['http://127.0.0.1:9200'])->build();
            return new Builder(new Query(new Grammar(), $client));
        }
    }

Quickstart

Create

    $builder->index('index')->create(['key' => 'value']);
    //return collection
    $builder->index('index')->createCollection(['key' => 'value']);

Batch Create

    $builder->index('index')->batchCreate(
        [
            'key1' => 'v1',
            'key2' => 'v2',
        ],
        [
            'key3' => 'v3',
            'key4' => 'v4',
        ]       
    );

Update

    $builder->index('index')->update(['key' => 'value']);
    $builder->index('index')->update(['key' => ['key2' => 'value']]);

Batch Update Or Update

    $builder->index('index')->batchUpdateOrCreate(
        [
            'id' => '1', 
            'key1' => 'v1',
            'key2' => 'v2',
        ],
        [
            'id' => 2,
            'key3' => 'v3',
            'key4' => 'v4',
        ]       
    );

deleteById

    $builder->index('index')->deleteById($id) : bool

delete

    $builder->index('index')->delete()

Select

    //select one
    $builder->index('index')->first();
    //select all
    $builder->index('index')->get();
    //select with paginate
    $builder->index('index')->paginate($page, $size) : Collection
    //select by id
    $builder->byId($id) : stdClass
    //select by id if failed throw error
    $builder->byIdOrFail($id) : stdClass
    //select chunk
    $builder->chunk(callback $callback, $limit = 2000, $scroll = '10m')

Count

    $builder->count() : int

Condition

whereTerm

    $builder->whereTerm('key', 'value');

whereLike（wildcard）

    //value without add wildcard '*'
    $builder->whereLike('key', 'value');

match

    $builder->whereMatch('key', 'value');

range

    $builder->whereBetween('key', ['value1', 'value2']);

where in

    $builder->whereIn('key', ['value1', 'value2', ...]);

nestedQuery

    $builder->where(function(Builder $query){
        $query->whereTerm('key', 'value');
    });

search nested data

    $nestedColumn = "nested_column";
    $builder->whereNested($nestedColumn, function ($query) {
        $query->where('key1', 'value1')
        $query->where('key2', 'value2')
    });

    $nestedKey = "nested_key";
    $key = "key";
    $builder->where("{$nestedKey}@{$key}", '=', 'value');

Where Support Operator

['=' => 'eq','>' => 'gt','>=' => 'gte','<' => 'lt','<=' => 'lte','!=' => 'ne',]

    $builder->where('key', '=', 'value');

More

see file Vae\PhpElasticsearchOrm\Builder