### Consume Queue Messages (Setup Broker)

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/doctrine-queue-listener.md

Run the enqueue:consume command with the --setup-broker flag to start processing messages from the queue. This is the recommended approach.

```bash
$ ./bin/console enqueue:consume --setup-broker -vvv 
```

--------------------------------

### Install EnqueueElasticaBundle and Filesystem Transport

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/doctrine-queue-listener.md

Install the necessary composer packages for EnqueueElasticaBundle and a message queue transport like the filesystem transport.

```bash
$ composer require enqueue/elastica-bundle:^0.8.1 enqueue/fs:^0.8
```

--------------------------------

### Install enqueue/elastica-bundle and enqueue/sqs

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/speed-up-populate-command-sqs.md

Install the necessary Composer packages for integrating FOS Elastica with AWS SQS via the enqueue bundle.

```bash
composer require enqueue/elastica-bundle
composer require enqueue/sqs
```

--------------------------------

### Implement PagerProviderInterface

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/manual-provider.md

Create a PHP class that implements the PagerProviderInterface and provides the 'provide' method to return a PagerInterface instance. This example uses Pagerfanta with an ArrayAdapter.

```php
<?php
namespace Acme\UserBundle\Provider;

use FOS\ElasticaBundle\Provider\PagerProviderInterface;
use FOS\ElasticaBundle\Provider\PagerfantaPager;
use FOS\ElasticaBundle\Provider\PagerInterface;
use Pagerfanta\Pagerfanta;
use Pagerfanta\Adapter\ArrayAdapter;

class UserPagerProvider implements PagerProviderInterface
{
    public function provide(array $options = []): PagerInterface
    {
        return new PagerfantaPager(new Pagerfanta(new ArrayAdapter([ /* an array of objects */ ])));
    }
}
```

--------------------------------

### Dynamic Templates Configuration

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/indexes.md

Define mapping templates applied during dynamic introduction of fields or objects. This example shows templates for fields starting with 'apples_' and fields of type 'text'.

```yaml
fos_elastica:
    indexes:
        user:
            dynamic_templates:
                - my_template_1:
                    match: apples_*
                    mapping:
                        type: float
                - my_template_2:
                    match: *
                    match_mapping_type: text
                    mapping:
                        type: keyword
            properties:
                username: { type: text }
```

--------------------------------

### Define a Custom Repository Class

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/custom-repositories.md

Create a custom repository by extending `FOS\ElasticaBundle\Repository` and adding your search methods. This example shows a `findWithCustomQuery` method.

```php
<?php

namespace Acme\ElasticaBundle\SearchRepository;

use FOS\ElasticaBundle\Repository;

class UserRepository extends Repository
{
    public function findWithCustomQuery($searchText)
    {
        // build $query with Elastica objects
        return $this->find($query);
    }
}

```

--------------------------------

### Run Enqueue Consumers

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/speed-up-populate-command.md

Start the message queue consumers. Running multiple consumers can improve performance. Use the first command for general use and the second if the first is not suitable.

```bash
$ ./bin/console enqueue:consume --setup-broker -vvv 
```

```bash
$ ./bin/console enqueue:transport:consume enqueue_elastica.populate_processor -vvv 
```

--------------------------------

### Basic FOSElasticaBundle Configuration

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/setup.md

Configure a minimal setup with one Elasticsearch client and one index named 'app'. The index 'app' will be available as the service `fos_elastica.index.app`.

```yaml
#app/config/config.yml
fos_elastica:
    clients:
        default: { hosts: ['http://localhost:9200'] }
    indexes:
        app: ~
```

--------------------------------

### Using Index-Wide Finder

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/usage.md

Get and use the index-wide finder service 'fos_elastica.finder.app' to search across all mapped objects in the index.

```php
/** var FOS\ElasticaBundle\Finder\MappedFinder */
$finder = $this->container->get('fos_elastica.finder.app');

// Returns a mixed array of any objects mapped
$results = $finder->find('bob');
```

--------------------------------

### Require FOSElasticaBundle with Composer

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/setup.md

Use Composer to download the latest stable version of the FOSElasticaBundle. This requires Composer to be installed globally.

```bash
$ composer require friendsofsymfony/elastica-bundle
```

--------------------------------

### Using Aggregations with Paginated Finder

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/usage.md

Retrieve aggregations when using paginated methods on the finder. This example adds a 'Terms' aggregation on the 'companyGroup' field.

```php
$query = new \Elastica\Query();
$agg = new \Elastica\Aggregation\Terms('tags');
$agg->setField('companyGroup');
$query->addAggregation($agg);

$companies = $this->finder->findPaginated($query);
$companies->setMaxPerPage($params['limit']);
$companies->setCurrentPage($params['page']);

$aggs = $companies->getAdapter()->getAggregations();
```

--------------------------------

### Custom Index Settings Configuration

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/indexes.md

Specify custom index settings, such as enabling a custom analyzer. This example defines a custom analyzer 'my_analyzer' with a 'lowercase' tokenizer and an 'nGram' filter.

```yaml
fos_elastica:
    indexes:
        blog:
            settings:
                index:
                    analysis:
                        analyzer:
                            my_analyzer:
                                type: custom
                                tokenizer: lowercase
                                filter   : [my_ngram]
                        filter:
                            my_ngram:
                                type: "nGram"
                                min_gram: 3
```

--------------------------------

### Setting Client Options for Elastica HTTP Client

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/elastica-http-client-configuration.md

Pass raw options directly to the underlying HTTP client (Guzzle, Symfony HTTP Client, or bundled Curl client) using the `client_options` key. This example shows options for Guzzle/Symfony and the bundled Curl client.

