added Scroll Iterator #842
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,154 +3,79 @@ | |
| namespace Elastica; | ||
|
|
||
| /** | ||
| * Scan and Scroll Iterator | ||
| * | ||
| * @author Manuel Andreo Garcia <[email protected]> | ||
| * | ||
| * @link http://www.elastic.co/guide/en/elasticsearch/guide/current/scan-scroll.html | ||
| */ | ||
| class ScanAndScroll extends Scroll | ||
| { | ||
| /** | ||
| * @var int | ||
| */ | ||
| public $sizePerShard; | ||
|
|
||
| /** | ||
| * Constructor | ||
| * | ||
| * @param Search $search | ||
| * @param string $expiryTime | ||
| * @param int $sizePerShard | ||
| */ | ||
| public function __construct(Search $search, $expiryTime = '1m', $sizePerShard = 1000) | ||
| { | ||
| $this->sizePerShard = $sizePerShard; | ||
|
|
||
| parent::__construct($search, $expiryTime); | ||
| } | ||
|
|
||
| /** | ||
| * Initial scan search | ||
| * | ||
| * @link http://php.net/manual/en/iterator.rewind.php | ||
| */ | ||
| public function rewind() | ||
| { | ||
| // reset state | ||
| $this->_nextScrollId = null; | ||
| $this->_options = array(null, null, null, null); | ||
|
|
||
| $this->_saveOptions(); | ||
|
|
||
| // initial scan request | ||
| $this->_search->getQuery()->setSize($this->sizePerShard); | ||
| $this->_search->setOption(Search::OPTION_SCROLL, $this->expiryTime); | ||
| $this->_search->setOption(Search::OPTION_SCROLL_ID, null); | ||
| $this->_search->setOption(Search::OPTION_SEARCH_TYPE, Search::OPTION_SEARCH_TYPE_SCAN); | ||
| $this->_setScrollId($this->_search->search()); | ||
|
|
||
| $this->_revertOptions(); | ||
|
|
||
| // first scroll request | ||
| $this->next(); | ||
| } | ||
|
|
||
| /** | ||
| * Save all search options manipulated by Scroll | ||
| */ | ||
| protected function _saveOptions() | ||
| { | ||
| $query = $this->_search->getQuery(); | ||
| if ($query->hasParam('size')) { | ||
| $this->_options[3] = $query->getParam('size'); | ||
| } | ||
|
|
||
| parent::_saveOptions(); | ||
| } | ||
|
|
||
| /** | ||
| * Revert search options to previously saved state | ||
| */ | ||
| protected function _revertOptions() | ||
| { | ||
| $this->_search->getQuery()->setSize($this->_options[3]); | ||
|
|
||
| parent::_revertOptions(); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,175 @@ | ||
| <?php | ||
|
|
||
| namespace Elastica; | ||
|
|
||
| /** | ||
| * Scroll Iterator | ||
| * | ||
| * @author Manuel Andreo Garcia <[email protected]> | ||
| * | ||
| * @link http://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-scroll.html | ||
| */ | ||
| class Scroll implements \Iterator | ||
| { | ||
| /** | ||
| * @var string | ||
| */ | ||
| public $expiryTime; | ||
|
|
||
| /** | ||
| * @var Search | ||
| */ | ||
| protected $_search; | ||
|
|
||
| /** | ||
| * @var null|string | ||
| */ | ||
| protected $_nextScrollId = null; | ||
|
|
||
| /** | ||
| * @var null|ResultSet | ||
| */ | ||
| protected $_currentResultSet = null; | ||
|
|
||
| /** | ||
| * 0: scroll<br> | ||
| * 1: scroll id<br> | ||
| * 2: search type. | ||
| * | ||
| * @var array | ||
| */ | ||
| protected $_options = array(null, null, null); | ||
|
There was a problem hiding this comment.
VO? There was a problem hiding this comment. I was wondering if we should be using Value Objects for these pieces of config. But I haven't seen them implemented anywhere else in the library, so I would assume that arrays are the conventions in this case. Isn't that the case @ruflin? There was a problem hiding this comment. @hasumedic Currently the convention is arrays. This is mainly related to the history of Elastica as it started very simple and grew together with elasticsearch. If we change to ArrayObjects, we should consider a change across the full library. @ewgRa brought up this issue and I just realised I never responded to it :-( #783 (comment) I suggest to continue this discussion in #783 an until then we use arrays. There was a problem hiding this comment. That being the case, this PR looks good and should go forward! 👍 |
||
|
|
||
| /** | ||
| * Constructor | ||
| * | ||
| * @param Search $search | ||
| * @param string $expiryTime | ||
| */ | ||
| public function __construct(Search $search, $expiryTime = '1m') | ||
| { | ||
| $this->_search = $search; | ||
| $this->expiryTime = $expiryTime; | ||
| } | ||
|
|
||
| /** | ||
| * Returns current result set | ||
| * | ||
| * @link http://php.net/manual/en/iterator.current.php | ||
| * | ||
| * @return ResultSet | ||
| */ | ||
| public function current() | ||
| { | ||
| return $this->_currentResultSet; | ||
| } | ||
|
|
||
| /** | ||
| * Next scroll search | ||
| * | ||
| * @link http://php.net/manual/en/iterator.next.php | ||
| */ | ||
| public function next() | ||
| { | ||
| $this->_saveOptions(); | ||
|
|
||
| $this->_search->setOption(Search::OPTION_SCROLL, $this->expiryTime); | ||
| $this->_search->setOption(Search::OPTION_SCROLL_ID, $this->_nextScrollId); | ||
| $this->_search->setOption(Search::OPTION_SEARCH_TYPE, Search::OPTION_SEARCH_TYPE_SCROLL); | ||
| $this->_setScrollId($this->_search->search()); | ||
|
|
||
| $this->_revertOptions(); | ||
| } | ||
|
|
||
| /** | ||
| * Returns scroll id | ||
| * | ||
| * @link http://php.net/manual/en/iterator.key.php | ||
| * | ||
| * @return string | ||
| */ | ||
| public function key() | ||
| { | ||
| return $this->_nextScrollId; | ||
| } | ||
|
|
||
| /** | ||
| * Returns true if current result set contains at least one hit | ||
| * | ||
| * @link http://php.net/manual/en/iterator.valid.php | ||
| * | ||
| * @return bool | ||
| */ | ||
| public function valid() | ||
| { | ||
| return | ||
| $this->_nextScrollId !== null | ||
| && $this->_currentResultSet !== null | ||
| && $this->_currentResultSet->count() > 0; | ||
| } | ||
|
|
||
| /** | ||
| * Initial scroll search | ||
| * | ||
| * @link http://php.net/manual/en/iterator.rewind.php | ||
| */ | ||
| public function rewind() | ||
| { | ||
| // reset state | ||
| $this->_nextScrollId = null; | ||
| $this->_options = array(null, null, null); | ||
|
|
||
| // initial search | ||
| $this->_saveOptions(); | ||
|
|
||
| $this->_search->setOption(Search::OPTION_SCROLL, $this->expiryTime); | ||
| $this->_search->setOption(Search::OPTION_SCROLL_ID, null); | ||
| $this->_search->setOption(Search::OPTION_SEARCH_TYPE, null); | ||
| $this->_setScrollId($this->_search->search()); | ||
|
|
||
| $this->_revertOptions(); | ||
| } | ||
|
|
||
| /** | ||
| * Prepares Scroll for next request | ||
| * | ||
| * @param ResultSet $resultSet | ||
| */ | ||
| protected function _setScrollId(ResultSet $resultSet) | ||
| { | ||
| $this->_currentResultSet = $resultSet; | ||
|
|
||
| $this->_nextScrollId = null; | ||
| if ($resultSet->getResponse()->isOk()) { | ||
| $this->_nextScrollId = $resultSet->getResponse()->getScrollId(); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Save all search options manipulated by Scroll | ||
| */ | ||
| protected function _saveOptions() | ||
| { | ||
| if ($this->_search->hasOption(Search::OPTION_SCROLL)) { | ||
| $this->_options[0] = $this->_search->getOption(Search::OPTION_SCROLL); | ||
| } | ||
|
|
||
| if ($this->_search->hasOption(Search::OPTION_SCROLL_ID)) { | ||
| $this->_options[1] = $this->_search->getOption(Search::OPTION_SCROLL_ID); | ||
| } | ||
|
|
||
| if ($this->_search->hasOption(Search::OPTION_SEARCH_TYPE)) { | ||
| $this->_options[2] = $this->_search->getOption(Search::OPTION_SEARCH_TYPE); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Revert search options to previously saved state | ||
| */ | ||
| protected function _revertOptions() | ||
| { | ||
| $this->_search->setOption(Search::OPTION_SCROLL, $this->_options[0]); | ||
| $this->_search->setOption(Search::OPTION_SCROLL_ID, $this->_options[1]); | ||
| $this->_search->setOption(Search::OPTION_SEARCH_TYPE, $this->_options[2]); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
shouldn't it be only 3 null?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nevermind, I just saw that there is a fourth param size for ScanAndScroll