FOSElasticaBundle Documentation

FOSElasticaBundle provides integration between Symfony and Elasticsearch (or the Elastica library). Key capabilities include:

• Elastica Integration: Integrates the Elastica library directly into the Symfony environment.
• Serialization: Uses JmsSerializer or Symfony Serializer to handle conversion between PHP objects and Elasticsearch data.
• Index Configuration: Supports explicit index configuration for Elasticsearch or allows for dynamic mapping by sending data without predefined configuration.
• Automatic Indexing: Provides Doctrine event listeners to automatically index data when Doctrine entities are modified.

Version 5.0 introduced several new capabilities:

• Asynchronous Updates: Added an asynchronous index update option.
• Index Management: Added the ability to close an index.
• Security: Added support for HTTP authentication.
• Paginator API:
  • Added PaginatedFinderInterface::createRawPaginatorAdapter.
  • Added PaginatorAdapterInterface::getMaxScore.

By default, FOSElasticaBundle subscribes to Doctrine events (insert, update, remove) to synchronize the Elasticsearch index during the HTTP request. This can increase response times or cause application failures if the Elasticsearch server is unavailable.

The Doctrine queue listener improves performance and fault tolerance by moving the synchronization work to a background process. Instead of performing the index update immediately, the listener sends a message to a message queue (via EnqueueBundle), which a background worker then processes to perform the actual synchronization.

When configuring multiple hosts, you can choose a connection_strategy to manage how connections are handled. The bundle supports the following strategies (defined in the Elastic\Transport\NodePool namespace):

• RoundRobin: Distributes requests across available hosts in a rotating fashion.
• RoundRobinNoResurrect: A variation of Round Robin.
• Simple: A basic connection strategy.

These strategies are used to interact with Elasticsearch clusters effectively.

You can accelerate the fos:elastica:populate command by offloading the population tasks to AWS SQS queues. This is achieved by implementing a custom pager-persister that pushes population tasks into SQS instead of executing them synchronously. This allows you to use multiple consumer processes to process the queue in parallel.

Prerequisites

• An AWS IAM user with access to SQS.
• Two AWS SQS queues: one for the population tasks (e.g., acme_fos_elastica_populate) and one for the reply queue (e.g., acme_fos_elastica_populate_reply_queue).
• The following composer packages installed:
  • enqueue/elastica-bundle
  • enqueue/sqs

$ composer require enqueue/elastica-bundle
$ composer require enqueue/sqs

For complex applications requiring multiple search methods, you can use dedicated repository classes. The fos_elastica.manager (a RepositoryManagerInterface) handles these repositories.

By default, the manager handles ORM entities. If you are using MongoDB, you must specify the default manager in your configuration:

fos_elastica:
    default_manager: mongodb

To use a repository, inject the fos_elastica.manager and call getRepository('Bundle:Entity').

If Symfony autoconfigure is disabled, you must manually register your event subscriber in your service configuration to ensure it listens to PostTransformEvent.

acme.listener.custom_property:
    class: AcmeBundle\EventListener\CustomPropertyListener
    tags:
        - { name: kernel.event_subscriber }