```yaml
# app/config/config.yml
fos_elastica:
    clients:
        default:
            hosts: ['http://example.com:80']
            client_options:
              # Guzzle / Symfony HTTP Client
              timeout: 30
              connect_timeout: 10
              proxy: 'http://localhost:8125'

              # elastic-transport's bundled Curl client (used when neither Guzzle nor
              # Symfony HTTP Client is installed). Use CURLOPT_* integer keys:
              !php/const \CURLOPT_TIMEOUT: 30
              !php/const \CURLOPT_CONNECTTIMEOUT: 10
              !php/const \CURLOPT_RANDOM_FILE: /dev/urandom
```

--------------------------------

### Setting HTTP Headers for Elastica Client

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/elastica-http-client-configuration.md

Configure custom HTTP headers, such as Authorization, for the Elastica client. This example uses the deprecated top-level `headers` key.

```yaml
# app/config/config.yml
fos_elastica:
    clients:
        default:
            hosts: ['http://example.com:80']
            headers:
                Authorization: "Basic jdumrGK7rY9TMuQOPng7GZycmxyMHNoir=="
```

--------------------------------

### Date Format Configuration

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/indexes.md

Specify custom date formats for date type fields. This example shows formats for 'lastlogin' and 'birthday' fields.

```yaml
fos_elastica:
    indexes:
        user:
            properties:
                username: { type: text }
                lastlogin: { type: date, format: basic_date_time }
                birthday: { type: date, format: "yyyy-MM-dd" }
```

--------------------------------

### Example SQS message payload

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/speed-up-populate-command-sqs.md

This is an example of the JSON payload that will be added to the AWS SQS queue for processing.

```json
{
  "options": {
    "max_per_page": 1000,
    "delete": true,
    "reset": true,
    "ignore_errors": false,
    "sleep": 0,
    "indexName": "user"
  },
  "page": 1
}
```

--------------------------------

### Implement PreTransformEvent Listener

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/pre-transform-event.md

Implement an event subscriber to listen for PreTransformEvent and perform custom operations on the object before it's transformed. This example reloads the object's translation.

```php
namespace AcmeBundle\EventListener;

use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use FOS\ElasticaBundle\Event\PreTransformEvent;

class PreTransformListener implements EventSubscriberInterface
{
    private $anotherService;
    
    // ...
    
    public function doPreTransform(PreTransformEvent $event)
    {
        $this->anotherService->reloadTranslation($event->getObject());
    }
    
    public static function getSubscribedEvents()
    {
        return [
            PreTransformEvent::class => 'doPreTransform',
        ];
    }
}
```

--------------------------------

### Nested Objects Configuration

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/indexes.md

Configure nested objects and object types within index properties. This example demonstrates mapping for 'comments' as a nested type and 'user'/'approver' as object types with their own properties.

```yaml
fos_elastica:
    indexes:
        post:
            properties:
                date: { boost: 5 }
                title: { boost: 3 }
                content: ~
                comments:
                    type: "nested"
                    properties:
                        date: { boost: 5 }
                        content: ~
                user:
                    type: "object"
                approver:
                    type: "object"
                    properties:
                        date: { boost: 5 }
```

--------------------------------

### Dynamic Index Naming based on Environment

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/setup.md

Configure the index name to dynamically include the kernel environment, for example, 'app_dev' for the development environment. This allows for environment-specific Elasticsearch indexes.

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

--------------------------------

### Autowire Index and Finder in Controller

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/usage.md

Demonstrates how to autowire FOSElasticaBundle Index and TransformedFinder services into a Symfony controller for easy access to search functionality.

```php
namespace App\Controller;

use FOS\ElasticaBundle\Elastica\Index;
use FOS\ElasticaBundle\Finder\TransformedFinder;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

#[Route('/default', name: 'app_default')]
public function index(
    Index $blogPostIndex,
    TransformedFinder $blogPostFinder
): Response {
    $results = $blogPostFinder->findPaginated('search text');
    $resultsPage = $results->getCurrentPageResults();
}
```

--------------------------------

### Populate Elasticsearch Indexes

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/aliased-indexes.md

Run the `fos:elastica:populate` command to populate the Elasticsearch indexes. Ensure caches are cleared before execution.

```bash
bin/console -eprod 'fos:elastica:populate'
```

--------------------------------

### Enable FOSElasticaBundle in config/bundles.php

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/setup.md

Add the FOSElasticaBundle to your project's `config/bundles.php` file to enable it.

```php
<?php

declare(strict_types=1);

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

```

--------------------------------

### Consume Queue Messages (Directly)

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/doctrine-queue-listener.md

Alternatively, use the enqueue:transport:consume command to process messages directly. Use this only if the --setup-broker option is not feasible.

```bash
$ ./bin/console enqueue:transport:consume enqueue_elastica.doctrine.sync_index_with_object_change_processor -vvv 
```

--------------------------------

### Run Populate Command with Queue Persister

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/speed-up-populate-command.md

Execute the populate command with the `--pager-persister=queue` option to utilize the message queue for processing.

```bash
$ ./bin/console fos:elastica:populate --pager-persister=queue 
```

--------------------------------

### Configure Index-Wide Finder

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/usage.md

Enable an index-wide finder by setting 'finder: ~' in the fos_elastica configuration for the 'app' index.

```yaml
fos_elastica:
    indexes:
        app:
            finder: ~
```

--------------------------------

### Implement HighlightableModelInterface for Entities

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/attachments.md

Implement the HighlightableModelInterface to handle search highlights. This requires getId(), setElasticHighlights(), and getElasticHighlights() methods.

