Elastica

A PHP client for elasticsearch.

Fork me on GitHub

Raw Array Query

Elasticsearch is evolving fast and not all queries and new features which are added to elasticsearch can be immediately added to Elastica. Still it is important that the developers can use all the new functionality. On the one side Elastica tries to map all request with objects which are then mapped to arrays and converted to a JSON string. Because of this it is possible to modify every requets with raw arrays. The basic of all this is the following function.

1

\Elastica\Client::request($path, $method = Request::GET, $data = array(), array $query = array())

The function has four params. The first one is the path that should be called, then the type of the Request, the data array which is normally the JSON string and additional query params which should be added to the url. Here is a simple example for a string query in a raw array.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

$client = new Client();

$index = $client->getIndex('test');
$index->create(array(), true);
$type = $index->getType('test');
$type->addDocument(new Document(1, array('username' => 'ruflin')));
$index->refresh();

$query = array(
    'query' => array(
        'query_string' => array(
            'query' => 'ruflin',
        )
    )
);

$path = $index->getName() . '/' . $type->getName() . '/_search';

$response = $client->request($path, Request::GET, $query);
$responseArray = $response->getData();

The content of the responseArray will be as following:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

Array
(
    [took] => 2
    [timed_out] =>
    [_shards] => Array
        (
            [total] => 5
            [successful] => 5
            [failed] => 0
        )

    [hits] => Array
        (
            [total] => 1
            [max_score] => 0.30685282
            [hits] => Array
                (
                    [0] => Array
                        (
                            [_index] => test
                            [_type] => test
                            [_id] => 1
                            [_score] => 0.30685282
                            [_source] => Array
                                (
                                    [username] => ruflin
                                )

                        )

                )

        )

)

To access the total number of hits, the following code is needed:

1

$totalHits = $responseArray['hits']['total'];

As it was a “raw” query Elastica didn’t know it was a query. That is also the reason the basic response object was returned instead of a ResultsSet. This array mapping can be used for every single elasticsearch request.

The same can also be done directly with a JSON string instead of an array for the query.