GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MONGODB::QUERYRESULT (3)

.ds Aq ’

NAME

MongoDB::QueryResult - An iterator for Mongo query results

CONTENTS

VERSION

version v1.2.3

SYNOPSIS



    $cursor = $coll->find( $filter );
    $result = $cursor->result;

    while ( $doc = $result->next ) {
        process_doc($doc)
    }



DESCRIPTION

This class defines an iterator against a query result. It automatically fetches additional results from the originating mongod/mongos server on demand.

For backwards compatibility reasons, MongoDB::Cursor encapsulates query parameters and generates a MongoDB::QueryResult object on demand. All iterators on MongoDB::Cursor delegate to MongoDB::QueryResult object.

Retrieving this object and iterating on it directly will be slightly more efficient.

USAGE

    Error handling

Unless otherwise explictly documented, all methods throw exceptions if an error occurs. The error types are documented in MongoDB::Error.

To catch and handle errors, the Try::Tiny and Safe::Isa modules are recommended:

    Cursor destruction

When a MongoDB::QueryResult object is destroyed, a cursor termination request will be sent to the originating server to free server resources.

METHODS

    has_next



    if ( $response->has_next ) {
        ...
    }



Returns true if additional documents are available. This will attempt to get another batch of documents from the server if necessary.

    next



    while ( $doc = $result->next ) {
        process_doc($doc)
    }



Returns the next document or undef if the server cursor is exhausted.

    batch



  while ( @batch = $result->batch ) {
    for $doc ( @batch ) {
      process_doc($doc);
    }
  }



Returns the next batch of documents or an empty list if the server cursor is exhausted.

    all



    @docs = $result->all;



Returns all documents as a list.

AUTHORS

o David Golden <david@mongodb.com>
o Mike Friedman <friedo@friedo.com>
o Kristina Chodorow <k.chodorow@gmail.com>
o Florian Ragwitz <rafl@debian.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2016 by MongoDB, Inc..

This is free software, licensed under:



  The Apache License, Version 2.0, January 2004



Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 MONGODB::QUERYRESULT (3) 2016-03-08

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.