Class yii\elasticsearch\Command
Inheritance | yii\elasticsearch\Command » yii\base\Component » yii\base\BaseObject |
---|---|
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.
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$aliasInfo | array | yii\elasticsearch\Command | |
$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 |
$indexRecoveryStats | mixed | yii\elasticsearch\Command | |
$indexStats | 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|null | The types to execute the query on. | yii\elasticsearch\Command |
Public Methods
Property Details
The indexes to execute the query on. Defaults to null meaning all indexes
Options to be appended to the query URL, such as "search_type" for search or "timeout" for delete
List of arrays or json strings that become parts of a query
Method Details
Defined in: yii\base\Component::__call()
Calls the named method which is not a class method.
This method will check if any attached behavior has the named method and will execute it if available.
Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.
public mixed __call ( $name, $params ) | ||
$name | string |
The method name |
$params | array |
Method parameters |
return | mixed |
The method return value |
---|---|---|
throws | yii\base\UnknownMethodException |
when calling unknown method |
public function __call($name, $params)
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $object) {
if ($object->hasMethod($name)) {
return call_user_func_array([$object, $name], $params);
}
}
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
Defined in: yii\base\Component::__clone()
This method is called after the object is created by cloning an existing one.
It removes all behaviors because they are attached to the old object.
public void __clone ( ) |
public function __clone()
{
$this->_events = [];
$this->_eventWildcards = [];
$this->_behaviors = null;
}
Defined in: yii\base\BaseObject::__construct()
Constructor.
The default implementation does two things:
- Initializes the object with the given configuration
$config
. - Call init().
If this method is overridden in a child class, it is recommended that
- the last parameter of the constructor is a configuration array, like
$config
here. - call the parent implementation at the end of the constructor.
public void __construct ( $config = [] ) | ||
$config | array |
Name-value pairs that will be used to initialize the object properties |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
Defined in: yii\base\Component::__get()
Returns the value of a component property.
This method will check in the following order and act accordingly:
- a property defined by a getter: return the getter result
- a property of a behavior: return the behavior property value
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $value = $component->property;
.
See also __set().
public mixed __get ( $name ) | ||
$name | string |
The property name |
return | mixed |
The property value or the value of a behavior's property |
---|---|---|
throws | yii\base\UnknownPropertyException |
if the property is not defined |
throws | yii\base\InvalidCallException |
if the property is write-only. |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
// read property, e.g. getName()
return $this->$getter();
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name)) {
return $behavior->$name;
}
}
if (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
Defined in: yii\base\Component::__isset()
Checks if a property is set, i.e. defined and not null.
This method will check in the following order and act accordingly:
- a property defined by a setter: return whether the property is set
- a property of a behavior: return whether the property is set
- return
false
for non existing properties
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing isset($component->property)
.
public boolean __isset ( $name ) | ||
$name | string |
The property name or the event name |
return | boolean |
Whether the named property is set |
---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name)) {
return $behavior->$name !== null;
}
}
return false;
}
Defined in: yii\base\Component::__set()
Sets the value of a component property.
This method will check in the following order and act accordingly:
- a property defined by a setter: set the property value
- an event in the format of "on xyz": attach the handler to the event "xyz"
- a behavior in the format of "as xyz": attach the behavior named as "xyz"
- a property of a behavior: set the behavior property value
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $component->property = $value;
.
See also __get().
public void __set ( $name, $value ) | ||
$name | string |
The property name or the event name |
$value | mixed |
The property value |
throws | yii\base\UnknownPropertyException |
if the property is not defined |
---|---|---|
throws | yii\base\InvalidCallException |
if the property is read-only. |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
// set property
$this->$setter($value);
return;
} elseif (strncmp($name, 'on ', 3) === 0) {
// on event: attach event handler
$this->on(trim(substr($name, 3)), $value);
return;
} elseif (strncmp($name, 'as ', 3) === 0) {
// as behavior: attach behavior
$name = trim(substr($name, 3));
$this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
return;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name)) {
$behavior->$name = $value;
return;
}
}
if (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
Defined in: yii\base\Component::__unset()
Sets a component property to be null.
This method will check in the following order and act accordingly:
- a property defined by a setter: set the property value to be null
- a property of a behavior: set the property value to be null
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing unset($component->property)
.
public void __unset ( $name ) | ||
$name | string |
The property name |
throws | yii\base\InvalidCallException |
if the property is read only. |
---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
return;
}
// behavior property
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name)) {
$behavior->$name = null;
return;
}
}
throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}
See also https://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html#alias-adding.
public boolean addAlias ( $index, $alias, $aliasParameters = [] ) | ||
$index | string |
Index that the document belongs to. |
$alias | string | |
$aliasParameters | array | |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function addAlias($index, $alias, $aliasParameters = [])
{
return (bool)$this->db->put([$index, '_alias', $alias], [], json_encode((object)$aliasParameters));
}
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']],
]; ~~~
See also https://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html#indices-aliases.
public boolean aliasActions ( array $actions ) | ||
$actions | array | |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function aliasActions(array $actions)
{
return (bool)$this->db->post(['_aliases'], [], json_encode(['actions' => $actions]));
}
public boolean aliasExists ( $alias ) | ||
$alias | string | |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function aliasExists($alias)
{
$indexes = $this->getIndexesByAlias($alias);
return !empty($indexes);
}
Defined in: yii\base\Component::attachBehavior()
Attaches a behavior to this component.
This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the yii\base\Behavior::attach() method.
See also detachBehavior().
public yii\base\Behavior attachBehavior ( $name, $behavior ) | ||
$name | string |
The name of the behavior. |
$behavior | string|array|yii\base\Behavior |
The behavior configuration. This can be one of the following:
|
return | yii\base\Behavior |
The behavior object |
---|
public function attachBehavior($name, $behavior)
{
$this->ensureBehaviors();
return $this->attachBehaviorInternal($name, $behavior);
}
Defined in: yii\base\Component::attachBehaviors()
Attaches a list of behaviors to the component.
Each behavior is indexed by its name and should be a yii\base\Behavior object, a string specifying the behavior class, or an configuration array for creating the behavior.
See also attachBehavior().
public void attachBehaviors ( $behaviors ) | ||
$behaviors | array |
List of behaviors to be attached to the component |
public function attachBehaviors($behaviors)
{
$this->ensureBehaviors();
foreach ($behaviors as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
Defined in: yii\base\Component::behaviors()
Returns a list of behaviors that this component should behave as.
Child classes may override this method to specify the behaviors they want to behave as.
The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:
'behaviorName' => [
'class' => 'BehaviorClass',
'property1' => 'value1',
'property2' => 'value2',
]
Note that a behavior class must extend from yii\base\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.
Behaviors declared in this method will be attached to the component automatically (on demand).
public array behaviors ( ) | ||
return | array |
The behavior configurations. |
---|
public function behaviors()
{
return [];
}
Defined in: yii\base\Component::canGetProperty()
Returns a value indicating whether a property can be read.
A property can be read if:
- the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVars
is true); - an attached behavior has a readable property of the given name (when
$checkBehaviors
is true).
See also canSetProperty().
public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
The property name |
$checkVars | boolean |
Whether to treat member variables as properties |
$checkBehaviors | boolean |
Whether to treat behaviors' properties as properties of this component |
return | boolean |
Whether the property can be read |
---|
public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canGetProperty($name, $checkVars)) {
return true;
}
}
}
return false;
}
Defined in: yii\base\Component::canSetProperty()
Returns a value indicating whether a property can be set.
A property can be written if:
- the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVars
is true); - an attached behavior has a writable property of the given name (when
$checkBehaviors
is true).
See also canGetProperty().
public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
The property name |
$checkVars | boolean |
Whether to treat member variables as properties |
$checkBehaviors | boolean |
Whether to treat behaviors' properties as properties of this component |
return | boolean |
Whether the property can be written |
---|
public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->canSetProperty($name, $checkVars)) {
return true;
}
}
}
return false;
}
::class
instead.
Defined in: yii\base\BaseObject::className()
Returns the fully qualified name of this class.
public static string className ( ) | ||
return | string |
The fully qualified name of this class. |
---|
public static function className()
{
return get_called_class();
}
public mixed clearIndexCache ( $index ) | ||
$index | string |
Index that the document belongs to. |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function clearIndexCache($index)
{
return $this->db->post([$index, '_cache', 'clear']);
}
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html.
public mixed clearScroll ( $options = [] ) | ||
$options | array |
URL options |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function clearScroll($options = [])
{
$body = array_filter([
'scroll_id' => ArrayHelper::remove($options, 'scroll_id', null),
]);
if (empty($body)) {
$body = (object) [];
}
return $this->db->delete(['_search', 'scroll'], $options, Json::encode($body));
}
public mixed closeIndex ( $index ) | ||
$index | string |
Index that the document belongs to. |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function closeIndex($index)
{
return $this->db->post([$index, '_close']);
}
Creates an index
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html.
public mixed createIndex ( $index, $configuration = null ) | ||
$index | string |
Index that the document belongs to. |
$configuration | null|array | |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function createIndex($index, $configuration = null)
{
$body = $configuration !== null ? Json::encode($configuration) : null;
return $this->db->put([$index], [], $body);
}
public mixed createTemplate ( $name, $pattern, $settings, $mappings, $order = 0 ) | ||
$name | ||
$pattern | ||
$settings | ||
$mappings | ||
$order | integer | |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function createTemplate($name, $pattern, $settings, $mappings, $order = 0)
{
$body = Json::encode([
'template' => $pattern,
'order' => $order,
'settings' => (object) $settings,
'mappings' => (object) $mappings,
]);
return $this->db->put(['_template', $name], [], $body);
}
Deletes a document from the index
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html.
public mixed delete ( $index, $type, $id, $options = [] ) | ||
$index | string |
Index that the document belongs to. |
$type | string|null |
Type that the document belongs to. |
$id | string |
The documents id. |
$options | array |
URL options |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function delete($index, $type, $id, $options = [])
{
if ($this->db->dslVersion >= 7) {
return $this->db->delete([$index, '_doc', $id], $options);
} else {
return $this->db->delete([$index, $type, $id], $options);
}
}
Deletes all indexes
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-index.html.
public mixed deleteAllIndexes ( ) | ||
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function deleteAllIndexes()
{
return $this->db->delete(['_all']);
}
Sends a request to the delete by query
public mixed deleteByQuery ( $options = [] ) | ||
$options | array |
URL options |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function deleteByQuery($options = [])
{
if (!isset($this->queryParts['query'])) {
throw new InvalidCallException('Can not call deleteByQuery when no query is given.');
}
$query = [
'query' => $this->queryParts['query'],
];
if (isset($this->queryParts['filter'])) {
$query['filter'] = $this->queryParts['filter'];
}
$query = Json::encode($query);
$url = [$this->index !== null ? $this->index : '_all'];
if ($this->type !== null) {
$url[] = $this->type;
}
$url[] = '_delete_by_query';
return $this->db->post($url, array_merge($this->options, $options), $query);
}
Deletes an index
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-index.html.
public mixed deleteIndex ( $index ) | ||
$index | string |
Index that the document belongs to. |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function deleteIndex($index)
{
return $this->db->delete([$index]);
}
public mixed deleteTemplate ( $name ) | ||
$name | ||
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function deleteTemplate($name)
{
return $this->db->delete(['_template', $name]);
}
Defined in: yii\base\Component::detachBehavior()
Detaches a behavior from the component.
The behavior's yii\base\Behavior::detach() method will be invoked.
public yii\base\Behavior|null detachBehavior ( $name ) | ||
$name | string |
The behavior's name. |
return | yii\base\Behavior|null |
The detached behavior. Null if the behavior does not exist. |
---|
public function detachBehavior($name)
{
$this->ensureBehaviors();
if (isset($this->_behaviors[$name])) {
$behavior = $this->_behaviors[$name];
unset($this->_behaviors[$name]);
$behavior->detach();
return $behavior;
}
return null;
}
Defined in: yii\base\Component::detachBehaviors()
Detaches all behaviors from the component.
public void detachBehaviors ( ) |
public function detachBehaviors()
{
$this->ensureBehaviors();
foreach ($this->_behaviors as $name => $behavior) {
$this->detachBehavior($name);
}
}
Defined in: yii\base\Component::ensureBehaviors()
Makes sure that the behaviors declared in behaviors() are attached to this component.
public void ensureBehaviors ( ) |
public function ensureBehaviors()
{
if ($this->_behaviors === null) {
$this->_behaviors = [];
foreach ($this->behaviors() as $name => $behavior) {
$this->attachBehaviorInternal($name, $behavior);
}
}
}
Gets a document from the index
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html.
public mixed exists ( $index, $type, $id ) | ||
$index | string |
Index that the document belongs to. |
$type | string|null |
Type that the document belongs to. |
$id | string |
The documents id. |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function exists($index, $type, $id)
{
if ($this->db->dslVersion >= 7) {
return $this->db->head([$index, '_doc', $id]);
} else {
return $this->db->head([$index, $type, $id]);
}
}
public mixed flushIndex ( $index = '_all' ) | ||
$index | string |
Index that the document belongs to. |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function flushIndex($index = '_all')
{
return $this->db->post([$index, '_flush']);
}
Gets a document from the index
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html.
public mixed get ( $index, $type, $id, $options = [] ) | ||
$index | string |
Index that the document belongs to. |
$type | string|null |
Type that the document belongs to. |
$id | string |
The documents id. |
$options | array |
URL options |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function get($index, $type, $id, $options = [])
{
if ($this->db->dslVersion >= 7) {
return $this->db->get([$index, '_doc', $id], $options);
} else {
return $this->db->get([$index, $type, $id], $options);
}
}
See also https://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html#alias-retrieving.
public array getAliasInfo ( ) | ||
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function getAliasInfo()
{
$aliasInfo = $this->db->get(['_alias', '*']);
return $aliasInfo ?: [];
}
Defined in: yii\base\Component::getBehavior()
Returns the named behavior object.
public yii\base\Behavior|null getBehavior ( $name ) | ||
$name | string |
The behavior name |
return | yii\base\Behavior|null |
The behavior object, or null if the behavior does not exist |
---|
public function getBehavior($name)
{
$this->ensureBehaviors();
return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}
Defined in: yii\base\Component::getBehaviors()
Returns all behaviors attached to this component.
public yii\base\Behavior[] getBehaviors ( ) | ||
return | yii\base\Behavior[] |
List of behaviors attached to this component |
---|
public function getBehaviors()
{
$this->ensureBehaviors();
return $this->_behaviors;
}
See also https://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html#alias-retrieving.
public array getIndexAliases ( $index ) | ||
$index | string |
Index that the document belongs to. |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function getIndexAliases($index)
{
$responseData = $this->db->get([$index, '_alias', '*']);
if (empty($responseData)) {
return [];
}
return $responseData[$index]['aliases'];
}
See also https://www.elastic.co/guide/en/elasticsearch/reference/2.0/indices-aliases.html#alias-retrieving.
public array getIndexInfoByAlias ( $alias ) | ||
$alias | string | |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function getIndexInfoByAlias($alias)
{
$responseData = $this->db->get(['_alias', $alias]);
if (empty($responseData)) {
return [];
}
return $responseData;
}
public mixed getIndexRecoveryStats ( $index = '_all' ) | ||
$index | string |
Index that the document belongs to. |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function getIndexRecoveryStats($index = '_all')
{
return $this->db->get([$index, '_recovery']);
}
public mixed getIndexStats ( $index = '_all' ) | ||
$index | string |
Index that the document belongs to. |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function getIndexStats($index = '_all')
{
return $this->db->get([$index, '_stats']);
}
public array getIndexesByAlias ( $alias ) | ||
$alias | string | |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function getIndexesByAlias($alias)
{
return array_keys($this->getIndexInfoByAlias($alias));
}
public mixed getMapping ( $index = '_all', $type = null ) | ||
$index | string |
Index that the document belongs to. |
$type | string|null |
Type that the document belongs to. |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function getMapping($index = '_all', $type = null)
{
$url = [$index, '_mapping'];
if ($this->db->dslVersion < 7 && $type !== null) {
$url[] = $type;
}
return $this->db->get($url);
}
Gets a documents _source from the index (>=v0.90.1)
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html#_source.
public mixed getSource ( $index, $type, $id ) | ||
$index | string |
Index that the document belongs to. |
$type | string|null |
Type that the document belongs to. |
$id | string |
The documents id. |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function getSource($index, $type, $id)
{
if ($this->db->dslVersion >= 7) {
return $this->db->get([$index, '_doc', $id]);
} else {
return $this->db->get([$index, $type, $id]);
}
}
public mixed getTemplate ( $name ) | ||
$name | ||
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function getTemplate($name)
{
return $this->db->get(['_template', $name]);
}
Defined in: yii\base\Component::hasEventHandlers()
Returns a value indicating whether there is any handler attached to the named event.
public boolean hasEventHandlers ( $name ) | ||
$name | string |
The event name |
return | boolean |
Whether there is any handler attached to the event. |
---|
public function hasEventHandlers($name)
{
$this->ensureBehaviors();
if (!empty($this->_events[$name])) {
return true;
}
foreach ($this->_eventWildcards as $wildcard => $handlers) {
if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
return true;
}
}
return Event::hasHandlers($this, $name);
}
Defined in: yii\base\Component::hasMethod()
Returns a value indicating whether a method is defined.
A method is defined if:
- the class has a method with the specified name
- an attached behavior has a method with the given name (when
$checkBehaviors
is true).
public boolean hasMethod ( $name, $checkBehaviors = true ) | ||
$name | string |
The property name |
$checkBehaviors | boolean |
Whether to treat behaviors' methods as methods of this component |
return | boolean |
Whether the method is defined |
---|
public function hasMethod($name, $checkBehaviors = true)
{
if (method_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->hasMethod($name)) {
return true;
}
}
}
return false;
}
Defined in: yii\base\Component::hasProperty()
Returns a value indicating whether a property is defined for this component.
A property is defined if:
- the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVars
is true); - an attached behavior has a property of the given name (when
$checkBehaviors
is true).
See also:
public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true ) | ||
$name | string |
The property name |
$checkVars | boolean |
Whether to treat member variables as properties |
$checkBehaviors | boolean |
Whether to treat behaviors' properties as properties of this component |
return | boolean |
Whether the property is defined |
---|
public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}
Checks whether an index exists
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-exists.html.
public mixed indexExists ( $index ) | ||
$index | string |
Index that the document belongs to. |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function indexExists($index)
{
return $this->db->head([$index]);
}
Defined in: yii\base\BaseObject::init()
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
public void init ( ) |
public function init()
{
}
Inserts a document into an index
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html.
public mixed insert ( $index, $type, $data, $id = null, $options = [] ) | ||
$index | string |
Index that the document belongs to. |
$type | string|null |
Type that the document belongs to. |
$data | string|array |
Json string or array of data to store |
$id | string|null |
The documents id. If not specified Id will be automatically chosen |
$options | array |
URL options |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function insert($index, $type, $data, $id = null, $options = [])
{
if (empty($data)) {
$body = '{}';
} else {
$body = is_array($data) ? Json::encode($data) : $data;
}
if ($id !== null) {
if ($this->db->dslVersion >= 7) {
return $this->db->put([$index, '_doc', $id], $options, $body);
} else {
return $this->db->put([$index, $type, $id], $options, $body);
}
} else {
if ($this->db->dslVersion >= 7) {
return $this->db->post([$index, '_doc'], $options, $body);
} else {
return $this->db->post([$index, $type], $options, $body);
}
}
}
Gets multiple documents from the index
TODO allow specifying type and index + fields
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html.
public mixed mget ( $index, $type, $ids, $options = [] ) | ||
$index | string |
Index that the document belongs to. |
$type | string|null |
Type that the document belongs to. |
$ids | string[] |
The documents ids as values in array. |
$options | array |
URL options |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function mget($index, $type, $ids, $options = [])
{
$body = Json::encode(['ids' => array_values($ids)]);
if ($this->db->dslVersion >= 7) {
return $this->db->get([$index, '_mget'], $options, $body);
} else {
return $this->db->get([$index, $type, '_mget'], $options, $body);
}
}
Defined in: yii\base\Component::off()
Detaches an existing event handler from this component.
This method is the opposite of on().
Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.
See also on().
public boolean off ( $name, $handler = null ) | ||
$name | string |
Event name |
$handler | callable|null |
The event handler to be removed. If it is null, all handlers attached to the named event will be removed. |
return | boolean |
If a handler is found and detached |
---|
public function off($name, $handler = null)
{
$this->ensureBehaviors();
if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
return false;
}
if ($handler === null) {
unset($this->_events[$name], $this->_eventWildcards[$name]);
return true;
}
$removed = false;
// plain event names
if (isset($this->_events[$name])) {
foreach ($this->_events[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_events[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_events[$name] = array_values($this->_events[$name]);
return true;
}
}
// wildcard event names
if (isset($this->_eventWildcards[$name])) {
foreach ($this->_eventWildcards[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_eventWildcards[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
// remove empty wildcards to save future redundant regex checks:
if (empty($this->_eventWildcards[$name])) {
unset($this->_eventWildcards[$name]);
}
}
}
return $removed;
}
Defined in: yii\base\Component::on()
Attaches an event handler to an event.
The event handler must be a valid PHP callback. The following are some examples:
function ($event) { ... } // anonymous function
[$object, 'handleClick'] // $object->handleClick()
['Page', 'handleClick'] // Page::handleClick()
'handleClick' // global function handleClick()
The event handler must be defined with the following signature,
function ($event)
where $event
is an yii\base\Event object which includes parameters associated with the event.
Since 2.0.14 you can specify event name as a wildcard pattern:
$component->on('event.group.*', function ($event) {
Yii::trace($event->name . ' is triggered.');
});
See also off().
public void on ( $name, $handler, $data = null, $append = true ) | ||
$name | string |
The event name |
$handler | callable |
The event handler |
$data | mixed |
The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via yii\base\Event::$data. |
$append | boolean |
Whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list. |
public function on($name, $handler, $data = null, $append = true)
{
$this->ensureBehaviors();
if (strpos($name, '*') !== false) {
if ($append || empty($this->_eventWildcards[$name])) {
$this->_eventWildcards[$name][] = [$handler, $data];
} else {
array_unshift($this->_eventWildcards[$name], [$handler, $data]);
}
return;
}
if ($append || empty($this->_events[$name])) {
$this->_events[$name][] = [$handler, $data];
} else {
array_unshift($this->_events[$name], [$handler, $data]);
}
}
public mixed openIndex ( $index ) | ||
$index | string |
Index that the document belongs to. |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function openIndex($index)
{
return $this->db->post([$index, '_open']);
}
public mixed refreshIndex ( $index ) | ||
$index | string |
Index that the document belongs to. |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function refreshIndex($index)
{
return $this->db->post([$index, '_refresh']);
}
public boolean removeAlias ( $index, $alias ) | ||
$index | string |
Index that the document belongs to. |
$alias | string | |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function removeAlias($index, $alias)
{
return (bool)$this->db->delete([$index, '_alias', $alias]);
}
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html.
public mixed scroll ( $options = [] ) | ||
$options | array |
URL options |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function scroll($options = [])
{
$body = array_filter([
'scroll' => ArrayHelper::remove($options, 'scroll', null),
'scroll_id' => ArrayHelper::remove($options, 'scroll_id', null),
]);
if (empty($body)) {
$body = (object) [];
}
return $this->db->post(['_search', 'scroll'], $options, Json::encode($body));
}
Sends a request to the _search API and returns the result
public mixed search ( $options = [] ) | ||
$options | array |
URL options |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function search($options = [])
{
$query = $this->queryParts;
if (empty($query)) {
$query = '{}';
}
if (is_array($query)) {
$query = Json::encode($query);
}
$url = [$this->index !== null ? $this->index : '_all'];
if ($this->db->dslVersion < 7 && $this->type !== null) {
$url[] = $this->type;
}
$url[] = '_search';
return $this->db->get($url, array_merge($this->options, $options), $query);
}
public mixed setMapping ( $index, $type, $mapping, $options = [] ) | ||
$index | string |
Index that the document belongs to. |
$type | string|null |
Type that the document belongs to. |
$mapping | string|array | |
$options | array |
URL options |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function setMapping($index, $type, $mapping, $options = [])
{
$body = $mapping !== null ? (is_string($mapping) ? $mapping : Json::encode($mapping)) : null;
if ($this->db->dslVersion >= 7) {
$endpoint = [$index, '_mapping'];
} else {
$endpoint = [$index, '_mapping', $type];
}
return $this->db->put($endpoint, $options, $body);
}
Sends a suggest request to the _search API and returns the result
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html.
public mixed suggest ( $suggester, $options = [] ) | ||
$suggester | string|array |
The suggester body |
$options | array |
URL options |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function suggest($suggester, $options = [])
{
if (empty($suggester)) {
$suggester = '{}';
}
if (is_array($suggester)) {
$suggester = Json::encode($suggester);
}
$body = '{"suggest":'.$suggester.',"size":0}';
$url = [
$this->index !== null ? $this->index : '_all',
'_search'
];
$result = $this->db->post($url, array_merge($this->options, $options), $body);
return $result['suggest'];
}
Defined in: yii\base\Component::trigger()
Triggers an event.
This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.
public void trigger ( $name, yii\base\Event $event = null ) | ||
$name | string |
The event name |
$event | yii\base\Event|null |
The event instance. If not set, a default yii\base\Event object will be created. |
public function trigger($name, Event $event = null)
{
$this->ensureBehaviors();
$eventHandlers = [];
foreach ($this->_eventWildcards as $wildcard => $handlers) {
if (StringHelper::matchWildcard($wildcard, $name)) {
$eventHandlers[] = $handlers;
}
}
if (!empty($this->_events[$name])) {
$eventHandlers[] = $this->_events[$name];
}
if (!empty($eventHandlers)) {
$eventHandlers = call_user_func_array('array_merge', $eventHandlers);
if ($event === null) {
$event = new Event();
}
if ($event->sender === null) {
$event->sender = $this;
}
$event->handled = false;
$event->name = $name;
foreach ($eventHandlers as $handler) {
$event->data = $handler[1];
call_user_func($handler[0], $event);
// stop further handling if the event is handled
if ($event->handled) {
return;
}
}
}
// invoke class-level attached handlers
Event::trigger($this, $name, $event);
}
public mixed typeExists ( $index, $type ) | ||
$index | string |
Index that the document belongs to. |
$type | string|null |
Type that the document belongs to. |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function typeExists($index, $type)
{
if ($this->db->dslVersion >= 7) {
return $this->db->head([$index, '_doc']);
} else {
return $this->db->head([$index, $type]);
}
}
Updates a document
See also https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html.
public mixed update ( $index, $type, $id, $data, $options = [] ) | ||
$index | string |
Index that the document belongs to. |
$type | string|null |
Type that the document belongs to. |
$id | string |
The documents id. |
$data | mixed | |
$options | array |
URL options |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function update($index, $type, $id, $data, $options = [])
{
$body = [
'doc' => empty($data) ? new \stdClass() : $data,
];
if (isset($options["detect_noop"])) {
$body["detect_noop"] = $options["detect_noop"];
unset($options["detect_noop"]);
}
if ($this->db->dslVersion >= 7) {
return $this->db->post([$index, '_update', $id], $options, Json::encode($body));
} else {
return $this->db->post([$index, $type, $id, '_update'], $options, Json::encode($body));
}
}
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 |
Index that the document belongs to. |
$setting | string|array | |
$options | array |
URL options |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function updateAnalyzers($index, $setting, $options = [])
{
$this->closeIndex($index);
$result = $this->updateSettings($index, $setting, $options);
$this->openIndex($index);
return $result;
}
Change specific index level settings in real time.
Note that update analyzers required to close() the index first and open() it after the changes are made, use updateAnalyzers() for it.
See also https://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-update-settings.html.
public mixed updateSettings ( $index, $setting, $options = [] ) | ||
$index | string |
Index that the document belongs to. |
$setting | string|array | |
$options | array |
URL options |
throws | yii\elasticsearch\Exception | |
---|---|---|
throws | yii\base\InvalidConfigException |
public function updateSettings($index, $setting, $options = [])
{
$body = $setting !== null ? (is_string($setting) ? $setting : Json::encode($setting)) : null;
return $this->db->put([$index, '_settings'], $options, $body);
}