Class yii\elasticsearch\BatchQueryResult

All Classes | Properties | Methods
Inheritanceyii\elasticsearch\BatchQueryResult » yii\base\BaseObject
ImplementsIterator, yii\base\Configurable
Available since version2.0.4
Source Code https://github.com/yiisoft/yii2-elasticsearch/blob/master/BatchQueryResult.php

BatchQueryResult represents a batch query from which you can retrieve data in batches.

You usually do not instantiate BatchQueryResult directly. Instead, you obtain it by calling yii\elasticsearch\Query::batch() or yii\elasticsearch\Query::each(). Because BatchQueryResult implements the Iterator interface, you can iterate it to obtain a batch of data in each iteration.

Batch size is determined by the yii\elasticsearch\Query::$limit setting. yii\elasticsearch\Query::$offset setting is ignored. New batches will be obtained until the server runs out of results.

If yii\elasticsearch\Query::$orderBy parameter is not set, batches will be processed using the highly efficient "scan" mode. In this case, yii\elasticsearch\Query::$limit setting determines batch size per shard. See Elasticsearch guide for more information.

Example: `php $query = (new Query)->from('user'); foreach ($query->batch() as $i => $users) {

// $users represents the rows in the $i-th batch

} foreach ($query->each() as $user) { } `

Public Properties

Hide inherited properties

Property Type Description Defined By
$db yii\elasticsearch\Connection The DB connection to be used when performing batch query. yii\elasticsearch\BatchQueryResult
$each boolean Whether to return a single row during each iteration. yii\elasticsearch\BatchQueryResult
$query yii\elasticsearch\Query The query object associated with this batch query. yii\elasticsearch\BatchQueryResult
$scrollWindow string The amount of time to keep the scroll window open (in Elasticsearch time units. yii\elasticsearch\BatchQueryResult

Public Methods

Hide inherited methods

Method Description Defined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() Constructor. yii\base\BaseObject
__destruct() Destructor. yii\elasticsearch\BatchQueryResult
__get() Returns the value of an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
canGetProperty() Returns a value indicating whether a property can be read. yii\base\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
className() Returns the fully qualified name of this class. yii\base\BaseObject
current() Returns the current dataset. yii\elasticsearch\BatchQueryResult
hasMethod() Returns a value indicating whether a method is defined. yii\base\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() Initializes the object. yii\base\BaseObject
key() Returns the index of the current dataset. yii\elasticsearch\BatchQueryResult
next() Moves the internal pointer to the next dataset. yii\elasticsearch\BatchQueryResult
reset() Resets the batch query. yii\elasticsearch\BatchQueryResult
rewind() Resets the iterator to the initial state. yii\elasticsearch\BatchQueryResult
valid() Returns whether there is a valid dataset at the current position. yii\elasticsearch\BatchQueryResult

Protected Methods

Hide inherited methods

Method Description Defined By
fetchData() Fetches the next batch of data. yii\elasticsearch\BatchQueryResult

Property Details

Hide inherited properties

$db public property

The DB connection to be used when performing batch query. If null, the elasticsearch application component will be used.

public yii\elasticsearch\Connection $db = null
$each public property

Whether to return a single row during each iteration. If false, a whole batch of rows will be returned in each iteration.

public boolean $each = false
$query public property

The query object associated with this batch query. Do not modify this property directly unless after reset() is called explicitly.

public yii\elasticsearch\Query $query = null
$scrollWindow public property

The amount of time to keep the scroll window open (in Elasticsearch time units.

public string $scrollWindow = '1m'

Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\BaseObject::__call()

Calls the named method which is not a class method.

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)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
__construct() public method

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();
}
__destruct() public method

Destructor.

public void __destruct ( )

                public function __destruct()
{
    // make sure cursor is closed
    $this->reset();
}
__get() public method

Defined in: yii\base\BaseObject::__get()

Returns the value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

See also __set().

public mixed __get ( $name )
$name string

The property name
return mixed

The property value
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)) {
        return $this->$getter();
    } elseif (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);
}
__isset() public method

Defined in: yii\base\BaseObject::__isset()

Checks if a property is set, i.e. defined and not null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($object->property).

Note that if the property is not defined, false will be returned.

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

The property name or the event name
return boolean

Whether the named property is set (not null).

 

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    return false;
}
__set() public method

Defined in: yii\base\BaseObject::__set()

Sets value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $object->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)) {
        $this->$setter($value);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    } else {
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }
}
__unset() public method

Defined in: yii\base\BaseObject::__unset()