```php
use FOS\ElasticaBundle\Transformer\HighlightableModelInterface;

class Library implements HighlightableModelInterface { 

    private $id

    private $highlights;

    //Needs this method for HighlightableModelInterface
    public function getId()
    {
        return $this->id;
    }

    //Needs this method for HighlightableModelInterface
    public function setElasticHighlights(array $highlights)
    {
        $this->highlights = $highlights;

        return $this;
    }

    public function getElasticHighlights()
    {
        return $this->highlights;
    }

}

```

--------------------------------

### Configure Finder Service

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/usage.md

Configure a finder service for the 'user' index in services.yaml. This allows for hydrated search results.

```yaml
# config/services.yaml
services:
    # ...

    App\Controller\UserController:
        tags: ['controller.service_arguments']
        public: true
        arguments:
            - '@fos_elastica.finder.user'
```

--------------------------------

### Check Indexes During Populate Process

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/aliased-indexes.md

Monitor the Elasticsearch aliases during the `fos:elastica:populate` command to observe the creation of new index versions and alias assignments.

```bash
in other cli in // check indexes during populate process
curl -XGET 'http://localhost:9200/_alias/?pretty'
{
  "app" : {
    "aliases" : {
      "app_prod" : {
      }
    }
  },
  "app_prod_2019-05-28-153852" : {
    "aliases" : {
    }
  }

}
```

--------------------------------

### Configure Index Templates

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/templates.md

Define index templates in your configuration file to automatically apply settings and mappings to new indices. Specify index patterns, settings, and type mappings.

```yaml
# app/config/config.yml

fos_elastica:
    index_templates:
        <name>:
            client: default
            template_name: <template name>
            index_patterns: ["some_index_*", "some_other_index_*"]
            settings:
                number_of_shards: 1
                number_of_replicas: 0
            types:
                auto_suggest:
                    mappings:
                        <field name>:  <params>
                         ...
```

--------------------------------

### Configure Controller Service Arguments

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/usage.md

Configure a controller to use service arguments, injecting the elastica manager.

```yaml
services:
    # ...

    App\Controller\UserController:
        tags: ['controller.service_arguments']
        public: true
        arguments:
            - '@fos_elastica.manager'
```

--------------------------------

### Setting HTTP Basic Authentication for Elastica Client

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/elastica-http-client-configuration.md

Configure HTTP Basic authentication credentials for the Elastica client using `username` and `password` keys.

```yaml
# app/config/config.yml
fos_elastica:
    clients:
        default:
            hosts: ['http://example.com:80']
            username: 'The_user'
            password: 'Password!'
```

--------------------------------

### Populate Listener Implementation

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/populate-events.md

Implement a listener to manage Elasticsearch refresh intervals and forcemerge operations during population events. This class requires the IndexManager service.

```php
<?php
namespace AppBundle\EventListener;

use FOS\ElasticaBundle\Event\PostIndexPopulateEvent;
use FOS\ElasticaBundle\Event\PreIndexPopulateEvent;
use FOS\ElasticaBundle\Index\IndexManager;

class PopulateListener
{
    /**
     * @var IndexManager
     */
    private $indexManager;

    /**
     * @param IndexManager $indexManager
     */
    public function __construct(IndexManager $indexManager)
    {
        $this->indexManager    = $indexManager;
    }

    public function preIndexPopulate(PreIndexPopulateEvent $event)
    {
        $index = $this->indexManager->getIndex($event->getIndex());
        $settings = $index->getSettings();
        $settings->setRefreshInterval(-1);
    }

    public function postIndexPopulate(PostIndexPopulateEvent $event)
    {
        $index = $this->indexManager->getIndex($event->getIndex());
        $settings = $index->getSettings();
        $index->forcemerge(['max_num_segments' => 5]);
        $settings->setRefreshInterval('1s');
    }
}

```

--------------------------------

### Attachment Search Query with Highlighting

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/attachments.md

Construct a search query for attachment content, including fuzzy matching and enabling highlighting for the 'content' field.

```php
$keywordQuery = new QueryString();
$keywordQuery->addParam(NULL, ['fuzziness' => 1]);
$keywordQuery->setQuery("$term~");
$keywordQuery->setDefaultOperator('AND');

$query = new Query($keywordQuery);
$query->setSource(["id", "..." ]);
$query->setHighlight([
    'fields' => [
        'content' => new \stdClass(),
    ],
]);

```

--------------------------------

### Populate Elasticsearch Index via Console Command

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/setup.md

Manually update the Elasticsearch index by running the `fos:elastica:populate` console command. This command is useful when the database is modified externally and also creates any defined indexes if they do not already exist.

```bash
$ php bin/console fos:elastica:populate
```

--------------------------------

### Use Custom Repository in Service Container

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/custom-repositories.md

Retrieve and use your custom repository from the `RepositoryManager` to execute custom search queries. Ensure the repository manager is injected or retrieved from the container.

```php
/** var FOS\ElasticaBundle\Manager\RepositoryManager */
$repositoryManager = $container->get('fos_elastica.manager');

/** var FOS\ElasticaBundle\Repository */
$repository = $repositoryManager->getRepository('UserBundle:User');

/** var array of Acme\UserBundle\Entity\User */
$users = $repository->findWithCustomQuery('bob');

```

--------------------------------

### Implement QueuePagerPersister for AWS SQS

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/speed-up-populate-command-sqs.md

Create a listener service that extends FOS Elastica's capabilities to specify the AWS SQS queue names for populating and reply.

```yaml
services:
    AppBundle\Listener\QueuePagerPersister:
        public: true
        arguments:
            $queueName: "%aws_sqs_queue_name%"
            $replyQueueName: "%aws_sqs_reply_queue_name%"
        tags:
            - { name: kernel.event_listener, method: prePersist }
```

--------------------------------

### Index Configuration with Serializer Groups

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/serializer.md

