yii2-swiftmailer/extensions/elasticsearch/README.md

Elasticsearch Query and ActiveRecord for Yii 2

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

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

return [
	//....
	'components' => [
        'elasticsearch' => [
            'class' => 'yii\elasticsearch\Connection',
            'hosts' => [
                ['hostname' => 'localhost', 'port' => 9200],
                // configure more hosts if you have a cluster
            ],
        ],
	]
];

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require yiisoft/yii2-elasticsearch "*"

or add

"yiisoft/yii2-elasticsearch": "*"

to the require section of your composer.json.

Using the Query

TBD

Using the ActiveRecord

For general information on how to use yii's ActiveRecord please refer to the guide.

For defining an elasticsearch ActiveRecord class your record class needs to extend from yii\elasticsearch\ActiveRecord and implement at least the attributes() method to define the attributes of the record. The primary key (the _id field in elasticsearch terms) is represented by getId() and setId() and can not be changed. The primary key is not part of the attributes.

primary key can be defined via primaryKey() which defaults to id if not specified. The primaryKey needs to be part of the attributes so make sure you have an id attribute defined if you do not specify your own primary key.

The following is an example model called Customer:

class Customer extends \yii\elasticsearch\ActiveRecord
{
    public function attributes()
    {
        return ['id', 'name', 'address', 'registration_date'];
    }
}

You may override index() and type() to define the index and type this record represents.

The general usage of elasticsearch ActiveRecord is very similar to the database ActiveRecord as described in the guide. It supports the same interface and features except the following limitations and additions(!):

• As elasticsearch does not support SQL, the query API does not support join(), groupBy(), having() and union(). Sorting, limit, offset and conditional where are all supported.
• from() does not select the tables, but the index and type to query against.
• select() has been replaced with fields() which basically does the same but fields is more elasticsearch terminology. It defines the fields to retrieve from a document.
• via-relations can not be defined via a table as there are not tables in elasticsearch. You can only define relations via other records.
• As elasticsearch is a data storage and search engine there is of course support added for search your records. TBD ...
• It is also possible to define relations from elasticsearch ActiveRecords to normal ActiveRecord classes and vice versa.