| title |
|---|
Advanced Object Search |
Advanced Object Search bundle provides advanced object search in Pimcore backend powered by OpenSearch.
Follow Installation instructions.
OpenSearch client configuration takes place via Pimcore OpenSearch Client Bundle and has two parts.
- Configuring an OpenSearch client.
- Define the client to be used by advanced object search.
# Configure an OpenSearch client
pimcore_open_search_client:
clients:
default:
hosts: ['https://opensearch:9200']
password: 'admin'
username: 'admin'
ssl_verification: false
# Define the client to be used by advanced object search
advanced_object_search:
client_name: default # default is default value here, just need to be specified when other client should be used.If nothing is configured, a default client connecting to localhost:9200 is used.
Before starting, setup at least following configuration in symfony configuration tree:
advanced_object_search:
# Prefix for index names
index_name_prefix: 'advanced_object_search_'For further configuration options follow the docs and the inline description of the configuration tree.
Call Pimcore command advanced-object-search:update-mapping for creating mappings and advanced-object-search:re-index
for indexing data for the first time.
GUI for creating searches against search index with
- saving functionality
- sharing functionality
Following event listeners are called automatically
pimcore.dataobject.postUpdate- data object is updated in search index, all child objects are added to update queue.pimcore.dataobject.preDelete- data object is deleted from search index.pimcore.class.postUpdate- search index mapping is updated or index recreated if necessary.
Functions in Pimcore console.
advanced-object-search:process-update-queue--> processes whole update queue of es search index.advanced-object-search:re-index--> Reindex all data objects of given class. Does not delete index first or resets update queue.advanced-object-search:update-mapping--> Deletes and recreates mapping of given classes. Resets update queue for given class.
For details see documentation directly in Pimcore console.
By default, with every Pimcore maintenance call, 500 entries of update queue are processed. As an alternative, you also can activate symfony messenger to process the update queue. For that, just activate it as follows.
advanced_object_search:
messenger_queue_processing:
activated: trueIf activated, the processing is kicked off automatically with the advancedobjectsearch_update_queue maintenance task.
Messages are dispatched via pimcore_index_queues transport. So make sure, you have
workers processing this transport when activating the messenger based queue processing.
Per data object class one index with one document type is created.
<?php
/**
* @var \AdvancedObjectSearchBundle\Service $service
*/
$service = $this->get("AdvancedObjectSearchBundle\Service");
$service->updateMapping(ClassDefinition::getByName("Product"));On data object save or via script:
<?php
/**
* @var \AdvancedObjectSearchBundle\Service $service
*/
$service = $this->get("AdvancedObjectSearchBundle\Service");
$objects = Product::getList();
foreach($objects as $object) {
$service->doUpdateIndexData($object);
}<?php
/**
* @var \AdvancedObjectSearchBundle\Service $service
*/
$service = $this->get("AdvancedObjectSearchBundle\Service");
//filter for relations via ID
$results = $service->doFilter(3,
[
new FilterEntry(
"objects",
[
"type" => "object",
"id" => 75
],
BoolQuery::SHOULD
)
],
""
);
//filter for relations via sub query
$results = $service->doFilter(3,
[
[
"fieldname" => "objects",
"filterEntryData" => [
"type" => "object",
"className" => "Customer",
"filters" => [
[
"fieldname" => "firstname",
"filterEntryData" => "tom"
]
]
]
],
],
""
);
// full text search query without filters
$results = $service->doFilter(3,
[],
"sony"
);
// filter for several attributes - e.g. number field, input, localized fields
$results = $service->doFilter(3,
[
[
"fieldname" => "price",
"filterEntryData" => 50.77
],
[
"fieldname" => "price2",
"filterEntryData" => [
"gte" => 50.77,
"lte" => 50.77
]
],
[
"fieldname" => "keywords",
"filterEntryData" => "test2",
"operator" => BoolQuery::SHOULD
],
[
"fieldname" => "localizedfields",
"filterEntryData" => [
"en" => [
"fieldname" => "locname",
"filterEntryData" => "englname"
]
]
],
[
"fieldname" => "localizedfields",
"filterEntryData" => [
"de" => [
"fieldname" => "locname",
"filterEntryData" => "deutname"
]
]
],
new FilterEntry("keywords", "testx", BoolQuery::SHOULD)
],
""
);Currently following data types are not supported - but can be added if needed in future versions:
- ClassificationStore
- Slider
- Password
- Block
- Table
- StructuredTable
- Geographic data types
- Image data types
- Implement Field Definition Adapter by implementing the
IFieldDefinitionAdapterinterface. - Register new Field Definition Adapter as service
- Add mapping in configuration like
advanced_object_search:
field_definition_adapters:
newDataTypeName: SERVICE_ID_OF_FIELD_DEFINITION_ADAPTERIf you want custom filters in the result tab directly without having to create a new advanced object search every time read here on how to extend the result tab with custom filters.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent