NAME

ElasticSearchX::Model::Scroll

VERSION

version 0.1.4

SYNOPSIS

 my $iterator = $twitter->type('tweet')->scroll( '5m' );
 while(my $tweet = $iterator->next) {
     # do something with $tweet
 }
 
 my $iterator = $twitter->type('tweet')->raw->scroll;
 $iterator->max_score;
 $iterator->total;

ATTRIBUTES

scroll

This string indicated how long ElasticSearch should keep the scrolled search around. This attribute is set by passing it to "scroll" in ElasticSearchX::Model::Document::Set.

set

The ElasticSearchX::Model::Document::Set this instance was build from.

METHODS

total

eof

max_score

Delegates to ElasticSearch::ScrolledSearch.

next

Returns the next result in the search. If you set the query to not inflate the results (e.g. using "raw" in ElasticSearchX::Model::Document::Set) it returns the raw HashRef, otherwise the result is inflated to the correct document class.

AUTHOR

Moritz Onken

COPYRIGHT AND LICENSE

This software is Copyright (c) 2012 by Moritz Onken.

This is free software, licensed under:

  The (three-clause) BSD License