FOSElasticaBundle/Resources/doc/setup.md

Step 1: Setting up the bundle

A) Install FOSElasticaBundle

FOSElasticaBundle is installed using Composer.

$ php composer.phar require friendsofsymfony/elastica-bundle "~3.0"

Elasticsearch

Instructions for installing and deploying Elasticsearch may be found here.

B) Enable FOSElasticaBundle

Enable FOSElasticaBundle in your AppKernel:

<?php
// app/AppKernel.php

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

C) Basic Bundle Configuration

The basic minimal configuration for FOSElasticaBundle is one client with one Elasticsearch index. In almost all cases, an application will only need a single index. An index can be considered comparable to a Doctrine Entity Manager, where the index will hold multiple type definitions.

#app/config/config.yml
fos_elastica:
    clients:
        default: { host: localhost, port: 9200 }
    indexes:
        search: ~

In this example, an Elastica index (an instance of Elastica\Index) is available as a service with the key fos_elastica.index.search.

If the Elasticsearch index name needs to be different to the service name in your application, for example, renaming the search index based on different environments.

#app/config/config.yml
fos_elastica:
    indexes:
        search:
            index_name: search_dev

In this case, the service fos_elastica.index.search will be using an Elasticsearch index of search_dev.

D) Defining index types

By default, FOSElasticaBundle requires each type that is to be indexed to be mapped. It is possible to use a serializer to avoid this requirement. To use a serializer, see the serializer documentation

An Elasticsearch type needs to be defined with each field of a related PHP object that will end up being indexed.

fos_elastica:
    indexes:
        search:
            types:
                user:
                    mappings:
                        username: ~
                        firstName: ~
                        lastName: ~
                        email: ~

Each defined type is made available as a service, and in this case the service key is fos_elastica.index.search.user and is an instance of Elastica\Type.

FOSElasticaBundle requires a provider for each type that will notify when an object that maps to a type has been modified. The bundle ships with support for Doctrine and Propel objects.

Below is an example for the Doctrine ORM.

                user:
                    mappings:
                        username: ~
                        firstName: ~
                        lastName: ~
                        email: ~
                    persistence:
                        # the driver can be orm, mongodb or propel
                        # listener and finder are not supported by
                        # propel and should be removed
                        driver: orm
                        model: Acme\ApplicationBundle\Entity\User
                        provider: ~
                        listener:
                            immediate: ~
                        finder: ~

There are a significant number of options available for types, that can be found here

E) Populating the Elasticsearch index

When using the providers and listeners that come with the bundle, any new or modified object will be indexed automatically. In some cases, where the database is modified externally, the Elasticsearch index must be updated manually. This can be achieved by running the console command:

$ php app/console fos:elastica:populate

The command will also create all indexes and types defined if they do not already exist on the Elasticsearch server.

F) Usage

Usage documentation for the bundle is available here