Configure an index to use serialization by specifying the desired groups. This can eliminate the need for explicit mapping definitions.

```yaml
fos_elastica:
    indexes:
        user:
            serializer:
                groups: [elastica]
```

--------------------------------

### Enable Doctrine Queue Listener

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/doctrine-queue-listener.md

Configure the EnqueueElasticaBundle to use queue listeners for specific indexes and model classes, enabling asynchronous synchronization.

```yaml
enqueue_elastica:
    doctrine:
        queue_listeners:
            - 
              index_name: 'acme_index'
              model_class: 'AppBundle\Entity\Blog'
```

--------------------------------

### Enable Symfony Serializer Configuration

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/serializer.md

Enable the Symfony serializer component in your `config.yml` file to integrate it with FOSElasticaBundle.

```yaml
fos_elastica:
    serializer: ~
```

--------------------------------

### Register Populate Listener Service

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/populate-events.md

Register the PopulateListener service in your application's configuration. This involves tagging the service as a kernel event listener for both pre and post populate events.

```xml
<service id="app.event_listener.populate_listener" class="AppBundle\EventListener\PopulateListener">
    <tag name="kernel.event_listener" event="FOS\ElasticaBundle\Event\PreIndexPopulateEvent" method="preIndexPopulate"/>
    <tag name="kernel.event_listener" event="FOS\ElasticaBundle\Event\PostIndexPopulateEvent" method="postIndexPopulate"/>
    <argument type="service" id="fos_elastica.index_manager"/>
</service>
```

--------------------------------

### Default Enqueue Configuration

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/speed-up-populate-command.md

This is the default configuration for EnqueueBundle. Ensure the ENQUEUE_DSN environment variable is set correctly.

```yaml
enqueue:
    default:
        transport:
            dsn: '%env(resolve:ENQUEUE_DSN)%'
        client: ~
enqueue_elastica:
    transport: '%enqueue.default_transport%'
    doctrine: ~
```

--------------------------------

### Configure Multiple Elasticsearch Connections

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/multiple-connections.md

Define multiple hosts for an Elastica client and specify a connection strategy. This allows for load balancing and high availability.

```yaml
fos_elastica:
    clients:
        default:
            hosts: ['http://es1.example.net:9200', 'http://es2.example.net:9200']
            connection_strategy: RoundRobin
```

--------------------------------

### Attachment Content Retrieval for Indexing

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/attachments.md

Implement methods to retrieve attachment content for indexing. Ensure the upload directory is correctly configured.

```php
public function getContent()
{
    //Upload directory set at /web/uploads/library
    return file_get_contents($this->getUploadRootDir() . '/' . $this->filename, 'r');
}

protected function getUploadRootDir()
{
    // the absolute directory path where uploaded
    // documents should be saved
    return __DIR__.'/../../../../web/'.$this->getUploadDir();
}

protected function getUploadDir()
{
    // get rid of the __DIR__ so it doesn't screw up
    // when displaying uploaded doc/image in the view.
    return 'uploads/library';
}

```

--------------------------------

### Indexable Callback with Service and Method

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/indexes.md

Specify a service and its method to determine if an object should be indexed. The method will receive the object as its first argument.

```yaml
fos_elastica:
    indexes:
        user:
            indexable_callback: [ @my_custom_service, 'userIndexable' ]
```

--------------------------------

### Configure Custom Query Builder Method

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/usage.md

Configure the bundle to use a custom method for transforming Elasticsearch results into model objects.

```yaml
fos_elastica:
    indexes:
        user:
            persistence:
                elastica_to_model_transformer:
                    query_builder_method: createSearchQueryBuilder
```

--------------------------------

### Configure Doctrine ORM Persistence for Indexing

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/setup.md

Set up persistence for the 'user' index using the Doctrine ORM driver. This configuration specifies the model, provider, and finder for automatically indexing Doctrine objects.

```yaml
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: ~
```

--------------------------------

### Verify Final Alias Assignment

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/aliased-indexes.md

After the `fos:elastica:populate` command completes, verify that the alias has been successfully reassigned to the newly created index.

```bash
when 'fos:elastica:populate' command finish

curl -XGET 'http://localhost:9200/_alias/?pretty'
{
  "app_prod_2019-05-28-153852" : {
    "aliases" : {
        "app_prod" : {
        }
    }
  }
}
```

--------------------------------

### Configure Listener for Logging Elastica Errors

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/indexes.md

Enable error catching and logging for Elastica/Elasticsearch exceptions within the persistence listener. Set to `true` to use the default Elastica logger, or provide a custom service ID.

```yaml
fos_elastica:
    indexes:
        user:
            persistence:
                listener:
                    logger: true
```

--------------------------------

### Inject Dependencies into Custom Repository

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/custom-repositories.md

Inject services like `Psr\Log\LoggerInterface` into your custom repository's constructor. The `FOS\ElasticaBundle\Finder\PaginatedFinderInterface` is automatically provided.

```php
<?php

namespace Acme\ElasticaBundle\SearchRepository;

use FOS\ElasticaBundle\Finder\PaginatedFinderInterface;
use FOS\ElasticaBundle\Repository;
use Psr\Log\LoggerInterface;

class UserRepository extends Repository
{
    private LoggerInterface $logger;

    public function __construct(PaginatedFinderInterface $finder, LoggerInterface $logger)
    {
        parent::__construct($finder);

        $this->logger = $logger;
    }

    public function findWithCustomQuery($searchText)
    {
        $this->logger->info('Searching for users with query: {query}', ['query' => $searchText]);

        // build $query with Elastica objects
        return $this->find($query);
    }
}

```

--------------------------------

### Configure MongoDB Manager

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/usage.md

Set the default manager to 'mongodb' if you are using MongoDB with FOSElasticaBundle.

