Elasticsearch integration and ActiveRecord for the Yii framework

Fund package maintenance!
Open Collective

Installs: 569 653

Dependents: 22

Suggesters: 0

Security: 1

Stars: 386

Watchers: 46

Forks: 231

Open Issues: 13


2.1.0 2020-07-21 18:53 UTC



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.

Latest Stable Version Total Downloads Build Status


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.6.0 to 1.7.6.
  • Extension version 2.1.x requires Elasticsearch version 5.x.

Note: to provide the work necessary a requests to the delete by query, in Elasticsearch since version 2.0, you should to install the plugin delete-by-query


The preferred way to install this extension is through composer:

composer require --prefer-dist yiisoft/yii2-elasticsearch:"~2.1.0"


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' => ''],
                // configure more hosts if you have a cluster
            'dslVersion' => 7, // default is 5