README

Yii Database Elasticsearch Query and ActiveRecord

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

Requirements

Elasticsearch version 5.0 or higher.

Installation

The package could be installed with Composer:

composer require yiisoft/db-elasticsearch

General usage

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

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

Documentation

Guide: English, Français, 日本語
Internals

If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.

License

The Yii Database Elasticsearch Query and ActiveRecord is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.

yiisoft / db-elasticsearch

Maintainers

Details