```yaml
fos_elastica:
    default_manager: mongodb
```

--------------------------------

### Specify Custom Query Builder for Index Population

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/indexes.md

Use this when you need to define a specific query builder method for selecting entities to index. Ensure the method exists on your entity or repository.

```yaml
fos_elastica:
    indexes:
        user:
            persistence:
                provider:
                    query_builder_method: createIsActiveQueryBuilder
```

--------------------------------

### Setting SSL Options for Elastica Client

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/elastica-http-client-configuration.md

Configure SSL options for the Elastica client, including certificate, key, verification, and CA path. These settings are compatible with Guzzle and Symfony HttpClient.

```yaml
# app/config/config.yml
fos_elastica:
    clients:
        default:
            hosts: ['http://example.com:80']
            client_config:
              ssl_cert: 'certificate'
              ssl_key: 'ssl key'
              ssl_verify: true
              ssl_ca: 'path/to/http_ca.crt'
```

--------------------------------

### Enable Aliases for an Index

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/aliased-indexes.md

Set the `use_alias` option to `true` in your FOSElasticaBundle configuration to enable index aliasing.

```yaml
fos_elastica:
    indexes:
        app:
            use_alias: true
```

--------------------------------

### QueuePagerPersister PHP Implementation

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/speed-up-populate-command-sqs.md

This PHP class implements the `QueuePagerPersister` to set the AWS SQS queue names for populating and reply queues within the `PrePersistEvent` options.

```php
namespace App\Listener;

use FOS\ElasticaBundle\Persister\Event\PrePersistEvent;

/**
 * Specifies AWS SQS queue name.
 */
class QueuePagerPersister
{
    /** @var string AWS SQS queue name */
    protected $queueName;

    /** @var string AWS SQS reply queue name */
    protected $replyQueueName;

    /**
     * Constructor.
     *
     * @param string $queueName
     */
    public function __construct(string $queueName, string $replyQueueName)
    {
        $this->queueName = $queueName;
        $this->replyQueueName = $replyQueueName;
    }

    /**
     * Specifies AWS SQS queue name.
     *
     * @param PrePersistEvent $event
     */
    public function prePersist(PrePersistEvent $event)
    {
        $options = $event->getOptions();
        $options['populate_queue'] = $this->queueName;
        $options['populate_reply_queue'] = $this->replyQueueName;
        $event->setOptions($options);
    }
}
```

--------------------------------

### Configure Doctrine Query Hints for Hydration

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/hints-on-result-hydration.md

Add hints to the `elastica_to_model_transformer` configuration to pass specific values to Doctrine during object hydration. This is useful for features like Doctrine2's translatable behavior to avoid extra queries. This configuration is only available for the ORM driver.

```yaml
fos_elastica:
    indexes:
        user:
            persistence:
                elastica_to_model_transformer:
                    hints:
                        - {name: 'doctrine.customOutputWalker', value: 'Gedmo\Translatable\Query\TreeWalker\TranslationWalker'}
```

--------------------------------

### Enable JMS Serializer Configuration

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/serializer.md

Configure FOSElasticaBundle to use the JMSSerializer component by specifying 'jms_serializer' in your `config.yml`.

```yaml
fos_elastica:
    serializer:
        serializer: jms_serializer
```

--------------------------------

### Enable Asynchronous Index Updates

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/indexes.md

Defer index updates until after the Symfony response has been sent. This improves response times by batching updates and firing them on `kernel.terminate` and `console.terminate` events.

```yaml
fos_elastica:
    indexes:
        user:
            persistence:
                listener:
                    defer: true
```

--------------------------------

### Configure enqueue bundle for SQS transport

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/speed-up-populate-command-sqs.md

Configure the enqueue bundle in `config/packages/enqueue.yml` to use SQS as the transport. This involves setting the DSN with your AWS credentials and region.

```yaml
enqueue:
    default:
        transport:
            dsn: 'sqs:?key=%aws_sqs_key%&secret=%aws_sqs_secret_key%&region=%aws_sqs_region%'
        client: ~

enqueue_elastica:
    transport: '%enqueue.default_transport%'
    doctrine: ~
```

--------------------------------

### Basic Searching with PaginatedFinder

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/usage.md

Perform searches using a PaginatedFinderInterface. Supports basic string searches, hybrid results, and pagination with Pagerfanta or KnpPaginator.

```php
namespace App\Controller;

use FOS\ElasticaBundle\Finder\PaginatedFinderInterface;

class UserController
{
    private $finder;

    public function __construct(PaginatedFinderInterface $finder)
    {
        $this->finder = $finder;
    }

    public function userAction()
    {
        // Option 1. Returns all users who have example.net in any of their mapped fields
        $results = $this->finder->find('example.net');

        // Option 2. Returns a set of hybrid results that contain all Elasticsearch results
        // and their transformed counterparts. Each result is an instance of a HybridResult
        $results = $this->finder->findHybrid('example.net');

        // Option 3a. Pagerfanta'd resultset
        /** var Pagerfanta\Pagerfanta */
        $userPaginator = $this->finder->findPaginated('bob');
        $countOfResults = $userPaginator->getNbResults();

        // Option 3b. KnpPaginator resultset
        $paginator = $this->get('knp_paginator');
        $results = $this->finder->createPaginatorAdapter('bob');
        $pagination = $paginator->paginate($results, $page, 10);

        // You can specify additional options as the fourth parameter of Knp Paginator
        // paginate method to nested_filter and nested_sort

        $options = [
            'sortNestedPath' => 'owner',
            'sortNestedFilter' => new Query\Term(['enabled' => ['value' => true]]),
        ];

        // sortNestedPath and sortNestedFilter also accepts a callable
        // which takes the current sort field to get the correct sort path/filter

        $pagination = $paginator->paginate($results, $page, 10, $options);
    }
}
```

