Skip to content

Yii 2 Elasticsearch extension

License

Notifications You must be signed in to change notification settings

yiisoft/yii2-elasticsearch

Folders and files

NameName
Last commit message
Last commit date

Latest commit

acfc056 · Feb 13, 2025
Jun 16, 2024
Jun 19, 2023
Oct 27, 2024
Jun 19, 2024
Jun 16, 2024
Mar 21, 2016
Mar 24, 2020
Feb 13, 2025
Apr 26, 2018
Jun 16, 2024
Jun 16, 2024
Jun 16, 2024

Repository files navigation

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

  • PHP 7.3 or higher.

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

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
        ],
    ]
];