Sets an object property to null.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($object->property).

Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.

See also https://www.php.net/manual/en/function.unset.php.

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);
    } elseif (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
    }
}
canGetProperty() public method

Defined in: yii\base\BaseObject::canGetProperty()

Returns a value indicating whether a property can be read.

A property is readable 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);

See also canSetProperty().

public boolean canGetProperty ( $name, $checkVars = true )
$name string

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property can be read

 

                public function canGetProperty($name, $checkVars = true)
{
    return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
canSetProperty() public method

Defined in: yii\base\BaseObject::canSetProperty()

Returns a value indicating whether a property can be set.

A property is writable 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);

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars = true )
$name string

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property can be written

 

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use ::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();
}
current() public method

Returns the current dataset.

This method is required by the interface Iterator.

public mixed current ( )
return mixed

The current dataset.

 

                #[ReturnTypeWillChange]
public function current()
{
    return $this->_value;
}
fetchData() protected method

Fetches the next batch of data.

protected array fetchData ( )
return array

The data fetched

 

                protected function fetchData()
{
    if (null === $this->_lastScrollId) {
        //first query - do search
        $options = ['scroll' => $this->scrollWindow];
        if(!$this->query->orderBy) {
            $query = clone $this->query;
            $query->orderBy('_doc');
            $cmd = $this->query->createCommand($this->db);
        } else {
            $cmd = $this->query->createCommand($this->db);
        }
        $result = $cmd->search($options);
        if ($result === false) {
            throw new Exception('Elasticsearch search query failed.');
        }
    } else {
        //subsequent queries - do scroll
        $result = $this->query->createCommand($this->db)->scroll([
            'scroll_id' => $this->_lastScrollId,
            'scroll' => $this->scrollWindow,
        ]);
    }
    //get last scroll id
    $this->_lastScrollId = $result['_scroll_id'];
    //get data
    return $this->query->populate($result['hits']['hits']);
}
hasMethod() public method

Defined in: yii\base\BaseObject::hasMethod()

Returns a value indicating whether a method is defined.

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

public boolean hasMethod ( $name )
$name string

The method name
return boolean

Whether the method is defined

 

                public function hasMethod($name)
{
    return method_exists($this, $name);
}
hasProperty() public method

Defined in: yii\base\BaseObject::hasProperty()

Returns a value indicating whether a property is defined.

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);

See also:

public boolean hasProperty ( $name, $checkVars = true )
$name string

The property name
$checkVars boolean

Whether to treat member variables as properties
return boolean

Whether the property is defined

 

                public function hasProperty($name, $checkVars = true)
{
    return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
init() public method

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()
{
}
key() public method

Returns the index of the current dataset.

This method is required by the interface Iterator.

public integer key ( )
return integer

The index of the current row.

 

                #[ReturnTypeWillChange]
public function key()
{
    return $this->_key;
}
next() public method

Moves the internal pointer to the next dataset.

This method is required by the interface Iterator.

public void next ( )

                #[ReturnTypeWillChange]
public function next()
{
    if ($this->_batch === null || !$this->each || $this->each && next($this->_batch) === false) {
        $this->_batch = $this->fetchData();
        reset($this->_batch);
    }
    if ($this->each) {
        $this->_value = current($this->_batch);
        if ($this->query->indexBy !== null) {
            $this->_key = key($this->_batch);
        } elseif (key($this->_batch) !== null) {
            $this->_key++;
        } else {
            $this->_key = null;
        }
    } else {
        $this->_value = $this->_batch;
        $this->_key = $this->_key === null ? 0 : $this->_key + 1;
    }
}
reset() public method

Resets the batch query.

This method will clean up the existing batch query so that a new batch query can be performed.

public void reset ( )

                public function reset()
{
    if(isset($this->_lastScrollId)) {
        $this->query->createCommand($this->db)->clearScroll(['scroll_id' => $this->_lastScrollId]);
    }
    $this->_batch = null;
    $this->_value = null;
    $this->_key = null;
    $this->_lastScrollId = null;
}
rewind() public method

Resets the iterator to the initial state.

This method is required by the interface Iterator.

public void rewind ( )

                #[ReturnTypeWillChange]
public function rewind()
{
    $this->reset();
    $this->next();
}
valid() public method

Returns whether there is a valid dataset at the current position.

This method is required by the interface Iterator.

public boolean valid ( )
return boolean

Whether there is a valid dataset at the current position.

 

                #[ReturnTypeWillChange]
public function valid()
{
    return !empty($this->_batch);
}