--------------------------------

### Create Alias for an Index

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/aliased-indexes.md

Manually create an alias for the current index. This is part of the no-downtime strategy where the alias will point to the new index after repopulation.

```bash
# before actions
curl -XGET 'http://localhost:9200/_alias/?pretty'
{
  "app" : {
    "aliases" : { }
  }
}

# create alias to switch after with no downtime
$ curl -XPOST 'http://localhost:9200/_aliases' -H 'Content-Type: application/json'  -d '
{
    "actions" : [
        { "add" : { "index" : "app", "alias" : "app_prod" } }
    ]
}'

#check alias is ok
curl -XGET 'http://localhost:9200/_alias/?pretty'
{
  "app" : {
    "aliases" : { "app_prod" : { } }
  }
}
```

--------------------------------

### Indexable Callback with Invokable Service

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/indexes.md

Use an invokable service to determine if an object should be indexed. The service's __invoke method must accept the object as a single parameter.

```yaml
fos_elastica:
    indexes:
        user:
            indexable_callback: [ @my_custom_invokable_service ]
```

--------------------------------

### Configure Index Population Batch Size

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/indexes.md

Adjust the number of documents indexed in each packet during population. The default is 100.

```yaml
fos_elastica:
    indexes:
        user:
            persistence:
                provider:
                    batch_size: 10
```

--------------------------------

### Configure Index with Custom Analyzer

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/usage.md

Configure an Elasticsearch index with a custom analyzer, such as 'snowball' for stemming, and apply it to specific fields.

```yaml
fos_elastica:
    indexes:
        article:
            settings:
                index:
                    analysis:
                        analyzer:
                            my_analyzer:
                                type: snowball
                                language: English
            persistence:
                driver: orm
                model: Acme\DemoBundle\Entity\Article
                provider: ~
                finder: ~
            properties:
                title: { boost: 10, analyzer: my_analyzer }
                tags:
                categoryIds:
```

--------------------------------

### JMS Serializer Options for Version and Null Serialization

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/serializer.md

When using the JMS Serializer, you can specify additional options like version and whether to serialize null values within the index configuration.

```yaml
fos_elastica:
    indexes:
        user:
            serializer:
                groups: [elastica]
                version: '1.1'
                serialize_null: true
```

--------------------------------

### Indexable Callback with Static Class Method

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/indexes.md

Use a static method on a class to determine if an object should be indexed. The static method will receive the object as its only argument.

```yaml
fos_elastica:
    indexes:
        user:
            indexable_callback: [ 'Acme\DemoBundle\IndexableChecker', 'isIndexable' ]
```

--------------------------------

### Configure Object Indexing Callback

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/indexes.md

Use `indexable_callback` to specify a method, service, or expression to determine if an object should be indexed. The callback must return a boolean.

```yaml
fos_elastica:
    indexes:
        user:
            indexable_callback: 'enabled'
```

--------------------------------

### Configure Selective Real-time Index Updates

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/indexes.md

Choose specific Doctrine events (insert, update, delete) for which the index should be updated in real-time. By default, all are enabled.

```yaml
fos_elastica:
    indexes:
        user:
            persistence:
                listener:
                    insert: true
                    update: false
                    delete: true
```

--------------------------------

### Configure Custom Repository in Mapping

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/custom-repositories.md

Specify your custom repository in the `fos_elastica` configuration for the relevant index and entity. This links your entity to its custom repository.

```yaml
fos_elastica:
    clients:
        default: { hosts: ['http://localhost:9200'] }
    indexes:
        user:
            client: default
            persistence:
                driver: orm
                model: Application\UserBundle\Entity\User
                provider: ~
                finder: ~
                repository: Acme\ElasticaBundle\SearchRepository\UserRepository
            properties:
                # your properties

```

--------------------------------

### Successful population progress

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/speed-up-populate-command-sqs.md

This output indicates that the FOS Elastica population process has completed successfully after consuming messages from the SQS queue.

```bash
Populating
Populating
 1/1 [============================] 100% < 1 sec/< 1 sec 70.0 MiB
Populating
    0 [>---------------------------] < 1 sec 70.0 MiBRefreshing app
Refreshing app
```

--------------------------------

### Implement Custom Query Builder Method

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/usage.md

Implement a custom query builder method in a repository to customize how Elasticsearch results are transformed into model objects, including joining related entities.

```php
class UserRepository extends EntityRepository
{
    /**
     * Used by Elastica to transform results to model
     * 
     * @param string $entityAlias
     * @return  Doctrine\ORM\QueryBuilder
     */
    public function createSearchQueryBuilder($entityAlias)
    {
        $qb = $this->createQueryBuilder($entityAlias);

        $qb->select($entityAlias, 'g')
            ->innerJoin($entityAlias.'.groups', 'g');

        return $qb;
    }
}
```

--------------------------------

### Configure HTTP Authentication in YAML

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/http-auth-for-elastica.md

Set the username and password for HTTP authentication directly in the `app/config/config.yml` file under the `fos_elastica.clients.default` section. This is necessary when your Elasticsearch cluster requires basic HTTP authentication.

```yaml
# app/config/config.yml
fos_elastica:
    clients:
        default:
            hosts:
                - 'http://example.com:80'
            username: 'username'
            password: 'password'
```

--------------------------------

### Trigger FOS Elastica populate command with SQS

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/speed-up-populate-command-sqs.md

Execute the FOS Elastica populate command with the `--pager-persister=queue` option to send messages to the configured SQS queue. The command will hang until messages are processed.

```bash
php bin/console fos:elastica:populate --pager-persister=queue -vvv
```

