almeida/laravel-elasticsearch

Laravel 4.2+ wrapper for ElasticSearch

0.2.0 2015-04-10 13:50 UTC

Requires

• php: >=5.4.0
• elasticsearch/elasticsearch: 1.1.*
• illuminate/support: 4.2.*
• league/fractal: 0.11.*

MIT

• Arnold Almeida

• elasticsearch
• laravel

README

Preamble

I need to improve search. Currently using mongob, 2dspheres etc.

Bring on Elasticsearch. Basically just a wrapper for the offical client.

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

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.

Let's assume we are working with movies.

/**
 * 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.

Assuming you have already a working fractal/transformer

	$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.

	$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.

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

Todo

• think about this more

• Move search, stats, and aggerates to Traits so we only use them on applicable documents

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

This fixed it for now...

• 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

Will work it out when i sort out nicer config etc.

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 ?

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

Monitoring elasticsearch using Marvel (dev)

https://www.elastic.co/downloads/marvel

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].

They should too! Come on its going to be a thing.

LICENSE

MIT