Skip to content
This repository

Simple PHP client for ElasticSearch

branch: master

Build Status

ElasticSearch PHP client

ElasticSearch is a distributed lucene powered search indexing, this is a PHP client for it


Initial setup

  1. Install composer. curl -s | php
  2. Create composer.json containing:

        "require" : {
            "nervetattoo/elasticsearch" : ">=2.0"
  3. Run ./composer.phar install
  4. Keep up-to-date: ./composer.phar update

Indexing and searching

require_once __DIR__ . '/vendor/autoload.php';

use \ElasticSearch\Client;
// The recommended way to go about things is to use an environment variable called ELASTICSEARCH_URL
$es = Client::connection();

// Alternatively you can use dsn string
$es = Client::connection('');

$es->index(array('title' => 'My cool document'), $id);

Creating mapping

    'title' => array(
        'type' => 'string',
    'index' => 'analyzed'

Search multiple indexes or types

$results = $es
    ->setIndex(array("one", "two"))
    ->setType(array("mytype", "other-type"))

Using the Query DSL

    'query' => array(
        'term' => array('title' => 'cool')

Provide configuration as array

Using an array for configuration also works

$es = Client::connection(array(
    'servers' => '',
    'protocol' => 'http',
    'index' => 'myindex',
    'type' => 'mytype'

Support for Routing

$document = array(
    'title' => 'My routed document',
    'user_id' => '42' 
$es->index($document, $id, array('routing' => $document['user_id']));
$es->search('title:routed', array('routing' => '42'));

Support for Bulking

$document = array(
    'title' => 'My bulked entry',
    'user_id' => '43' 
$es->index($document, $id, array('routing' => $document['user_id']));

    ->index($document, $id, 'myIndex', 'myType', array('parent' => $parentId));

Something went wrong with that request. Please try again.