Class yii\elasticsearch\Command

All Classes | Properties | Methods

Inheritance	yii\elasticsearch\Command » yii\base\Component
Available since version	2.0

The Command class implements the API for accessing the elasticsearch REST API.

Check the elasticsearch guide for details on these commands.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$db	yii\elasticsearch\Connection		yii\elasticsearch\Command
$index	string\|array	The indexes to execute the query on.	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

Public Methods

Hide inherited methods

Method	Description	Defined By
addAlias()		yii\elasticsearch\Command
aliasActions()	Runs alias manipulations.	yii\elasticsearch\Command
aliasExists()		yii\elasticsearch\Command
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
exists()	Gets a document from the index	yii\elasticsearch\Command
flushIndex()		yii\elasticsearch\Command
get()	Gets a document from the index	yii\elasticsearch\Command
getAliasInfo()		yii\elasticsearch\Command
getIndexAliases()		yii\elasticsearch\Command
getIndexInfoByAlias()		yii\elasticsearch\Command
getIndexStatus()		yii\elasticsearch\Command
getIndexesByAlias()		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
indexExists()	Checks whether an index exists	yii\elasticsearch\Command
insert()	Inserts a document into an index	yii\elasticsearch\Command
mget()	Gets multiple documents from the index	yii\elasticsearch\Command
openIndex()		yii\elasticsearch\Command
refreshIndex()		yii\elasticsearch\Command
removeAlias()		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
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

Property Details

$db public property

public yii\elasticsearch\Connection $db = null

$index public property

The indexes to execute the query on. Defaults to null meaning all indexes

public string|array $index = null

$options public property

Options to be appended to the query URL, such as "search_type" for search or "timeout" for delete

public array $options = []

$queryParts public property

List of arrays or json strings that become parts of a query

public array $queryParts = null

$type public property

The types to execute the query on. Defaults to null meaning all types

public string|array $type = null

Method Details

addAlias() public method

public boolean addAlias ( $index, $alias, $aliasParameters = [] )
$index
$alias
$aliasParameters	array

aliasActions() public method

Runs alias manipulations.

If you want to add alias1 to index1 and remove alias2 from index2 you can use following commands: ~~~ $actions = [

 ['add' => ['index' => 'index1', 'alias' => 'alias1']],
 ['remove' => ['index' => 'index2', 'alias' => 'alias2']],

]; ~~~

public boolean aliasActions ( array $actions )
$actions	array

aliasExists() public method

public boolean aliasExists ( $alias )
$alias	string

clearIndexCache() public method

public mixed clearIndexCache ( $index )
$index

clearScroll() public method (available since version 2.0.4)

public mixed clearScroll ( $options = [] )
$options	array

closeIndex() public method

public mixed closeIndex ( $index )
$index

createIndex() public method

Creates an index

public mixed createIndex ( $index, $configuration = null )
$index
$configuration	array

createTemplate() public method

public mixed createTemplate ( $name, $pattern, $settings, $mappings, $order = 0 )
$name
$pattern
$settings
$mappings
$order	integer

delete() public method

Deletes a document from the index

public mixed delete ( $index, $type, $id, $options = [] )
$index
$type
$id
$options	array

deleteAllIndexes() public method

Deletes all indexes

public mixed deleteAllIndexes ( )

deleteByQuery() public method

Sends a request to the delete by query

public mixed deleteByQuery ( $options = [] )
$options	array

deleteIndex() public method

Deletes an index

public mixed deleteIndex ( $index )
$index

deleteMapping() public method

public mixed deleteMapping ( $index, $type )
$index
$type

deleteTemplate() public method

public mixed deleteTemplate ( $name )
$name

exists() public method

Gets a document from the index

public mixed exists ( $index, $type, $id )
$index
$type
$id

flushIndex() public method

public mixed flushIndex ( $index = '_all' )
$index

get() public method

Gets a document from the index

public mixed get ( $index, $type, $id, $options = [] )
$index
$type
$id
$options	array

getAliasInfo() public method

public array getAliasInfo ( )

getIndexAliases() public method

public array getIndexAliases ( $index )
$index	string

getIndexInfoByAlias() public method

public array getIndexInfoByAlias ( $alias )
$alias	string

getIndexStatus() public method

public mixed getIndexStatus ( $index = '_all' )
$index

getIndexesByAlias() public method

public array getIndexesByAlias ( $alias )
$alias	string

getMapping() public method

public mixed getMapping ( $index = '_all', $type = null )
$index	string
$type	string

getSource() public method

Gets a documents _source from the index (>=v0.90.1)

public mixed getSource ( $index, $type, $id )
$index
$type
$id

getTemplate() public method

public mixed getTemplate ( $name )
$name

indexExists() public method

Checks whether an index exists

public mixed indexExists ( $index )
$index

insert() public method

Inserts a document into an index

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

mget() public method

Gets multiple documents from the index

TODO allow specifying type and index + fields

public mixed mget ( $index, $type, $ids, $options = [] )
$index
$type
$ids
$options	array

openIndex() public method

public mixed openIndex ( $index )
$index

refreshIndex() public method

public mixed refreshIndex ( $index )
$index

removeAlias() public method

public boolean removeAlias ( $index, $alias )
$index	string
$alias	string

scroll() public method (available since version 2.0.4)

public mixed scroll ( $options = [] )
$options	array

search() public method

Sends a request to the _search API and returns the result

public mixed search ( $options = [] )
$options	array

setMapping() public method

public mixed setMapping ( $index, $type, $mapping, $options = [] )
$index	string
$type	string
$mapping	string\|array
$options	array

suggest() public method

Sends a request to the _suggest API and returns the result

public mixed suggest ( $suggester, $options = [] )
$suggester	string\|array	The suggester body
$options	array

typeExists() public method

public mixed typeExists ( $index, $type )
$index
$type

update() public method

Updates a document

public mixed update ( $index, $type, $id, $data, $options = [] )
$index
$type
$id
$data
$options	array

updateAnalyzers() public method (available since version 2.0.4)

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

updateSettings() public method (available since version 2.0.4)

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.

public mixed updateSettings ( $index, $setting, $options = [] )
$index	string
$setting	string\|array
$options	array	URL options