imsamurai/elasticsearch-source

Elasticsearch source for CakePHP (HttpSource)

ElasticsearchSource Plugin

, _(*1)

CakePHP ElasticsearchSource is DataSource Plugin for Elasticsearch, _(*2)

Installation

Step 1: Clone or download HttpSource

Step 2: Clone or download to Plugin/ElasticsearchSource

cd my_cake_app/app git://github.com/imsamurai/CakePHP-ElasticsearchSource-Datasource.git Plugin/ElasticsearchSource, _(*3)

or if you use git add as submodule:, _(*4)

cd my_cake_app
git submodule add "git://github.com/imsamurai/CakePHP-ElasticsearchSource-Datasource.git" "app/Plugin/ElasticsearchSource"

then update submodules:, _(*5)

git submodule init
git submodule update

Step 3: Add your configuration to database.php and set it to the model

:: database.php ::

```php public $elasticsearch = array( 'datasource' => 'ElasticsearchSource.Http/ElasticsearchSource', 'host' => 'example.com', 'port' => 'some port' ); public $elasticsearchTest = array( 'datasource' => 'ElasticsearchSource.Http/ElasticsearchSource', 'host' => 'localhost', 'prefix' => '', 'port' => 9200, 'timeout' => 5 );, <sub>(*6)</sub>

Then make model

:: Elasticsearch.php ::, <sub>(*7)</sub>

```php
public $useDbConfig = 'elasticsearch';
public $useTable = '<desired endpoint, for ex: "_search">';

Step 4: Load plugin

:: bootstrap.php ::

```php CakePlugin::load('HttpSource', array('bootstrap' => true, 'routes' => true)); CakePlugin::load('ElasticsearchSource', array('bootstrap' => false, 'routes' => true));, <sub>(*8)</sub>

#Tests

To run tests add and fill $elasticsearchTest in `database.php`

#Usage

You can use elasticsearch almost as db tables:
```php
$this->Elasticsearch->setSource('search');
    $params = array(
        'conditions' => array(
            'query' => array(
                "term" => array("title" => "apple")
            )
        ),
        'fields' => array('title', 'rank'),
        'order' => array('rank' => 'desc'),
        'offset' => 2
    );

$result = $this->Elasticsearch->find('first', $params);

Documentation

Please read HttpSource Plugin README, <sub>(*9)</sub>