README

Elasticsearch Query and ActiveRecord for Yii 2

This extension provides the elasticsearch integration for the Yii framework 2.0. It includes basic querying/search support and also implements the ActiveRecord pattern that allows you to store active records in elasticsearch.

For license information check the LICENSE-file.

Documentation is at docs/guide/README.md.

Requirements

Dependent on the version of elasticsearch you are using you need a different version of this extension.

• Extension version 2.0.x works with elasticsearch version 1.0 to 4.x.
• Extension version 2.1.x requires at least elasticsearch version 5.0.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist yiisoft/yii2-elasticsearch:"~2.0.0"

or add

"yiisoft/yii2-elasticsearch": "~2.0.0"

to the require section of your composer.json.

Configuration

To use this extension, you have to configure the Connection class in your application configuration:

return [
    //....
    'components' => [
        'elasticsearch' => [
            'class' => 'yii\elasticsearch\Connection',
            'nodes' => [
                ['http_address' => '127.0.0.1:9200'],
                // configure more hosts if you have a cluster
            ],
        ],
    ]
];