library laravel-elasticsearch

almeida/laravel-elasticsearch

Laravel 4.2+ wrapper for ElasticSearch

Preamble

I need to improve search. Currently using mongob, 2dspheres etc., _(*1)

Bring on Elasticsearch. Basically just a wrapper for the offical client., _(*2)

http://www.elastic.co/guide/en/elasticsearch/client/php-api/current/index.html, _(*3)

Afternoon hack

• Trying to put togeter a nice package so we can use ElasticSearch easily
• Should play well with league/fractal
• Should play well with illuminate/collections
• Should play well with fractal/item
• Should play well with fractal/resources
• etc..

Install via Composer

require : {
    "almeida/laravel-elasticsearch" : "dev-master"
}

Step 1

Extend the abstract ElasticDocument so you get some easy CRUD., _(*4)

Let's assume we are working with movies., _(*5)

/**
 * Acme\Search\MovieDocument
 */
class MovieDocument extends \Almeida\LaravelElasticSearch\ElasticDocumentAbstract
{
    protected $index = 'movie_cluster';

    protected $type = 'movies';

    public function setId($movie) {
        return $movie->id;
    }


}

Creating / Updating an index

Create an index., _(*6)

Assuming you have already a working fractal/transformer, _(*7)

    $options = [];
    $options['transformer'] = 'Acme\MovieTransformer';

    $document = new \Acme\Search\MovieDocument($options);
    $document->setBody($movie);
    $document->index();
    // or $document->create();
    // or $document->update();

    // OR
    $document = new \Acme\Search\MovieDocument();
    $document->setBody($movie);
    $document->setTransformer('Acme\MovieTransformer');
    $document->index();

Deleting an index (@todo)

Deleting an index., _(*8)

    $document = new \Acme\Search\MovieDocument();
    $document->delete($movie->id);

Indexing en masse in the Console

    $n = 0;

    Movie::chunk(100, function($movies) use(&$n) {

        foreach ($movies as $i => $movie) {

            $document = new \Acme\Search\MovieDocument();
            $document->setBody($movie);
            $document->setTransformer('Acme\MovieTransformer');
            $document->index();

            $this->info("Indexed : {$movie->title}");

            $n++;
        }
    });

    $this->info("Indexed [{$n}] movies");

Searching (WIP)

Promise to work on it over the next few days., _(*9)

    $movieTitle = 'Scarface';
    $document->basicSearch($movieTitle);

Todo

• think about this more, _(*10)

• Move search, stats, and aggerates to Traits so we only use them on applicable documents, _(*11)

GOTCHAS

Deving locally on OSX i couldnt get the client to connect to elasticsearch even though i could access it in the browser at http://localhost:9200, _(*12)

This fixed it for now..., _(*13)

• http://benjaminknofe.com/blog/2015/02/19/no-connection-on-localhost-to-elasticsearch-on-osx/

The correct way to access is actually through, http://127.0.0.1:9200, _(*14)

Will work it out when i sort out nicer config etc., _(*15)

Required reading

• http://www.elastic.co/guide/en/elasticsearch/guide/current/
• http://www.elastic.co/guide/en/elasticsearch/client/php-api/current/_quickstart.html

Relevance

How is it calculated ?, _(*16)

• http://www.elastic.co/guide/en/elasticsearch/guide/current/relevance-intro.html

Monitoring elasticsearch using Marvel (dev)

https://www.elastic.co/downloads/marvel, _(*17)

Thanks for the notes

• http://www.slideshare.net/bencorlett/discovering-elasticsearch
• http://blog.madewithlove.be/post/integrating-elasticsearch-with-your-laravel-app/
• http://blog.madewithlove.be/post/elasticsearch-aggregations/
• https://www.youtube.com/watch?v=waTWeJeFp4A
• https://www.youtube.com/watch?v=7FLXjgB0PQI
• http://laravel.com/docs/4.2/eloquent#model-observers
• https://www.youtube.com/watch?v=GrdzX9BNfkg

I accept bitcoin tips. [18tEqEUnyJaqvKh3CCNAAai9seztLb3Tw9]., _(*18)

They should too! Come on its going to be a thing., _(*19)

LICENSE

MIT, _(*20)