gbprod/elasticsearch-dataprovider-bundle

Bundle that can easily provide data in elasticsearch indices with Symfony

Elasticsearch dataprovider bundle

, _(*1)

I will not maintain this bundle anymore, prefer elastica-provider-bundle., _(*2)

Bundle that can easily provide data in elasticsearch indices with Symfony using M6Web elasticsearch bundle., _(*3)

, _(*4)

, _(*5)

Installation

Download bundle using composer :, _(*6)

composer require gbprod/elasticsearch-dataprovider-bundle

Declare in your app/AppKernel.php file:, _(*7)

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        new M6Web\Bundle\ElasticsearchBundle\M6WebElasticsearchBundle(),
        new GBProd\ElasticsearchDataProviderBundle\ElasticsearchDataProviderBundle(),
    );
}

Usage

Configure Elasticsearch clients

See M6WebElasticsearchBundle for configuring clients., _(*8)

Create a Data Provider

<?php

namespace GBProd\AcmeBundle\DataProvider;

use GBProd\ElasticsearchDataProviderBundle\DataProvider\BulkDataProvider;

class SuperHeroDataProvider extends BulkDataProvider
{
    protected function populate()
    {
        $this->index(
            'Spider-Man', // id of the document
            [
                "name" => "Spider-Man",
                "description" => "Bitten by a radioactive spider, high school student Peter Parker gained the speed, strength and powers of a spider. Adopting the name Spider-Man, Peter hoped to start a career using his new abilities. Taught that with great power comes great responsibility, Spidey has vowed to use his powers to help people.",
            ]
        );

        $this->update(
            'Hulk',
            [
                "name" => "Hulk",
                "description" => "Caught in a gamma bomb explosion while trying to save the life of a teenager, Dr. Bruce Banner was transformed into the incredibly powerful creature called the Hulk. An all too often misunderstood hero, the angrier the Hulk gets, the stronger the Hulk gets.",
            ]
        );

        $this->create(
            'Thor',
            [
                "name" => "Thor",
                "description" => "As the Norse God of thunder and lightning, Thor wields one of the greatest weapons ever made, the enchanted hammer Mjolnir. While others have described Thor as an over-muscled, oafish imbecile, he's quite smart and compassionate.  He's self-assured, and he would never, ever stop fighting for a worthwhile cause.",
            ]
        );

        $this->delete('Captain America');
    }

    public function count()
    {
        return 4;
    }
}

Register your provider

# AcmeBundle/Resources/config/services.yml

services:
    acme_bundle.superhero_dataprovider:
        class: GBProd\AcmeBundle\DataProvider\SuperHeroDataProvider
        tags:
            - { name: elasticsearch.dataprovider, index: app, type: superheros }

Provide

php app/console elasticsearch:provide app superheros

You also can provide a full index:, _(*9)

php app/console elasticsearch:provide app

Or run all providers:, _(*10)

php app/console elasticsearch:provide

You can set a specific client to use (if not default):, _(*11)

php app/console elasticsearch:provide app superheros --client=my_client

Example using doctrine

<?php

namespace GBProd\AcmeBundle\DataProvider;

use GBProd\ElasticsearchDataProviderBundle\DataProvider\BulkDataProvider;
use Doctrine\ORM\EntityManager;

class SuperHeroDataProvider extends BulkDataProvider
{
    private $em;

    public function __construct(EntityManager $em)
    {
        $this->em = $em;
    }

    protected function populate()
    {
        $query = $this->em->createQuery('SELECT s FROM AcmeBundle\Model\SuperHero s');

        $results = $query->iterate();
        foreach ($results as $row) {
            $this->index(
                $row[0],
                [
                    "name" => $row[0],
                    "description" => $row[1],
                ]
            );

            $this->em->detach($row[0]);
        }
    }

    public function count()
    {
        $query = $this->em
            ->createQuery('SELECT COUNT(s.id) FROM AcmeBundle\Model\SuperHero s')
        ;

        return $query->getSingleScalarResult();
    }
}

# AcmeBundle/Resources/config/services.yml

services:
    acme_bundle.superhero_dataprovider:
        class: GBProd\AcmeBundle\DataProvider\SuperHeroDataProvider
        arguments:
            - '@doctrine.orm.entity_manager'
        tags:
            - { name: elasticsearch.dataprovider, index: app, type: superheros }

Changing bulk size

Bulk size is important when providing data to elasticsearch. Take care of your nodes setting a good bulk size. Default bulk size is 1000, you can change setting the bulk entry of the tag., _(*12)

# AcmeBundle/Resources/config/services.yml

services:
    acme_bundle.superhero_dataprovider:
        class: GBProd\AcmeBundle\DataProvider\SuperHeroDataProvider
        calls:
            - ['changeBulkSize', 42]
        tags:
            - { name: elasticsearch.dataprovider, index: app, type: superheros }

Or directly inside a provider., _(*13)

<?php

namespace GBProd\AcmeBundle\DataProvider;

use GBProd\ElasticsearchDataProviderBundle\DataProvider\BulkDataProvider;

class SuperHeroDataProvider extends BulkDataProvider
{
    public function __construct()
    {
        $this->changeBulkSize(42);
    }

    protected function populate()
    {
        // ...
    }
}

About count method

This is not mandatory to implements count method but it allows you to have a pretty progressbar while provider is running., _(*14)

<?php

namespace GBProd\AcmeBundle\DataProvider;

use GBProd\ElasticsearchDataProviderBundle\DataProvider\BulkDataProvider;

class SuperHeroDataProvider extends BulkDataProvider
{
    protected function populate()
    {
        // ...
    }

    public function count()
    {
        return 2;
    }
}