A Symfony bundle providing native OpenSearch integration. Inspired by FOSElasticaBundle, built for OpenSearch from the ground up.
- Multiple OpenSearch client support
- Automatic Doctrine ORM synchronization
- Blue/green reindexing with alias switching
- Configurable object transformation (reflection, Symfony Serializer)
- Repository pattern for search queries
- Index templates
- Event-driven extensibility (7 lifecycle events)
- Console commands for index management
- PHP 8.1+
- Symfony 6.4 / 7.x / 8.x
- OpenSearch 2.x
composer require bneumann/opensearch-bundleConfigure a client and an index:
# config/packages/opensearch.yaml
opensearch:
clients:
default:
hosts: ['https://localhost:9200']
username: '%env(OPENSEARCH_USER)%'
password: '%env(OPENSEARCH_PASS)%'
ssl_verification: true
indexes:
products:
index_name: 'products_%kernel.environment%'
settings:
number_of_shards: 1
number_of_replicas: 0
mappings:
properties:
name: { type: 'text' }
sku: { type: 'keyword' }
finder:
hydration: orm
persistence:
driver: orm
model: App\Entity\Product
provider: true
listener: true
identifier: idCreate and populate the index:
bin/console opensearch:index:create products
bin/console opensearch:index:populate productsSearch using the finder service:
use Bneumann\OpensearchBundle\Finder\FinderInterface;
public function __construct(private FinderInterface $finder) {}
$results = $this->finder->find([
'query' => [
'match' => ['name' => 'bike'],
],
]);Or use the repository pattern:
use Bneumann\OpensearchBundle\Repository\Repository;
final class ProductRepository extends Repository
{
public function findBySku(string $sku): iterable
{
return $this->search([
'query' => ['term' => ['sku' => $sku]],
]);
}
}See CONTRIBUTING.md for guidelines.
This bundle is released under the MIT License.