Inheritance | yii\elasticsearch\Command » yii\base\Component » yii\base\Object |
---|---|
Implements | yii\base\Configurable |
Available since version | 2.0 |
Source Code | https://github.com/yiisoft/yii2-elasticsearch/blob/master/Command.php |
The Command class implements the API for accessing the elasticsearch REST API.
Check the elasticsearch guide for details on these commands.
Property | Type | Description | Defined By |
---|---|---|---|
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
$db | yii\elasticsearch\Connection | yii\elasticsearch\Command | |
$index | string|array | The indexes to execute the query on. | yii\elasticsearch\Command |
$indexStatus | mixed | yii\elasticsearch\Command | |
$mapping | mixed | yii\elasticsearch\Command | |
$options | array | Options to be appended to the query URL, such as "search_type" for search or "timeout" for delete | yii\elasticsearch\Command |
$queryParts | array | List of arrays or json strings that become parts of a query | yii\elasticsearch\Command |
$type | string|array | The types to execute the query on. | yii\elasticsearch\Command |
Method | Description | Defined By |
---|---|---|
__call() | Calls the named method which is not a class method. | yii\base\Component |
__clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
__construct() | Constructor. | yii\base\Object |
__get() | Returns the value of a component property. | yii\base\Component |
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
__set() | Sets the value of a component property. | yii\base\Component |
__unset() | Sets a component property to be null. | yii\base\Component |
attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
className() | Returns the fully qualified name of this class. | yii\base\Object |
clearIndexCache() | yii\elasticsearch\Command | |
clearScroll() | yii\elasticsearch\Command | |
closeIndex() | yii\elasticsearch\Command | |
createIndex() | Creates an index | yii\elasticsearch\Command |
createTemplate() | yii\elasticsearch\Command | |
delete() | Deletes a document from the index | yii\elasticsearch\Command |
deleteAllIndexes() | Deletes all indexes | yii\elasticsearch\Command |
deleteByQuery() | Sends a request to the delete by query | yii\elasticsearch\Command |
deleteIndex() | Deletes an index | yii\elasticsearch\Command |
deleteMapping() | yii\elasticsearch\Command | |
deleteTemplate() | yii\elasticsearch\Command | |
detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
exists() | Gets a document from the index | yii\elasticsearch\Command |
flushIndex() | yii\elasticsearch\Command | |
get() | Gets a document from the index | yii\elasticsearch\Command |
getBehavior() | Returns the named behavior object. | yii\base\Component |
getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
getIndexStatus() | yii\elasticsearch\Command | |
getMapping() | yii\elasticsearch\Command | |
getSource() | Gets a documents _source from the index (>=v0.90.1) | yii\elasticsearch\Command |
getTemplate() | yii\elasticsearch\Command | |
hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
indexExists() | Checks whether an index exists | yii\elasticsearch\Command |
init() | Initializes the object. | yii\base\Object |
insert() | Inserts a document into an index | yii\elasticsearch\Command |
mget() | Gets multiple documents from the index | yii\elasticsearch\Command |
off() | Detaches an existing event handler from this component. | yii\base\Component |
on() | Attaches an event handler to an event. | yii\base\Component |
openIndex() | yii\elasticsearch\Command | |
refreshIndex() | yii\elasticsearch\Command | |
scroll() | yii\elasticsearch\Command | |
search() | Sends a request to the _search API and returns the result | yii\elasticsearch\Command |
setMapping() | yii\elasticsearch\Command | |
suggest() | Sends a request to the _suggest API and returns the result | yii\elasticsearch\Command |
trigger() | Triggers an event. | yii\base\Component |
typeExists() | yii\elasticsearch\Command | |
update() | Updates a document | yii\elasticsearch\Command |
updateAnalyzers() | Define new analyzers for the index. | yii\elasticsearch\Command |
updateSettings() | Change specific index level settings in real time. | yii\elasticsearch\Command |
public yii\elasticsearch\Connection $db = null
The indexes to execute the query on. Defaults to null meaning all indexes
public string|array $index = null
public mixed getIndexStatus ( $index = '_all' )
public mixed getMapping ( $index = '_all', $type = null )
Options to be appended to the query URL, such as "search_type" for search or "timeout" for delete
public array $options = []
List of arrays or json strings that become parts of a query
public array $queryParts = null
The types to execute the query on. Defaults to null meaning all types
public string|array $type = null
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-clearcache.html.
public mixed clearIndexCache ( $index ) | ||
---|---|---|
$index |
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html.
public mixed clearScroll ( $options = [] ) | ||
---|---|---|
$options | array |
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-open-close.html.
public mixed closeIndex ( $index ) | ||
---|---|---|
$index |
Creates an index
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html.
public mixed createIndex ( $index, $configuration = null ) | ||
---|---|---|
$index | ||
$configuration | array |
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html.
public mixed createTemplate ( $name, $pattern, $settings, $mappings, $order = 0 ) | ||
---|---|---|
$name | ||
$pattern | ||
$settings | ||
$mappings | ||
$order | integer |
Deletes a document from the index
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html.
public mixed delete ( $index, $type, $id, $options = [] ) | ||
---|---|---|
$index | ||
$type | ||
$id | ||
$options | array |
Deletes all indexes
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-index.html.
public mixed deleteAllIndexes ( ) |
---|
Sends a request to the delete by query
public mixed deleteByQuery ( $options = [] ) | ||
---|---|---|
$options | array |
Deletes an index
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-index.html.
public mixed deleteIndex ( $index ) | ||
---|---|---|
$index |
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-mapping.html.
public mixed deleteMapping ( $index, $type ) | ||
---|---|---|
$index | ||
$type |
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html.
public mixed deleteTemplate ( $name ) | ||
---|---|---|
$name |
Gets a document from the index
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html.
public mixed exists ( $index, $type, $id ) | ||
---|---|---|
$index | ||
$type | ||
$id |
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-flush.html.
public mixed flushIndex ( $index = '_all' ) | ||
---|---|---|
$index |
Gets a document from the index
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html.
public mixed get ( $index, $type, $id, $options = [] ) | ||
---|---|---|
$index | ||
$type | ||
$id | ||
$options | array |
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-status.html.
public mixed getIndexStatus ( $index = '_all' ) | ||
---|---|---|
$index |
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-mapping.html.
public mixed getMapping ( $index = '_all', $type = null ) | ||
---|---|---|
$index | string | |
$type | string |
Gets a documents _source from the index (>=v0.90.1)
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#_source.
public mixed getSource ( $index, $type, $id ) | ||
---|---|---|
$index | ||
$type | ||
$id |
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html.
public mixed getTemplate ( $name ) | ||
---|---|---|
$name |
Checks whether an index exists
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-exists.html.
public mixed indexExists ( $index ) | ||
---|---|---|
$index |
Inserts a document into an index
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html.
public mixed insert ( $index, $type, $data, $id = null, $options = [] ) | ||
---|---|---|
$index | string | |
$type | string | |
$data | string|array |
Json string or array of data to store |
$id | null |
The documents id. If not specified Id will be automatically chosen |
$options | array |
Gets multiple documents from the index
TODO allow specifying type and index + fields
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html.
public mixed mget ( $index, $type, $ids, $options = [] ) | ||
---|---|---|
$index | ||
$type | ||
$ids | ||
$options | array |
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-open-close.html.
public mixed openIndex ( $index ) | ||
---|---|---|
$index |
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-refresh.html.
public mixed refreshIndex ( $index ) | ||
---|---|---|
$index |
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html.
public mixed scroll ( $options = [] ) | ||
---|---|---|
$options | array |
Sends a request to the _search API and returns the result
public mixed search ( $options = [] ) | ||
---|---|---|
$options | array |
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-mapping.html.
public mixed setMapping ( $index, $type, $mapping, $options = [] ) | ||
---|---|---|
$index | string | |
$type | string | |
$mapping | string|array | |
$options | array |
Sends a request to the _suggest API and returns the result
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html.
public mixed suggest ( $suggester, $options = [] ) | ||
---|---|---|
$suggester | string|array |
The suggester body |
$options | array |
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-types-exists.html.
public mixed typeExists ( $index, $type ) | ||
---|---|---|
$index | ||
$type |
Updates a document
See also http://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html.
public mixed update ( $index, $type, $id, $data, $options = [] ) | ||
---|---|---|
$index | ||
$type | ||
$id | ||
$data | ||
$options | array |
Define new analyzers for the index.
For example if content analyzer hasn’t been defined on "myindex" yet you can use the following commands to add it:
$setting = [ 'analysis' => [ 'analyzer' => [ 'ngram_analyzer_with_filter' => [ 'tokenizer' => 'ngram_tokenizer', 'filter' => 'lowercase, snowball' ], ], 'tokenizer' => [ 'ngram_tokenizer' => [ 'type' => 'nGram', 'min_gram' => 3, 'max_gram' => 10, 'token_chars' => ['letter', 'digit', 'whitespace', 'punctuation', 'symbol'] ], ], ] ]; $elasticQuery->createCommand()->updateAnalyzers('myindex', $setting);
public mixed updateAnalyzers ( $index, $setting, $options = [] ) | ||
---|---|---|
$index | string | |
$setting | string|array | |
$options | array |
URL options |
Change specific index level settings in real time.
Note that update analyzers required to \yii\elasticsearch\close() the index first and \yii\elasticsearch\open() it after the changes are made, use updateAnalyzers() for it.
See also http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-update-settings.html.
public mixed updateSettings ( $index, $setting, $options = [] ) | ||
---|---|---|
$index | string | |
$setting | string|array | |
$options | array |
URL options |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-elasticsearch-command.html