--------------------------------

### Enable Real-time Index Updates with Doctrine

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/indexes.md

Configure ElasticaBundle to automatically update indexes on Doctrine entity changes (insert, update, delete) using lifecycle events. Specify the driver and model.

```yaml
fos_elastica:
    indexes:
        user:
            persistence:
                driver: orm
                model: Application\UserBundle\Entity\User
                listener: ~
```

--------------------------------

### Indexable Callback with ExpressionLanguage

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/indexes.md

Utilize ExpressionLanguage for conditional indexing. The object being indexed is available as `object` within the expression.

```yaml
fos_elastica:
    indexes:
        user:
            indexable_callback: 'object.isEnabled() or object.shouldBeIndexedAnyway()'
```

--------------------------------

### Configure Doctrine ORM Provider

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/provider.md

Configure the Doctrine ORM provider in your app/config/config.yml. Specify the driver as 'orm' and the model class.

```yaml
fos_elastica:
    indexes:
        theIndexName:
            persistence:
                driver: orm
                model: Application\UserBundle\Entity\User
                provider: ~
```

--------------------------------

### Register Event Subscriber Service

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/pre-transform-event.md

Define the event subscriber service in your configuration. Ensure the 'kernel.event_subscriber' tag is applied.

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

--------------------------------

### Reset Index Templates Command

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/templates.md

Use the `fos:elastica:reset-templates` command to sync your YAML configuration with the Elasticsearch server. This command can reset all templates or specific ones, and optionally force delete matching indexes.

```bash
php bin/console fos:elastica:reset-templates
```

--------------------------------

### Execute Advanced Search Query

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/usage.md

Execute an advanced search query using Elastica objects, combining multiple query types like MatchQuery and Terms, and applying custom analyzers.

```php
$finder = $this->container->get('fos_elastica.finder.app.article');
$boolQuery = new \Elastica\Query\BoolQuery();

$fieldQuery = new \Elastica\Query\MatchQuery();
$fieldQuery->setFieldQuery('title', 'I am a title string');
$fieldQuery->setFieldParam('title', 'analyzer', 'my_analyzer');
$boolQuery->addShould($fieldQuery);

$tagsQuery = new \Elastica\Query\Terms('tags', ['tag1', 'tag2']);
$boolQuery->addShould($tagsQuery);

$categoryQuery = new \Elastica\Query\Terms('categoryIds', ['1', '2', '3']);
$boolQuery->addMust($categoryQuery);

$data = $finder->find($boolQuery);
```

--------------------------------

### Configure Index Name as Alias Name

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/aliased-indexes.md

Set the `index_name` parameter to the desired alias name when `use_alias` is enabled. This ensures the bundle uses the alias directly.

```yaml
#index name is alias name
fos_elastica:
    indexes:
        app:
            use_alias: true
            index_name: app_prod
```

--------------------------------

### Define Index Properties

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/setup.md

Define the properties for an Elasticsearch index, such as 'username', 'firstName', 'lastName', and 'email'. Each defined index is made available as a service.

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

--------------------------------

### Enable EntityManager Clearing Extension

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/doctrine-queue-listener.md

Configure Enqueue to clear the entity manager in the queue consumer to avoid issues with cached entities being sent to Elasticsearch.

```yaml
enqueue:
    extensions:
        doctrine_clear_identity_map_extension: true
```

--------------------------------

### Specify Custom Logger Service

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/logging.md

Configure a custom logger service by providing its service ID to the `logger` property. This allows for more advanced logging configurations tailored to your application's needs.

```yaml
fos_elastica:
    clients:
        default:
            hosts: ['http://example.com:80']
            logger: 'acme.custom.logger'
```

--------------------------------

### Add Custom Property via Event Listener

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/custom-properties.md

Implement an event subscriber to listen for `PostTransformEvent`. Inject custom data into the Elastica document using `set()` method. This requires a service that calculates the custom value.

```php
namespace AcmeBundle\EventListener;

use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use FOS\ElasticaBundle\Event\PostTransformEvent;

class CustomPropertyListener implements EventSubscriberInterface
{
    private $anotherService;
    
    // ...
    
    public function addCustomProperty(PostTransformEvent $event)
    {
        $document = $event->getDocument();
        $custom = $this->anotherService->calculateCustom($event->getObject());
                    
        $document->set('custom', $custom);
    }
    
    public static function getSubscribedEvents()
    {
        return [
            PostTransformEvent::class => 'addCustomProperty',
        ];
    }
}
```

--------------------------------

### Configure Attachment Field Mapping

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/attachments.md

Define an attachment field in your index mapping. Ensure to set 'store: true' and 'term_vector: with_positions_offsets' on the content field if highlighting is required.

```yaml
fos_elastica:
    indexes:
        user:
            properties:
                id: ~
                content:
                    type: attachment
                    path: full
                    fields:
                        name: { store: yes }
                        title: { store : yes }
                        date: { store : yes }
                        content : { term_vector: with_positions_offsets, store: yes }
                        ...

```

--------------------------------

### Inject Elastica Manager in Controller

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/usage.md

Inject the RepositoryManagerInterface into a controller to access Elasticsearch repositories.

```php
namespace App\Controller;

use FOS\ElasticaBundle\Manager\RepositoryManagerInterface;

class UserController extends Controller
{
    /** @var RepositoryManagerInterface */
    private $repositoryManager;

    public function __construct(RepositoryManagerInterface $repositoryManager)
    {
        $this->repositoryManager = $repositoryManager;
    }

    public function userAction()
    {
        $repository = $this->repositoryManager->getRepository('UserBundle:User');

        /** var array of App\UserBundle\Entity\User */
        $users = $repository->find('bob');
    }
}
```

--------------------------------

