https://github.com/pinkeen/nimbleelasticbundle

Simple elasticsearch integration for Symfony
https://github.com/pinkeen/nimbleelasticbundle

Last synced: about 2 months ago
JSON representation

Simple elasticsearch integration for Symfony

• Host: GitHub
• URL: https://github.com/pinkeen/nimbleelasticbundle
• Owner: pinkeen
• Created: 2015-04-05T23:16:30.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2019-02-20T16:31:08.000Z (almost 6 years ago)
• Last Synced: 2024-11-17T12:49:39.889Z (about 2 months ago)
• Language: PHP
• Size: 72.3 KB
• Stars: 1
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
NimbleElasticBundle

===================

[![Scrutinizer](https://scrutinizer-ci.com/g/NimbleCo/NimbleElasticBundle/badges/quality-score.png)](https://scrutinizer-ci.com/g/NimbleCo/NimbleElasticBundle/)

[![SensioLabsInsight](https://insight.sensiolabs.com/projects/c542fed2-84e7-4516-ae24-85b873c574b7/mini.png)](https://insight.sensiolabs.com/projects/c542fed2-84e7-4516-ae24-85b873c574b7)

A simple bundle that integrates _elasticsearch_ into your _Symfony_ project using the official

[elasticsearch PHP client](https://github.com/elastic/elasticsearch-php).

## Why another _elasticsearch_ bundle?

Most ES bundles I found assume that one entity is one ES document. This is very limiting, as very often

denormalization is needed with more complex data. Your domain model does not need to be reflected in your

elasticsearch mapping.

Also the most popular bundle does not give you an easy way to update the "master" document when any of your

child entities change. This should be simple with this bundle.

This bundle directly exposes the official _elasticsearch_ `Client` without wrapping it too much. I don't see

much reason (besides rudimentary error checking) for using any query builders when most queries can be built

dynamically as array and serialized to JSON directly.

This bundle provides only basic functionalities, which means you will have to write more code, but gives you

flexiblity in return. For example:

* A mechanism for synchronizing your entities with ES is provided (doctrine listeners or you have to dispatch

create/update/delete events manually).

* A mechanism for transforming your entities into ES documents is provided but you have to write the actual 

transformer yourself. This is better for performance and a must if you want flexibility. It also allows you 

completetly decouple the ES from your model (no unnecessary getters needed on your entities, yay!).

* No mechnanism for automagically transforming ES results back into your entities will be ever provided 

(probably), because this would seriously limit the flexibility. Usually you could implement this yourself in 

a few lines, with your performance considerations in mind.

It will have great docs. ;)

## Installation

The usual [Symfony stuff](http://symfony.com/doc/current/cookbook/bundles/installation.html).

The **composer.json** needs: `"nimble/elastic-bundle": "dev-master@dev",`.

The **AppKernel.php** needs: `new Nimble\ElasticBundle\NimbleElasticBundle(),`.