la-haute-societe / yii2-elasticsearch
Elasticsearch integration and ActiveRecord for the Yii framework
Installs: 1 550
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 7
Forks: 253
Type:yii2-extension
Requires
- ext-curl: *
- yiisoft/yii2: ~2.0.14
This package is auto-updated.
Last update: 2024-11-26 22:37:35 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.
Requirements
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.0 to 4.x.
- Extension version 2.1.x requires at least elasticsearch version 5.0.
Installation
The preferred way to install this extension is through composer.
Either run
php composer.phar require --prefer-dist yiisoft/yii2-elasticsearch:"~2.0.0"
or add
"yiisoft/yii2-elasticsearch": "~2.0.0"
to the require section of your composer.json.
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 ], ], ] ];