setup.md

Step 1: Setting up the bundle

A: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require friendsofsymfony/elastica-bundle

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Elasticsearch

Instructions for installing and deploying Elasticsearch may be found here.

B: Enable the Bundle

Then, enable the bundle by adding the following line in the config/bundles.php file of your project:

<?php

declare(strict_types=1);

return [
    ...
    FOS\ElasticaBundle\FOSElasticaBundle::class => ['all' => true],
    ...
];

C: Basic Bundle Configuration

The basic minimal configuration for FOSElasticaBundle is one client with one Elasticsearch index.

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

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

You may want the index app to be named something else on Elasticsearch depending on if your application is running in a different env or other conditions that suit your application. To set your customer index to a name that depends on the environment of your Symfony application, use the example below:

#app/config/config.yml
fos_elastica:
    indexes:
        app:
            index_name: app_%kernel.environment%

In this case, the service fos_elastica.index.app will relate to an Elasticsearch index that varies depending on your kernel's environment. For example, in dev it will relate to app_dev.

D: Defining indexes

By default, FOSElasticaBundle requires each index 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 index needs to be defined with each field of a related PHP object that will end up being indexed.

fos_elastica:
    indexes:
        user:
            properties:
                username: ~
                firstName: ~
                lastName: ~
                email: ~

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

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

Below is an example for the Doctrine ORM.

fos_elastica:
    indexes:
        user:
            persistence:
                # the driver can be orm, mongodb or phpcr
                driver: orm
                model: Acme\ApplicationBundle\Entity\User
                provider: ~
                finder: ~
            properties:
                username: ~
                firstName: ~
                lastName: ~
                email: ~

There are a significant number of options available for indexes, 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 bin/console fos:elastica:populate

Note: Consider reading speed up populate command if you are going to deal with big data set.

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

F: Usage

Usage documentation for the bundle is available here