yiisoft/yii2-elasticsearch

Elasticsearch integration and ActiveRecord for the Yii framework

Maintainers

Details

github.com/yiisoft/yii2-elasticsearch

Source

Issues

IRC

Forum

Wiki

Fund package maintenance!
Open Collective
Tidelift

Installs: 1 470 081

Dependents: 27

Suggesters: 0

Security: 1

Stars: 427

Watchers: 46

Forks: 253

Open Issues: 20

Type:yii2-extension

2.1.4 2023-05-22 21:00 UTC

Requires

Requires (Dev)

BSD-3-Clause 4d92af4e95c47fb633fb4a1018dd7a23ee285bfc

  • Carsten Brandt <mail.woop@cebe.cc>

searchelasticsearchactive-recordfulltextyii2

This package is auto-updated.

Last update: 2024-10-27 10:35:28 UTC

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.

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