Installation of Generic Data Index

info

This bundle is only supported on Pimcore Core Framework 11.

This bundle requires minimum version of OpenSearch 2.7. or Elasticsearch 8.0.0.

Bundle Installation

To install the Generic Data Index bundle, follow the steps below:

1. Install the required dependencies:

composer require pimcore/generic-data-index-bundle

2. Make sure the bundle is enabled in the config/bundles.php file. The following lines should be added:

use Pimcore\Bundle\GenericDataIndexBundle\PimcoreGenericDataIndexBundle;
// ...
return [
    // ...
    PimcoreGenericDataIndexBundle::class => ['all' => true],
    // ...
];  

3. Install the bundle:

bin/console pimcore:bundle:install PimcoreGenericDataIndexBundle

4. Setup search client configuration in your Symfony configuration files (e.g. config.yaml):

See OpenSearch Client Setup or Elasticsearch Client Setup for more information.

5. Setup one or multiple Symfony messenger workers for the indexing queue processing. It is recommended to use a tool like Supervisor to manage the workers. For more information, see the Symfony Messenger documentation.

./bin/console messenger:consume pimcore_generic_data_index_queue scheduler_generic_data_index

Deployment hint:

For deployments of applications with this bundle via deployment pipelines without actual database access, the Symfony cache warming process could fail as doctrine ORM tries to determine the database version on cache warm-up to build its cache. Therefore, it is recommended to configure the database server version in the default DBAL connection like this:

doctrine:
    dbal:
        default_connection: default
        connections:
            default:
                ...
                server_version: mariadb-10.11.0

Commands after Installation

It is needed to run following command after installation (at least) once to create the indices and add all assets and data objects to the index queue:

./bin/console generic-data-index:update:index -r