README

👁 Image

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
👁 codecov

Requirements

Depending on the version of Elasticsearch you are using you need a different version of this extension.

• For Elasticsearch 1.6.0 to 1.7.6 use extension version 2.0.x
• For Elasticsearch 5.x or above use extension version 2.1.x

Installation

Important

• The minimum required PHP version is PHP 7.4.
• It works best with PHP 8.

The preferred way to install this extension is through composer:

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

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
 ],
 'dslVersion' => 7, // default is 5
 ],
 ]
];