miquido/elasticsearch-dbal

Observable library

v1.0.0 2018-10-05 09:48 UTC

Requires

• php: ^7.2
• ext-json: *
• miquido/data-structure: ^1.0
• ruflin/elastica: ^5.2.1|^6.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.13
• mockery/mockery: ^1.1
• phpstan/phpstan: ^0.10.3
• phpstan/phpstan-mockery: ^0.10.2
• phpstan/phpstan-phpunit: ^0.10.0
• phpunit/phpunit: ^7.0
• spatie/phpunit-snapshot-assertions: ^1.3

MIT

• Paweł Kocot
• Konrad Obal

• php
• elasticsearch

README

Elasticsearch DBAL

Wrapper for https://github.com/ruflin/Elastica

• Installation guide
• Code Samples
• Contributing

Installation

Use Composer to install the package:

composer require miquido/elasticsearch-dbal

Code Samples

• Initialize DBAL object
• Count documents
• Search documents
• SearchResult and Document objects
• Create new documents
• Update documents
• Delete documents

Initialize DBAL object

Miquido\Elasticsearch\DBAL requires Elastica\Type object:

<?php

use Miquido\Elasticsearch\DBAL;

$client = new \Elastica\Client();
$type = $client->getIndex('index_name')->getType('type_name');

$dbal = new DBAL($type);

Count documents

<?php

$dbal->countAll(); // count all documents in the type
$dbal->count(new \Elastica\Query(new \Elastica\Query\Terms('field_name', [1, 2, 3]))); // count documents matching query

Search documents

<?php

use Miquido\Elasticsearch\DBAL;

$dbal = new DBAL($type);

$query = new \Elastica\Query(new \Elastica\Query\Terms('field_name', [1, 2, 3]));

$dbal->search($query); // returns 10 documents (default ElasticSearch setting)
$dbal->searchAll($query); // returns all documents (uses scroll api)
$dbal->findOne($query);
$dbal->findByIds('id1', 'id2', 'id2');

SearchResult and Document objects

search(), searchAll() and findByIds() methods return instance of Miquido\Elasticsearch\Result\SearchResultInterface

findOne() method returns instance of Miquido\Elasticsearch\Document\DocumentInterface

Please also check miquido/data-structure library for more details about classes used inside Documents objects.

<?php

use Miquido\Elasticsearch\DBAL;

$dbal = new DBAL($type);

$result = $dbal->search(new \Elastica\Query(new \Elastica\Query\MatchAll()));
$result->count(); // returns number of documents in result
$result->getTotalHits(); // returns number of documents matching the query
$result->getTime(); // returns time of the query
$result->getDocuments()->getAll(); // returns instances of Documents 
$result->getDocuments()->getData(); // returns instance of Miquido\DataStructure\Map\MapCollectionInterface 

$document = $dbal->findOne(new \Elastica\Query());
$document->getId(); // string
$document->getData(); // returns instance of Miquido\DataStructure\Map\MapInterface  

Create new documents

<?php

use Miquido\Elasticsearch\DBAL;
use Miquido\Elasticsearch\Document\Document;
use Miquido\DataStructure\Map\Map;

$dbal = new DBAL($type);
$dbal->add(new Document(
    null /* or string if you want to choose your own ID */, 
    new Map([
        'name' => 'John',
        'surname' => 'Smith',
        'age' => 40,
    ]))
);

// you can also add many documents at once
$dbal->bulkAdd($document1, $document2, ...);

Update documents

<?php

use Miquido\Elasticsearch\DBAL;
use Miquido\Elasticsearch\Document\Document;
use Miquido\DataStructure\Map\Map;

$dbal = new DBAL($type);

// this method will only update 'age' field in document with ID 'documentId'
$dbal->updatePatch(new Document('documentId', new Map([
    'age' => 41,
])));

// you can also add many documents at once
$dbal->bulkUpdatePatch($document1, $document2, ...);

Delete documents

<?php

use Miquido\Elasticsearch\DBAL;

$dbal = new DBAL($type);
$dbal->deleteByIds('id1', 'id2', 'id3');

Contributing

Pull requests, bug fixes and issue reports are welcome. Before proposing a change, please discuss your change by raising an issue.