gbprod/elastica-bundle

Really simple bundle to use Elastica within Symfony applications

ElasticaBundle

, _(*1)

, _(*2)

Really simple bundle to use elastica within Symfony applications. Allows you to create elastica service in Symfony application. The aim is to create a ligthweigth alternative to FOSElasticaBundle, because sometimes, we don't need all that stuffs., _(*3)

Installation

Download bundle using composer :, _(*4)

composer require gbprod/elastica-bundle

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

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new GBProd\ElasticaBundle\ElasticaBundle(),
        // ...
    );
}

Configuration

Clients

# app/config/config.yml
elastica:
    clients:
        default:
            host: 127.0.0.1
            port: 9200
        other_client:
            host: 127.0.0.1
            port: 9201

If using a cluster:, _(*6)

# app/config/config.yml
elastica:
    clients:
        default:
            connections:
                - { host: localhost, port: 9200 }
                - { host: localhost, port: 9201 }

Available options: host, port, path, url, proxy, transport, persistent, timeout and proxy, _(*7)

Custom logger

By default, this bundle logs queries using the Symfony's default logger (@logger) into an elastica channel., _(*8)

You can use a customized logger with the logger configuration option:, _(*9)

# app/config/config.yml
elastica:
    logger: my_custom_logger_service_id
    clients:
        default:
            host: 127.0.0.1
            port: 9200

Usage

You can now use service elastica.default_client or elastica.my_other_client, _(*10)

$client = $container->get('elastica.default_client');

Services autowiring support

Symfony 3.3 have introduced support for services autowiring. To be able to autowire Elastica connection into your services you need to setup your client configuration with a name default. In a case if you have multiple connections - only default connection will be enabled for autowiring because services autowiring is resolved by class names., _(*11)

Autowiring support is enabled by default, but if you need to disable it for some reason - you can do it by set autowire: false parameter:, _(*12)

# app/config/config.yml
elastica:
    autowire: false
    clients:
        default:
            host: 127.0.0.1
            port: 9200

Tests

Clone this repository (or a fork). You should have php>=5.6 and composer installed., _(*13)

make test-unit

Contributing

Feel free to contribute, see CONTRIBUTING.md file for more informations., _(*14)