NAME

Search::Elasticsearch::Compat::ScrolledSearch - A wrapper for managing scrolled searches

VERSION

version 0.10

SYNOPSIS

            

              
              
  $scroller = $es->scrolled_search($search_params);
OR
  $scroller = Search::Elasticsearch::Compat::ScrolledSearch($es,$search_params);
  while (my $result = $scroller->next) {
      # do something
  }
  $total  = $scroller->total;
  $bool   = $scroller->eof
  $score  = $scroller->max_score;
  $facets = $scroller->facets;
            
          

DESCRIPTION

Search::Elasticsearch::Compat::ScrolledSearch is a convenience iterator for scrolled searches. It accepts the standard search parameters that would be passed to "search()" in Search::Elasticsearch::Compat. 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 = Search::Elasticsearch::Compat::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.

If as_json => 1 is specified, then "next()" will always return a JSON array:

            

              
              
$scroller->next()
# '[{...}]'
$scroller->next(2)
# '[{...},{...}]'
# if no results left: '[]'
            
          

drain_buffer()

            

              
              
@docs = $scroller->drain_buffer;
            
          

Returns and removes all docs that are currently stored in the buffer.

refill_buffer()

            

              
              
$buffer_size = $scroller->refill_buffer
            
          

Pulls the next set of results from Elasticsearch (if any) and returns the total number of docs stored in the internal buffer.

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.

facets()

            

              
              
$facets = $scroller->facets
            
          

The facets returned from the first search request (if any).

If as_json => 1 is specified, then "facets()" will always return a JSON object.

SEE ALSO

"scrolled_search()" in Search::Elasticsearch::Client::Compat, "search()" in Search::Elasticsearch::Client::Compat and "scroll()" in Search::Elasticsearch::Client::Compat

AUTHOR

Clinton Gormley <drtech@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2014 by Elasticsearch BV.

This is free software, licensed under:

            

              
              
The Apache License, Version 2.0, January 2004
            
          

cpanm Search::Elasticsearch::Compat

perl -MCPAN -e shell
install Search::Elasticsearch::Compat