Skip to content

Commit 286f520

Browse files
committed
Merge branch '1.x' into 2.x
2 parents 6a560f2 + 7c4a2f2 commit 286f520

File tree

2 files changed

+26
-10
lines changed

2 files changed

+26
-10
lines changed

doc/01_Installation/02_Upgrade.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,22 @@
22

33
Following steps are necessary during updating to newer versions.
44

5+
## Upgrade to 1.3.0
6+
- [Indexing] 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:
7+
```yml
8+
pimcore_generic_data_index:
9+
index_service:
10+
client_params:
11+
client_name: default
12+
client_type: 'elasticsearch'
13+
```
14+
- [Indexing] Introduced new service alias `generic-data-index.search-client`. This will replace deprecated alias `generic-data-index.opensearch-client` which will be removed in the next major version.
15+
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.
16+
- Classes under OpenSearch namespaces are now deprecated and will be removed in the next major version. Please use the classes under the DefaultSearch namespace instead.
17+
- Execute the following command to reindex all elements to be able to use all new features or when switching between OpenSearch and Elasticsearch:
18+
19+
```bin/console generic-data-index:update:index```
20+
521
## Upgrade to 1.1.0
622
- Execute the following command to reindex all elements to be able to use all new features:
723

src/DependencyInjection/PimcoreGenericDataIndexExtension.php

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -90,16 +90,16 @@ private function registerIndexServiceParams(ContainerBuilder $container, array $
9090
$definition->setArgument('$indexSettings', $indexSettings['index_settings']);
9191
$definition->setArgument('$searchSettings', $indexSettings['search_settings']);
9292
$definition->setArgument('$systemFieldsSettings', $indexSettings['system_fields_settings']);
93-
94-
$openSearchClientId = 'pimcore.open_search_client.' . $indexSettings['client_params']['client_name'];
95-
$container->setAlias('generic-data-index.opensearch-client', $openSearchClientId)
96-
->setDeprecated(
97-
'pimcore/generic-data-index-bundle',
98-
'1.3',
99-
'The "%alias_id%" service alias is deprecated and will be removed in version 2.0. ' .
100-
'Please use "generic-data-index.search-client" instead.'
101-
);
102-
93+
if ($indexSettings['client_params']['client_type'] === ClientType::OPEN_SEARCH->value) {
94+
$openSearchClientId = 'pimcore.open_search_client.' . $indexSettings['client_params']['client_name'];
95+
$container->setAlias('generic-data-index.opensearch-client', $openSearchClientId)
96+
->setDeprecated(
97+
'pimcore/generic-data-index-bundle',
98+
'1.3',
99+
'The "%alias_id%" service alias is deprecated and will be removed in version 2.0. ' .
100+
'Please use "generic-data-index.search-client" instead.'
101+
);
102+
}
103103
$clientId = $this->getDefaultSearchClientId($indexSettings);
104104
$container->setAlias('generic-data-index.search-client', $clientId);
105105

0 commit comments

Comments
 (0)