### Configure AWS SQS parameters in services.yaml

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/speed-up-populate-command-sqs.md

Define parameters in your services.yaml file to store AWS SQS credentials and queue names. These parameters are typically populated from environment variables.

```yaml
parameters:
    aws_sqs_key: '%env(AWS_SQS_KEY)%'
    aws_sqs_secret_key: '%env(AWS_SQS_SECRET_KEY)%'
    aws_sqs_region: '%env(AWS_SQS_REGION)%'
    aws_sqs_queue_name: '%env(AWS_SQS_QUEUE_NAME)%'
    aws_sqs_reply_queue_name: '%env(AWS_SQS_REPLY_QUEUE_NAME)%'
```

--------------------------------

### PostIndexPopulate for Elasticsearch v2.1+

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/populate-events.md

Manually call _forcemerge and reset the refresh interval for Elasticsearch versions 2.1 and above. This uses the client's request method.

```php
...
    public function postIndexPopulate(PostIndexPopulateEvent $event)
    {
        $index = $this->indexManager->getIndex($event->getIndex());
        $index->getClient()->request('_forcemerge?max_num_segments=5', 'POST');
        $index->getSettings()->setRefreshInterval(Settings::DEFAULT_REFRESH_INTERVAL);
    }
...
```

--------------------------------

### Enable Default Logger

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/logging.md

Set the logger property to `true` to enable the default logger for the Elasticsearch client. This is useful for development or when explicit logging is required in non-debug environments.

```yaml
fos_elastica:
    clients:
        default:
            hosts: ['http://example.com:80']
            logger: true
```

--------------------------------

### Displaying Highlights in Twig

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/attachments.md

Iterate through the ElasticHighlights property in a Twig template to display highlighted search results.

```twig
{% for highlights in reference.ElasticHighlights %}
    {% for highlight in highlights %}
        <tr class="alert alert-info">
            <td></td>
            <td></td>
            <td>{{ highlight|raw }}</td>
        </tr>
    {% endfor %}
{% endfor %}

```

--------------------------------

### Register Custom Pager Provider Service

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/manual-provider.md

Define a service in your configuration file that implements the PagerProviderInterface and is tagged for the 'fos_elastica.pager_provider' with the appropriate index.

```yaml
services:
    acme.search_provider.user:
        class: Acme\UserBundle\Provider\UserPagerProvider
        tags:
            - { name: fos_elastica.pager_provider, index: user }
```

--------------------------------

### Advanced Search Options

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/usage.md

Pass additional parameters to influence the Elasticsearch query, such as 'search_type'.

```php
$results = $this->finder->findHybrid('example.net', null, ['search_type' => 'dfs_query_then_fetch']);
```

--------------------------------

### Force Merge Elasticsearch Segments

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/populate-events.md

Call the _forcemerge API to optimize segments after bulk indexing. This is typically done after re-enabling the refresh interval.

```bash
curl -XPOST 'http://localhost:9200/test/_forcemerge?max_num_segments=5'
```

--------------------------------

### User Class with Serializer Groups Annotation

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/serializer.md

Annotate your User class properties with `@Groups` to control which fields are serialized for Elasticsearch when using the serializer.

```php
use Symfony\Component\Serializer\Annotation\Groups;

class User {

    /**
     * @Groups({"elastica"})
     *
     * @var string
     */
    private $username;
    
}
```

--------------------------------

### Re-enable Elasticsearch Refresh Interval

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/populate-events.md

Re-enable the index refresh interval after bulk indexing is complete. A common value is '1s'.

```bash
curl -XPUT localhost:9200/test/_settings -d '{
    "index" : {
        "refresh_interval" : "1s"
    } }'
```

--------------------------------

### Consume messages from SQS queue

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/speed-up-populate-command-sqs.md

Use the `enqueue:transport:consume` command to process messages from the SQS queue. Replace `<queue_name>` with your actual AWS SQS queue name.

```bash
php bin/console enqueue:transport:consume  enqueue_elastica.populate_processor <queue_name> -vvv
```

--------------------------------

### Ignore Missing Results Configuration

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/indexes.md

Configure an index to ignore missing results from Elasticsearch. This prevents exceptions when Elasticsearch results do not match the persistence provider, useful for large or asynchronously updated indexes.

```yaml
fos_elastica:
    indexes:
        user:
            persistence:
                elastica_to_model_transformer:
                    ignore_missing: true
```

--------------------------------

### Workaround for addShould Array Input

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/usage.md

Workaround for Elasticsearch versions 7.7+ where passing an array to addShould can cause parsing errors. Use individual addShould calls instead.

```php
$boolQuery->addShould($fieldQuery);
$boolQuery->addShould($tagsQuery);
```

--------------------------------

### Custom Property Paths Configuration

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/indexes.md

Define custom property paths for data retrieval from the underlying model. Supports Symfony PropertyAccessor component features. Setting to 'false' disables value population during indexing.

```yaml
fos_elastica:
    indexes:
        user:
            properties:
                username:
                    property_path: indexableUsername
                firstName:
                    property_path: names[first]
```

--------------------------------

### Disable Persistence Backend Logging in Production

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/indexes.md

Force the persistence backend's logging to be disabled when Symfony is not in debug mode. Setting to `true` leaves logging alone, while the default mirrors `%kernel.debug%`.

```yaml
fos_elastica:
    indexes:
        user:
            persistence:
                provider:
                    debug_logging: false
```

--------------------------------

### Register Event Subscriber Service

Source: https://github.com/friendsofsymfony/foselasticabundle/blob/master/doc/cookbook/custom-properties.md

Define the event subscriber as a service in your Symfony application's configuration. Tag it with `kernel.event_subscriber` to ensure it's automatically registered.

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