elasticsearch/elasticsearch

PHP Client for Elasticsearch

, _(*1)

Elasticsearch PHP client

, _(*2)

This is the official PHP client for Elasticsearch., _(*3)

Download the latest version of Elasticsearch or sign-up for a free trial of Elastic Cloud., _(*4)

Contents

• Installation
• Connecting
• Usage
• Versioning
• Backward Incompatible Changes
• Mock the Elasticsearch client
• FAQ
• Contribute
• License

Installation

Refer to the Installation section of the getting started documentation., _(*5)

Connecting

Refer to the Connecting section of the getting started documentation., _(*6)

Usage

The elasticsearch-php client offers 400+ endpoints for interacting with Elasticsearch. A list of all these endpoints is available in the official documentation of Elasticsearch APIs., _(*7)

Here we reported the basic operation that you can perform with the client: index, search and delete., _(*8)

• Creating an index
• Indexing a document
• Getting documents
• Searching documents
• Updating documents
• Deleting documents
• Deleting an index

Versioning

This client is versioned and released alongside Elasticsearch server., _(*9)

To guarantee compatibility, use the most recent version of this library within the major version of the corresponding Enterprise Search implementation., _(*10)

For example, for Elasticsearch 7.16, use 7.16 of this library or above, but not 8.0., _(*11)

Compatibility

The Elasticsearch client is compatible with currently maintained PHP versions., _(*12)

Language clients are forward compatible; meaning that clients support communicating with greater or equal minor versions of Elasticsearch without breaking. It does not mean that the client automatically supports new features of newer Elasticsearch versions; it is only possible after a release of a new client version. For example, a 8.12 client version won't automatically support the new features of the 8.13 version of Elasticsearch, the 8.13 client version is required for that. Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made., _(*13)

Backward Incompatible Changes :boom:

The 8.0.0 version of elasticsearch-php contains a new implementation compared with 7.x. It supports PSR-7 for HTTP messages and PSR-18 for HTTP client communications., _(*14)

We tried to reduce the BC breaks as much as possible with 7.x but there are some (big) differences:, _(*15)

• we changed the namespace, now everything is under Elastic\Elasticsearch
• we used the elastic-transport-php library for HTTP communications;
• we changed the Exception model, using the namespace Elastic\Elasticsearch\Exception. All the exceptions extends the ElasticsearchException interface, as in 7.x
• we changed the response type of each endpoints using an Elasticsearch response class. This class wraps a a PSR-7 response allowing the access of the body response as array or object. This means you can access the API response as in 7.x, no BC break here! :angel:
• we changed the ConnectionPool in NodePool. The connection naming was ambigous since the objects are nodes (hosts)

You can have a look at the BREAKING_CHANGES file for more information., _(*16)

Mock the Elasticsearch client

If you need to mock the Elasticsearch client you just need to mock a PSR-18 HTTP Client., _(*17)

For instance, you can use the php-http/mock-client as follows:, _(*18)

use Elastic\Elasticsearch\ClientBuilder;
use Elastic\Elasticsearch\Response\Elasticsearch;
use Http\Mock\Client;
use Nyholm\Psr7\Response;

$mock = new Client(); // This is the mock client

$client = ClientBuilder::create()
    ->setHttpClient($mock)
    ->build();

// This is a PSR-7 response
$response = new Response(
    200, 
    [Elasticsearch::HEADER_CHECK => Elasticsearch::PRODUCT_NAME],
    'This is the body!'
);
$mock->addResponse($response);

$result = $client->info(); // Just calling an Elasticsearch endpoint

echo $result->asString(); // This is the body!

We are using the ClientBuilder::setHttpClient() to set the mock client. You can specify the response that you want to have using the addResponse($response) function. As you can see the $response is a PSR-7 response object. In this example we used the Nyholm\Psr7\Response object from the nyholm/psr7 project. If you are using PHPUnit you can even mock the ResponseInterface as follows:, _(*19)

$response = $this->createMock('Psr\Http\Message\ResponseInterface');

Notice: we added a special header in the HTTP response. This is the product check header, and it is required for guarantee that elasticsearch-php is communicating with an Elasticsearch server 8.0+., _(*20)

For more information you can read the Mock client section of PHP-HTTP documentation., _(*21)

FAQ 🔮

Where do I report issues with the client?

If something is not working as expected, please open an issue., _(*22)

Where else can I go to get help?

You can checkout the Elastic community discuss forums., _(*23)

Contribute 🚀

We welcome contributors to the project. Before you begin, some useful info..., _(*24)

• If you want to contribute to this project you need to subscribe to a Contributor Agreement.
• Before opening a pull request, please create an issue to discuss the scope of your proposal.
• If you want to send a PR for version 8.0 please use the 8.0 branch, for 8.1 use the 8.1 branch and so on.
• Never send PR to master unless you want to contribute to the development version of the client (master represents the next major version).
• Each PR should include a unit test using PHPUnit. If you are not familiar with PHPUnit you can have a look at the reference.

Thanks in advance for your contribution! :heart:, _(*25)

License 📗

MIT © Elastic, _(*26)