Weave Code
Elasticsearch Client Laravel Package
pimcore/elasticsearch-client
Integrates Elasticsearch with Pimcore, offering client services and utilities for indexing and querying Pimcore data. Simplifies building search features using Elasticsearch while staying within Pimcore’s service architecture.
At a glance
Frequently asked questions about Elasticsearch Client
- Is pimcore/elasticsearch-client a Laravel package?
- No. It is a Pimcore package that sits under Pimcore's indexing stack and wraps the official Elasticsearch PHP client with Pimcore-aware services and defaults. Laravel is only relevant if you are integrating a Pimcore backend or deliberately reusing the client wrapper outside Pimcore. For a normal Laravel application, the official Elasticsearch PHP client or a Laravel-specific search integration is usually a better fit.
- How do I install pimcore/elasticsearch-client?
- Install it with Composer using composer require pimcore/elasticsearch-client, then follow the package README to register and configure the Pimcore service. Because it is built around Pimcore's service architecture, installation normally happens inside a Pimcore application rather than a standalone Laravel project. Confirm the matching Pimcore release train and Elasticsearch baseline before using it in production.
- What Elasticsearch version does pimcore/elasticsearch-client require?
- As of version 2026.3.0, the minimum supported Elasticsearch version is 8.12.2. That is a hard floor, so Elasticsearch 7.x, OpenSearch, and older 8.x clusters are unsupported. In practice, target a currently supported Elasticsearch 8.x release rather than the literal minimum, and verify the version in every environment.
- Can I use pimcore/elasticsearch-client with Elasticsearch 7 or OpenSearch?
- No. Version 2026.3.0 raises the minimum to Elasticsearch 8.12.2, and the package is described as compatible with modern Elasticsearch versions. Elasticsearch 7.x and OpenSearch fall outside that supported baseline. If you are on those platforms, you need to upgrade the cluster or remain on an older package line.
- How do I define index settings and mappings with pimcore/elasticsearch-client?
- The package provides configurable index definitions and mappings, so you describe index settings centrally instead of hand-building every Elasticsearch request. A Pimcore-aware client service and dependency injection handle the wiring for you. If another service, such as a Laravel app, also writes to the same indices, agree on who owns the mapping schema before you share it.
- Can pimcore/elasticsearch-client index Pimcore documents, assets, and data objects?
- Yes. The package is designed to index and query Pimcore elements, including documents, assets, and data objects, through a single client abstraction. It includes indexing helpers for Pimcore elements and custom data, plus extensible query and search abstractions. That makes it suitable for catalog search, full-text search, and custom filtering in Pimcore applications.
- Can I use pimcore/elasticsearch-client in a Laravel app without Pimcore?
- Only with caution. The package expects a Pimcore application context and brings Pimcore's index naming, mapping migration, and field conventions with it. Reusing the client wrapper standalone in Laravel means adopting those conventions in a non-Pimcore codebase, which is a meaningful architectural commitment. A safer pattern is to keep Laravel behind a service boundary and avoid sharing index mappings until ownership is agreed.
- What changed in pimcore/elasticsearch-client 2026.3.0 and does it support Symfony 8?
- Version 2026.3.0 is mostly CI and process hygiene: workflow renames, PR guardrails, thin policy callers, and a synced platform-version file. The functional change is raising the minimum Elasticsearch version to 8.12.2, and the release adds a central Symfony 8 compatibility check. There are no new public APIs, configuration surfaces, or deprecations, so application-level behaviour should be unchanged beyond the version gate. The Symfony 8 check signals lifecycle alignment with the Pimcore release train, but it also couples your upgrade cadence to that train.
- How do I test search features built with pimcore/elasticsearch-client?
- Test against an Elasticsearch cluster that matches production and is at least version 8.12.2, rather than mocking the client entirely. Use a disposable index and verify mappings, indexing helpers, and query abstractions with representative Pimcore documents, assets, and data objects. Add a smoke test that checks the deployed Elasticsearch version so the hard floor does not surprise you in CI.
- How should I upgrade pimcore/elasticsearch-client safely?
- Treat it as a leaf dependency driven by your Pimcore platform rather than an independently pinned component. Inventory the Elasticsearch cluster version in development, staging, and production first, because bumping this package without the matching Pimcore, Symfony, and Elasticsearch baseline is the most likely failure mode. Upgrade the platform and this package together, then re-index and run search smoke tests in a non-production environment before cutting over.
Weaver
How can I help you explore Laravel packages today?