shyim/opensearch-php-dsl

OpenSearch/Elasticsearch DSL library

1.0.6 2024-01-03 09:01 UTC

Requires

• php: ^7.4 || ^8.0 || ^8.1 || ^8.2 || ^8.3
• ext-json: *

Requires (Dev)

• friendsofphp/php-cs-fixer: *
• infection/infection: *
• phpstan/phpstan: *
• phpunit/phpunit: ^9.5.8

Suggests

• elasticsearch/elasticsearch: Client library querying with the actual server
• opensearch-project/opensearch-php: Client library querying with the actual server

MIT

• Soner Sayakci
• ONGR team

README

Introducing OpenSearch DSL library to provide objective query builder for opensearch-php client. You can easily build any Opensearch query and transform it to an array.

This is a fork of ongr-io/ElasticsearchDSL, which will be more regularly updated. Thanks for ongr-io for building this Library!

If you need any help, Github issues is the preferred and recommended way to ask support questions.

Version matrix

OpenSearch version	OpenSearchDSL version
>= 1.0	>= 1.0
>= 2.0	>= 1.0

Documentation

The online documentation of the bundle is here

Try it!

Installation

Install library with composer:

$ composer require shyim/opensearch-php-dsl

elasticsearch-php client is defined in the composer requirements, no need to install it.

Search

The library is standalone and is not coupled with any framework. You can use it in any PHP project, the only requirement is composer. Here's the example:

Create search:

<?php

require 'vendor/autoload.php'; //Composer autoload

$client = ClientBuilder::create()->build(); //opensearch-php client

$matchAll = new OpenSearchDSL\Query\MatchAllQuery();

$search = new OpenSearchDSL\Search();
$search->addQuery($matchAll);

$params = [
'index' => 'your_index',
'body' => $search->toArray(),
];

$results = $client->search($params);

Opensearch DSL covers every Opensearch query, all examples can be found in the documentation