Skip to main content
Version: 2025.4

Upgrade Notes

Things to consider before or when upgrading to new versions.

v3.5.2​

New: --force-recreate option for create-or-update-mapping​

The datahub:simple-rest:create-or-update-mapping command now supports a --force-recreate option that drops the alias and both -even / -odd physical indexes, recreates a fresh index with the current mapping, and re-enqueues all elements.

bin/console datahub:simple-rest:create-or-update-mapping <configName> --force-recreate
bin/console datahub:simple-rest:process-queue

The command asks for interactive confirmation before deleting; pass --no-interaction to skip the prompt in scripts.

Bug fix: mapping for advanced columns in Studio configurations​

The mapping for advanced columns in Studio configurations changed from flat_object / flattened to keyword. This only affects Studio configurations that use advanced columns.

OpenSearch / Elasticsearch cannot migrate documents from flat_object / flattened to keyword automatically, so existing Studio indexes with advanced columns must be rebuilt using the --force-recreate option above.

v3.5.0​

With this version and the Pimcore Studio integration, we introduced a new architecture for schema definitions. We are moving from the tree-based schema definition (also used in the grid configuration of the Admin Classic UI) to a pipeline-based approach (also used in Studio UI grids). This change is driven by technical and maintenance considerations, as the tree-based implementation has limitations in terms of consistency, flexibility, and extensibility. The new architecture aligns with how Pimcore Studio UI grids work internally, streamlining the implementation across adapters and improving consistency, stability, and extensibility.

Existing configurations created in the Classic UI remain functional and continue to execute without changes. However, a configuration must be fully migrated to the new pipeline-based format before it can be edited in Pimcore Studio. Migration must be done manually by following the steps provided in the Pimcore Studio UI.

Read-only support for the legacy tree-based schema definitions will be removed in version 2027.1.0.

v3.4.0​

The following methods have been deprecated and will be removed in v4.0.0. Use the new DTO-based methods instead:

  • IndexHandler:
    • queryIndexSearch() → Use executeSearch() with QueryParametersDto
    • queryIndexTreeNavigation() → Use executeTreeNavigation() with TreeNavigationQueryDto
  • QueryService:
    • queryIndexSearch() → Use executeSearch() with QueryServiceSearchDto
    • queryIndexTreeNavigation() → Use executeTreeNavigation() with QueryServiceTreeNavigationDto

v3.3.0​

  • Added support to zircote/swagger-php to v5.

v3.1.0​

  • Added requirement to symfony/http-foundation ^6.3 to support the Request explicit input sources and types.
  • Added support for Elasticsearch in parallel to Opensearch. Opensearch remains the default search technology. If you are using Elasticsearch, you need to update your symfony configuration as follows:
pimcore_data_hub_simple_rest:
    client_name: default
    client_type: 'elasticsearch'
  • Introduced new service alias pimcore.datahub.simplerest.search-client. This will replace deprecated alias pimcore.datahub.simplerest.opensearch-client which will be removed in the next major version. The new service alias can be used to inject the search client into your services. This search client is an instance of Pimcore\SearchClient\SearchClientInterface which is a common interface for OpenSearch and Elasticsearch clients.

v3.0.0​

  • Removed Pimcore 10 support
  • Removed Elasticsearch support
  • Added OpenSearch client and OpenSearch support

v2.0.0​

  • It is possible to add more than one API-key per configuration now. Therefore, the API-key gets stored as an array in the configuration. Configurations from previous versions are still supported, but they get converted to the new format as soon as they get saved.
  • Removed Elasticsearch 6 and Elasticsearch 7 support, added support for Elasticsearch 8
  • Changed elasticsearch client configuration

v1.7.2​

  • Data type for asset fileSize was changed to long (was int). If you run into issues regarding the fileSize, please re-index your data.

v1.5.x to v1.6.0​

  • Default number of shards is now set to 1 (was 5). To change the value back to 5, see Indexing Options section in Indexing Details.