yiisoft/yii2-elasticsearch API Documentation 2.1
This is the API Documentation for the yiisoft/yii2-elasticsearch extension. Here you will find detailed information about all classes provided by this extension. Below you find a list of the existing classes, interfaces, and traits, ordered by their fully qualified name (including the namespace). Each of them has a dedicated page which contains a description about the purpose of the class, a list of the available methods, properties and constants, and detailed description on how to use each of them.
On this page you find all the classes included in version 2.1 of the extension. You can use the dropdown menu on the top right to switch between versions.
| Class | Description |
|---|---|
| yii\elasticsearch\ActiveDataProvider | ActiveDataProvider is an enhanced version of \yii\data\ActiveDataProvider specific to the Elasticsearch. |
| yii\elasticsearch\ActiveFixture | ActiveFixture represents a fixture for testing backed up by an modelClass or an elastic search index. |
| yii\elasticsearch\ActiveQuery | ActiveQuery represents a yii\elasticsearch\Query associated with an yii\elasticsearch\ActiveRecord class. |
| yii\elasticsearch\ActiveRecord | ActiveRecord is the base class for classes representing relational data in terms of objects. |
| yii\elasticsearch\BatchQueryResult | BatchQueryResult represents a batch query from which you can retrieve data in batches. |
| yii\elasticsearch\BulkCommand | The yii\elasticsearch\BulkCommand class implements the API for accessing the Elasticsearch bulk REST API. |
| yii\elasticsearch\Command | The Command class implements the API for accessing the Elasticsearch REST API. |
| yii\elasticsearch\Connection | Elasticsearch Connection is used to connect to an Elasticsearch cluster version 0.20 or higher |
| yii\elasticsearch\DebugAction | Debug Action is used by yii\elasticsearch\DebugPanel to perform Elasticsearch queries using ajax. |
| yii\elasticsearch\DebugPanel | Debugger panel that collects and displays Elasticsearch queries performed. |
| yii\elasticsearch\ElasticsearchTarget | ElasticsearchTarget stores log messages in a Elasticsearch index. |
| yii\elasticsearch\Exception | Exception represents an exception that is caused by Elasticsearch-related operations. |
| yii\elasticsearch\Query | Query represents a query to the search API of Elasticsearch. |
| yii\elasticsearch\QueryBuilder | QueryBuilder builds an Elasticsearch query based on the specification given as a yii\elasticsearch\Query object. |