/ 
ElasticSearch-0.42
/ ElasticSearch::ScrolledSearch

NAME

ElasticSearch::ScrolledSearch - Description

SYNOPSIS

  $scroller = $es->scrolled_search($search_params);
OR
  $scroller = ElasticSearch::ScrolledSearch($es,$search_params);

  while (my $result = $scroller->next) {
      # do something
  }

  $total = $scroller->total;
  $bool  = $scroller->eof
  $score = $scroller->max_score;

DESCRIPTION

ElasticSearch::ScrolledSearch is a convenience iterator for scrolled searches. It accepts the standard search parameters that would be passed to "search()" in ElasticSearch. The scroll parameter defaults to 1m.

$scroller = $es->scrolled_search(
                query  => {match_all=>{}},
                scroll => '5m'               # keep the scroll request
                                             # live for 5 minutes
            );

METHODS

new()

  $scroller = $es->scrolled_search($search_params);
OR
  $scroller = ElasticSearch::ScrolledSearch($es,$search_params);

next()

@results = $scroller->next()
@results = $scroller->next($no_of_results);

Returns the next result, or the next $no_of_results or an empty list when no more results are available.

An error is thrown if the scroll has already expired.

total()

$total = $scroller->total

The total number of hits

max_score()

$score = $scroller->max_score

The max_score returned from the first search request (if available).

eof()

$bool = $scroller->eof

Returns true if no more results are available. Note: if no results match the search, then eof() could be false but the first call to next() will return zero results.

SEE ALSO

"scrolled_search()" in ElasticSearch, "search()" in ElasticSearch and "scroll()" in ElasticSearch

BUGS

None known

AUTHOR

Clinton Gormley, <clinton@traveljury.com>

COPYRIGHT AND LICENSE

Copyright (C) 2011 by Clinton Gormley

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.7 or, at your option, any later version of Perl 5 you may have available.