https://github.com/dachcom-digital/pimcore-dynamic-search
Pimcore Search Bundle. Data Provider: Search via Crawler, ObjectList. Index Provider: Store via Lucene, Elasticsearch or OpenSearch
https://github.com/dachcom-digital/pimcore-dynamic-search
pimcore providers search
Last synced: about 1 year ago
JSON representation
Pimcore Search Bundle. Data Provider: Search via Crawler, ObjectList. Index Provider: Store via Lucene, Elasticsearch or OpenSearch
- Host: GitHub
- URL: https://github.com/dachcom-digital/pimcore-dynamic-search
- Owner: dachcom-digital
- License: other
- Created: 2019-03-15T13:21:30.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-06T11:21:28.000Z (over 1 year ago)
- Last Synced: 2025-03-29T03:08:50.337Z (about 1 year ago)
- Topics: pimcore, providers, search
- Language: PHP
- Homepage:
- Size: 710 KB
- Stars: 33
- Watchers: 17
- Forks: 11
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Pimcore - Dynamic Search
[](LICENSE.md)
[](LICENSE.md)
[](https://packagist.org/packages/dachcom-digital/dynamic-search)
[](https://github.com/dachcom-digital/pimcore-dynamic-search/actions?query=workflow%3ACodeception+branch%3Amaster)
[](https://github.com/dachcom-digital/pimcore-dynamic-search/actions?query=workflow%3A"PHP+Stan"+branch%3Amaster)
### Release Plan
| Release | Supported Pimcore Versions | Supported Symfony Versions | Release Date | Maintained | Branch |
|---------|----------------------------|----------------------------|--------------|----------------|---------------------------------------------------------------------------|
| **4.x** | `11.0` | `^6.4` | 03.06.2024 | Feature Branch | master |
| **3.x** | `11.0` | `^6.2` | 28.09.2023 | Bugfixes | [3.x](https://github.com/dachcom-digital/pimcore-dynamic-search/tree/3.x) |
| **2.x** | `10.0` - `10.6` | `^5.4` | 19.12.2021 | No | [2.x](https://github.com/dachcom-digital/pimcore-dynamic-search/tree/2.x) |
| **1.x** | `6.6` - `6.9` | `^4.4` | 18.04.2021 | No | [1.x](https://github.com/dachcom-digital/pimcore-dynamic-search/tree/1.x) |
## Introduction
The Dynamic Search Bundle allows you to redefine your search strategy.
It's based on several data- and index providers.
## Providers
There are several data- and index providers available:
### Data Provider
- [WebCrawler](https://github.com/dachcom-digital/pimcore-dynamic-search-data-provider-crawler) | Fetch data by crawling urls [_legacy, not recommended_]
- [Trinity Data](https://github.com/dachcom-digital/pimcore-dynamic-search-data-provider-trinity) | Fetch pimcore entities: object, asset, document
### Index Provider
- [Lucene Search](https://github.com/dachcom-digital/pimcore-dynamic-search-index-provider-lucene) | Use the php lucene index. Not superfast but comes without any dependencies but php [_legacy, not recommended_]
- [Elasticsearch](https://github.com/dachcom-digital/pimcore-dynamic-search-index-provider-elasticsearch) | Index data with an elasticsearch instance.
- [Open Search](https://github.com/dachcom-digital/pimcore-dynamic-search-index-provider-opensearch) | Index data with an open search instance.
## Installation
```json
"require" : {
"dachcom-digital/dynamic-search" : "~4.0.0"
}
```
Add Bundle to `bundles.php`:
```php
return [
DynamicSearchBundle\DynamicSearchBundle::class => ['all' => true],
];
```
- Execute: `$ bin/console pimcore:bundle:install DynamicSearchBundle`
- Execute optionally: `$ bin/console messenger:setup-transports`
## Upgrading
- Execute: `$ bin/console doctrine:migrations:migrate --prefix 'DynamicSearchBundle\Migrations'`
## Provider Installation
You need at least one data- and one index provider. They have to be installed separately.
Please check out install instruction of each provider (see list above).
## Add Routes
```yaml
# config/routes.yaml
dynamic_search_frontend:
resource: '@DynamicSearchBundle/config/pimcore/routing/frontend_routing.yaml'
```
## Start Queue Worker
```
$ bin/console messenger:consume dynamic_search_queue
```
Read more details about the queue worker and the recommended setup [here](docs/01_DispatchWorkflow.md#queue-worker).
## Dispatch Dynamic Search
After you've added [a definition](docs/0_ExampleSetup.md), you're ready to start the engine.
Always use the verbose `-v` flag, otherwise you won't get any process information about the ongoing data / index providing process.
```bash
$ bin/console dynamic-search:run -v
```
## Further Information
- [Example Setup](docs/0_ExampleSetup.md)
- [Dispatch Workflow](docs/01_DispatchWorkflow.md)
- Configuration
- [Context Guard](docs/200_ContextGuard.md)
- Document Definition
- Logging
- Data Creation
- [Resource Validation](docs/40_ResourceValidator.md)
- Enable automatic Update / Insert / Delete Service
- Data Fetching
- [Output Channels](docs/30_OutputChannels.md)
- [Create Output Channel](docs/300_CreateOutputChannel.md)
- [Channel Filter / Actions](docs/302_ChannelFilterActions.md)
- Multi Search Channels
- Filter (Faceted Search / Aggregation)
- Create Filter Definition
- [Backend UI](docs/50_BackendUI.md)
- API
***
## Upgrade Info
Before updating, please [check our upgrade notes!](UPGRADE.md)
## License
**DACHCOM.DIGITAL AG**, Löwenhofstrasse 15, 9424 Rheineck, Schweiz
[dachcom.com](https://www.dachcom.com), dcdi@dachcom.ch
Copyright © 2025 DACHCOM.DIGITAL. All rights reserved.
For licensing details please visit [LICENSE.md](LICENSE.md)