/usr/lib/x86_64-linux-gnu/perl5/5.26/MongoDB/Cursor.pm is in libmongodb-perl 1.8.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 | #
# Copyright 2009-2013 MongoDB, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
use strict;
use warnings;
package MongoDB::Cursor;
# ABSTRACT: A lazy cursor for Mongo query results
use version;
our $VERSION = 'v1.8.1';
use Moo;
use MongoDB;
use MongoDB::BSON;
use MongoDB::Error;
use MongoDB::QueryResult;
use MongoDB::ReadPreference;
use MongoDB::_Protocol;
use MongoDB::Op::_Explain;
use MongoDB::_Types -types, 'to_IxHash';
use Types::Standard qw(
InstanceOf
);
use boolean;
use Tie::IxHash;
use Try::Tiny;
use namespace::clean -except => 'meta';
#pod =attr started_iterating
#pod
#pod A boolean indicating if this cursor has queried the database yet. Methods
#pod modifying the query will complain if they are called after the database is
#pod queried.
#pod
#pod =cut
with $_ for qw(
MongoDB::Role::_CursorAPI
MongoDB::Role::_DeprecationWarner
);
# attributes for sending a query
has client => (
is => 'ro',
required => 1,
isa => InstanceOf ['MongoDB::MongoClient'],
);
has _query => (
is => 'ro',
isa => InstanceOf['MongoDB::Op::_Query'],
required => 1,
init_arg => 'query',
);
# lazy result attribute
has result => (
is => 'lazy',
isa => InstanceOf['MongoDB::QueryResult'],
builder => '_build_result',
predicate => 'started_iterating',
clearer => '_clear_result',
);
# this does the query if it hasn't been done yet
sub _build_result {
my ($self) = @_;
return $self->{client}->send_read_op( $self->_query );
}
#--------------------------------------------------------------------------#
# methods that modify the query
#--------------------------------------------------------------------------#
#pod =head1 QUERY MODIFIERS
#pod
#pod These methods modify the query to be run. An exception will be thrown if
#pod they are called after results are iterated.
#pod
#pod =head2 immortal
#pod
#pod $cursor->immortal(1);
#pod
#pod Ordinarily, a cursor "dies" on the database server after a certain length of
#pod time (approximately 10 minutes), to prevent inactive cursors from hogging
#pod resources. This option indicates that a cursor should not die until all of its
#pod results have been fetched or it goes out of scope in Perl.
#pod
#pod Boolean value, defaults to 0.
#pod
#pod Note: C<immortal> only affects the server-side timeout. If you are getting
#pod client-side timeouts you will need to change your client configuration.
#pod See L<MongoDB::MongoClient/max_time_ms> and
#pod L<MongoDB::MongoClient/socket_timeout_ms>.
#pod
#pod Returns this cursor for chaining operations.
#pod
#pod =cut
sub immortal {
my ( $self, $bool ) = @_;
MongoDB::UsageError->throw("cannot set immortal after querying")
if $self->started_iterating;
$self->_query->noCursorTimeout(!!$bool);
return $self;
}
#pod =head2 fields
#pod
#pod $coll->insert({name => "Fred", age => 20});
#pod my $cursor = $coll->find->fields({ name => 1 });
#pod my $obj = $cursor->next;
#pod $obj->{name}; "Fred"
#pod $obj->{age}; # undef
#pod
#pod Selects which fields are returned. The default is all fields. When fields
#pod are specified, _id is returned by default, but this can be disabled by
#pod explicitly setting it to "0". E.g. C<< _id => 0 >>. Argument must be either a
#pod hash reference or a L<Tie::IxHash> object.
#pod
#pod See L<Limit fields to
#pod return|http://docs.mongodb.org/manual/tutorial/project-fields-from-query-results/>
#pod in the MongoDB documentation for details.
#pod
#pod Returns this cursor for chaining operations.
#pod
#pod =cut
sub fields {
my ($self, $f) = @_;
MongoDB::UsageError->throw("cannot set fields after querying")
if $self->started_iterating;
MongoDB::UsageError->throw("not a hash reference")
unless ref $f eq 'HASH' || ref $f eq 'Tie::IxHash';
$self->_query->projection($f);
return $self;
}
#pod =head2 sort
#pod
#pod # sort by name, descending
#pod $cursor->sort([name => -1]);
#pod
#pod Adds a sort to the query. Argument is either a hash reference or a
#pod L<Tie::IxHash> or an array reference of key/value pairs. Because hash
#pod references are not ordered, do not use them for more than one key.
#pod
#pod Returns this cursor for chaining operations.
#pod
#pod =cut
sub sort {
my ( $self, $order ) = @_;
MongoDB::UsageError->throw("cannot set sort after querying")
if $self->started_iterating;
$self->_query->sort( to_IxHash($order) );
return $self;
}
#pod =head2 limit
#pod
#pod $cursor->limit(20);
#pod
#pod Sets cursor to return a maximum of N results.
#pod
#pod Returns this cursor for chaining operations.
#pod
#pod =cut
sub limit {
my ( $self, $num ) = @_;
MongoDB::UsageError->throw("cannot set limit after querying")
if $self->started_iterating;
$self->_query->limit($num);
return $self;
}
#pod =head2 max_await_time_ms
#pod
#pod $cursor->max_await_time_ms( 500 );
#pod
#pod The maximum amount of time in milliseconds for the server to wait on new
#pod documents to satisfy a tailable cursor query. This only applies to a
#pod cursor of type 'tailble_await'. This is ignored if the cursor is not
#pod a 'tailable_await' cursor or the server version is less than version 3.2.
#pod
#pod Returns this cursor for chaining operations.
#pod
#pod =cut
sub max_await_time_ms {
my ( $self, $num ) = @_;
$num = 0 unless defined $num;
MongoDB::UsageError->throw("max_await_time_ms must be non-negative")
if $num < 0;
MongoDB::UsageError->throw("can not set max_await_time_ms after querying")
if $self->started_iterating;
$self->_query->maxAwaitTimeMS( $num );
return $self;
}
#pod =head2 max_time_ms
#pod
#pod $cursor->max_time_ms( 500 );
#pod
#pod Causes the server to abort the operation if the specified time in milliseconds
#pod is exceeded.
#pod
#pod Returns this cursor for chaining operations.
#pod
#pod =cut
sub max_time_ms {
my ( $self, $num ) = @_;
$num = 0 unless defined $num;
MongoDB::UsageError->throw("max_time_ms must be non-negative")
if $num < 0;
MongoDB::UsageError->throw("can not set max_time_ms after querying")
if $self->started_iterating;
$self->_query->maxTimeMS( $num );
return $self;
}
#pod =head2 tailable
#pod
#pod $cursor->tailable(1);
#pod
#pod If a cursor should be tailable. Tailable cursors can only be used on capped
#pod collections and are similar to the C<tail -f> command: they never die and keep
#pod returning new results as more is added to a collection.
#pod
#pod They are often used for getting log messages.
#pod
#pod Boolean value, defaults to 0.
#pod
#pod If you want the tailable cursor to block for a few seconds, use
#pod L</tailable_await> instead. B<Note> calling this with a false value
#pod disables tailing, even if C<tailable_await> was previously called.
#pod
#pod Returns this cursor for chaining operations.
#pod
#pod =cut
sub tailable {
my ( $self, $bool ) = @_;
MongoDB::UsageError->throw("cannot set tailable after querying")
if $self->started_iterating;
$self->_query->cursorType($bool ? 'tailable' : 'non_tailable');
return $self;
}
#pod =head2 tailable_await
#pod
#pod $cursor->tailable_await(1);
#pod
#pod Sets a cursor to be tailable and block for a few seconds if no data
#pod is immediately available.
#pod
#pod Boolean value, defaults to 0.
#pod
#pod If you want the tailable cursor without blocking, use L</tailable> instead.
#pod B<Note> calling this with a false value disables tailing, even if C<tailable>
#pod was previously called.
#pod
#pod =cut
sub tailable_await {
my ( $self, $bool ) = @_;
MongoDB::UsageError->throw("cannot set tailable_await after querying")
if $self->started_iterating;
$self->_query->cursorType($bool ? 'tailable_await' : 'non_tailable');
return $self;
}
#pod =head2 skip
#pod
#pod $cursor->skip( 50 );
#pod
#pod Skips the first N results.
#pod
#pod Returns this cursor for chaining operations.
#pod
#pod =cut
sub skip {
my ( $self, $num ) = @_;
MongoDB::UsageError->throw("skip must be non-negative")
if $num < 0;
MongoDB::UsageError->throw("cannot set skip after querying")
if $self->started_iterating;
$self->_query->skip($num);
return $self;
}
#pod =head2 snapshot
#pod
#pod $cursor->snapshot(1);
#pod
#pod Uses snapshot mode for the query. Snapshot mode assures no duplicates are
#pod returned due an intervening write relocating a document. Note that if an
#pod object is inserted, updated or deleted during the query, it may or may not
#pod be returned when snapshot mode is enabled. Short query responses (less than
#pod 1MB) are always effectively snapshotted. Currently, snapshot mode may not
#pod be used with sorting or explicit hints.
#pod
#pod Returns this cursor for chaining operations.
#pod
#pod =cut
sub snapshot {
my ($self, $bool) = @_;
MongoDB::UsageError->throw("cannot set snapshot after querying")
if $self->started_iterating;
MongoDB::UsageError->throw("snapshot requires a defined, boolean argument")
unless defined $bool;
$self->_query->modifiers->{'$snapshot'} = $bool;
return $self;
}
#pod =head2 hint
#pod
#pod $cursor->hint({'x' => 1});
#pod $cursor->hint(['x', 1]);
#pod $cursor->hint('x_1');
#pod
#pod Force Mongo to use a specific index for a query.
#pod
#pod Returns this cursor for chaining operations.
#pod
#pod =cut
sub hint {
my ( $self, $index ) = @_;
MongoDB::UsageError->throw("cannot set hint after querying")
if $self->started_iterating;
# $index must either be a string or a reference to an array, hash, or IxHash
if ( ref $index eq 'ARRAY' ) {
$index = Tie::IxHash->new(@$index);
}
elsif ( ref $index && !( ref $index eq 'HASH' || ref $index eq 'Tie::IxHash' ) ) {
MongoDB::UsageError->throw("not a hash reference");
}
$self->_query->modifiers->{'$hint'} = $index;
return $self;
}
#pod =head2 partial
#pod
#pod $cursor->partial(1);
#pod
#pod If a shard is down, mongos will return an error when it tries to query that
#pod shard. If this is set, mongos will just skip that shard, instead.
#pod
#pod Boolean value, defaults to 0.
#pod
#pod Returns this cursor for chaining operations.
#pod
#pod =cut
sub partial {
my ($self, $value) = @_;
MongoDB::UsageError->throw("cannot set partial after querying")
if $self->started_iterating;
$self->_query->allowPartialResults( !! $value );
# returning self is an API change but more consistent with other cursor methods
return $self;
}
#pod =head2 read_preference
#pod
#pod $cursor->read_preference($read_preference_object);
#pod $cursor->read_preference('secondary', [{foo => 'bar'}]);
#pod
#pod Sets read preference for the cursor's connection.
#pod
#pod If given a single argument that is a L<MongoDB::ReadPreference> object, the
#pod read preference is set to that object. Otherwise, it takes positional
#pod arguments: the read preference mode and a tag set list, which must be a valid
#pod mode and tag set list as described in the L<MongoDB::ReadPreference>
#pod documentation.
#pod
#pod Returns this cursor for chaining operations.
#pod
#pod =cut
sub read_preference {
my $self = shift;
MongoDB::UsageError->throw("cannot set read preference after querying")
if $self->started_iterating;
my $type = ref $_[0];
if ( $type eq 'MongoDB::ReadPreference' ) {
$self->_query->read_preference( $_[0] );
}
else {
my $mode = shift || 'primary';
my $tag_sets = shift;
my $rp = MongoDB::ReadPreference->new(
mode => $mode,
( $tag_sets ? ( tag_sets => $tag_sets ) : () )
);
$self->_query->read_preference($rp);
}
return $self;
}
#pod =head1 QUERY INTROSPECTION AND RESET
#pod
#pod These methods run introspection methods on the query conditions and modifiers
#pod stored within the cursor object.
#pod
#pod =head2 explain
#pod
#pod my $explanation = $cursor->explain;
#pod
#pod This will tell you the type of cursor used, the number of records the DB had to
#pod examine as part of this query, the number of records returned by the query, and
#pod the time in milliseconds the query took to execute.
#pod
#pod See also core documentation on explain:
#pod L<http://dochub.mongodb.org/core/explain>.
#pod
#pod =cut
sub explain {
my ($self) = @_;
my $explain_op = MongoDB::Op::_Explain->_new(
db_name => $self->_query->db_name,
coll_name => $self->_query->coll_name,
full_name => $self->_query->full_name,
bson_codec => $self->_query->bson_codec,
query => $self->_query->clone,
read_preference => $self->_query->read_preference,
read_concern => $self->_query->read_concern,
);
return $self->_query->client->send_read_op($explain_op);
}
#pod =head1 QUERY ITERATION
#pod
#pod These methods allow you to iterate over results.
#pod
#pod =head2 result
#pod
#pod my $result = $cursor->result;
#pod
#pod This method will execute the query and return a L<MongoDB::QueryResult> object
#pod with the results.
#pod
#pod The C<has_next>, C<next>, and C<all> methods call C<result> internally,
#pod which executes the query "on demand".
#pod
#pod Iterating with a MongoDB::QueryResult object directly instead of a
#pod L<MongoDB::Cursor> will be slightly faster, since the L<MongoDB::Cursor>
#pod methods below just internally call the corresponding method on the result
#pod object.
#pod
#pod =cut
#--------------------------------------------------------------------------#
# methods delgated to result object
#--------------------------------------------------------------------------#
#pod =head2 has_next
#pod
#pod while ($cursor->has_next) {
#pod ...
#pod }
#pod
#pod Checks if there is another result to fetch. Will automatically fetch more
#pod data from the server if necessary.
#pod
#pod =cut
sub has_next { $_[0]->result->has_next }
#pod =head2 next
#pod
#pod while (my $object = $cursor->next) {
#pod ...
#pod }
#pod
#pod Returns the next object in the cursor. Will automatically fetch more data from
#pod the server if necessary. Returns undef if no more data is available.
#pod
#pod =cut
sub next { $_[0]->result->next }
#pod =head2 batch
#pod
#pod while (my @batch = $cursor->batch) {
#pod ...
#pod }
#pod
#pod Returns the next batch of data from the cursor. Will automatically fetch more
#pod data from the server if necessary. Returns an empty list if no more data is available.
#pod
#pod =cut
sub batch { $_[0]->result->batch }
#pod =head2 all
#pod
#pod my @objects = $cursor->all;
#pod
#pod Returns a list of all objects in the result.
#pod
#pod =cut
sub all { $_[0]->result->all }
#pod =head2 reset
#pod
#pod Resets the cursor. After being reset, pre-query methods can be
#pod called on the cursor (sort, limit, etc.) and subsequent calls to
#pod result, next, has_next, or all will re-query the database.
#pod
#pod =cut
sub reset {
my ($self) = @_;
$self->_clear_result;
return $self;
}
#pod =head2 info
#pod
#pod Returns a hash of information about this cursor. This is intended for
#pod debugging purposes and users should not rely on the contents of this method for
#pod production use. Currently the fields are:
#pod
#pod =for :list
#pod * C<cursor_id> -- the server-side id for this cursor. See below for details.
#pod * C<num> -- the number of results received from the server so far
#pod * C<at> -- the (zero-based) index of the document that will be returned next from L</next>
#pod * C<flag> -- if the database could not find the cursor or another error occurred, C<flag> may
#pod contain a hash reference of flags set in the response (depending on the error). See
#pod L<http://www.mongodb.org/display/DOCS/Mongo+Wire+Protocol#MongoWireProtocol-OPREPLY>
#pod for a full list of flag values.
#pod * C<start> -- the index of the result that the current batch of results starts at.
#pod
#pod If the cursor has not yet executed, only the C<num> field will be returned with
#pod a value of 0.
#pod
#pod The C<cursor_id> could appear in one of three forms:
#pod
#pod =for :list
#pod * MongoDB::CursorID object (a blessed reference to an 8-byte string)
#pod * A perl scalar (an integer)
#pod * A Math::BigInt object (64 bit integer on 32-bit perl)
#pod
#pod When the C<cursor_id> is zero, there are no more results to fetch.
#pod
#pod =cut
sub info {
my $self = shift;
if ( $self->started_iterating ) {
return $self->result->_info;
}
else {
return { num => 0 };
}
}
#--------------------------------------------------------------------------#
# Deprecated methods
#--------------------------------------------------------------------------#
sub count {
my ($self, $limit_skip) = @_;
$self->_warn_deprecated(
'count' => "Use the 'count' method from MongoDB::Collection instead." );
my $cmd = new Tie::IxHash(count => $self->_query->coll_name);
$cmd->Push(query => $self->_query->filter);
if ($limit_skip) {
$cmd->Push(limit => $self->_query->limit) if $self->_query->limit;
$cmd->Push(skip => $self->_query->skip) if $self->_query->skip;
}
if (my $hint = $self->_query->modifiers->{'$hint'}) {
$cmd->Push(hint => $hint);
}
my $result = try {
my $db = $self->_query->client->get_database( $self->_query->db_name );
$db->run_command( $cmd, $self->_query->read_preference );
}
catch {
# if there was an error, check if it was the "ns missing" one that means the
# collection hasn't been created or a real error.
die $_ unless /^ns missing/;
};
return $result ? $result->{n} : 0;
}
my $PRIMARY = MongoDB::ReadPreference->new;
my $SEC_PREFERRED = MongoDB::ReadPreference->new( mode => 'secondaryPreferred' );
sub slave_okay {
my ($self, $value) = @_;
$self->_warn_deprecated( 'slave_okay' => [qw/read_preference/] );
MongoDB::UsageError->throw("cannot set slave_ok after querying")
if $self->started_iterating;
if ($value) {
# if not 'primary', then slave_ok is already true, so leave alone
if ( $self->_query->read_preference->mode eq 'primary' ) {
# secondaryPreferred is how mongos interpretes slave_ok
$self->_query->read_preference( $SEC_PREFERRED );
}
}
else {
$self->_query->read_preference( $PRIMARY );
}
# returning self is an API change but more consistent with other cursor methods
return $self;
}
1;
# vim: ts=4 sts=4 sw=4 et tw=75:
__END__
=pod
=encoding UTF-8
=head1 NAME
MongoDB::Cursor - A lazy cursor for Mongo query results
=head1 VERSION
version v1.8.1
=head1 SYNOPSIS
while (my $object = $cursor->next) {
...
}
my @objects = $cursor->all;
=head1 USAGE
=head2 Multithreading
Cursors are cloned in threads, but not reset. Iterating the same cursor from
multiple threads will give unpredictable results. Only iterate from a single
thread.
=head1 ATTRIBUTES
=head2 started_iterating
A boolean indicating if this cursor has queried the database yet. Methods
modifying the query will complain if they are called after the database is
queried.
=head1 QUERY MODIFIERS
These methods modify the query to be run. An exception will be thrown if
they are called after results are iterated.
=head2 immortal
$cursor->immortal(1);
Ordinarily, a cursor "dies" on the database server after a certain length of
time (approximately 10 minutes), to prevent inactive cursors from hogging
resources. This option indicates that a cursor should not die until all of its
results have been fetched or it goes out of scope in Perl.
Boolean value, defaults to 0.
Note: C<immortal> only affects the server-side timeout. If you are getting
client-side timeouts you will need to change your client configuration.
See L<MongoDB::MongoClient/max_time_ms> and
L<MongoDB::MongoClient/socket_timeout_ms>.
Returns this cursor for chaining operations.
=head2 fields
$coll->insert({name => "Fred", age => 20});
my $cursor = $coll->find->fields({ name => 1 });
my $obj = $cursor->next;
$obj->{name}; "Fred"
$obj->{age}; # undef
Selects which fields are returned. The default is all fields. When fields
are specified, _id is returned by default, but this can be disabled by
explicitly setting it to "0". E.g. C<< _id => 0 >>. Argument must be either a
hash reference or a L<Tie::IxHash> object.
See L<Limit fields to
return|http://docs.mongodb.org/manual/tutorial/project-fields-from-query-results/>
in the MongoDB documentation for details.
Returns this cursor for chaining operations.
=head2 sort
# sort by name, descending
$cursor->sort([name => -1]);
Adds a sort to the query. Argument is either a hash reference or a
L<Tie::IxHash> or an array reference of key/value pairs. Because hash
references are not ordered, do not use them for more than one key.
Returns this cursor for chaining operations.
=head2 limit
$cursor->limit(20);
Sets cursor to return a maximum of N results.
Returns this cursor for chaining operations.
=head2 max_await_time_ms
$cursor->max_await_time_ms( 500 );
The maximum amount of time in milliseconds for the server to wait on new
documents to satisfy a tailable cursor query. This only applies to a
cursor of type 'tailble_await'. This is ignored if the cursor is not
a 'tailable_await' cursor or the server version is less than version 3.2.
Returns this cursor for chaining operations.
=head2 max_time_ms
$cursor->max_time_ms( 500 );
Causes the server to abort the operation if the specified time in milliseconds
is exceeded.
Returns this cursor for chaining operations.
=head2 tailable
$cursor->tailable(1);
If a cursor should be tailable. Tailable cursors can only be used on capped
collections and are similar to the C<tail -f> command: they never die and keep
returning new results as more is added to a collection.
They are often used for getting log messages.
Boolean value, defaults to 0.
If you want the tailable cursor to block for a few seconds, use
L</tailable_await> instead. B<Note> calling this with a false value
disables tailing, even if C<tailable_await> was previously called.
Returns this cursor for chaining operations.
=head2 tailable_await
$cursor->tailable_await(1);
Sets a cursor to be tailable and block for a few seconds if no data
is immediately available.
Boolean value, defaults to 0.
If you want the tailable cursor without blocking, use L</tailable> instead.
B<Note> calling this with a false value disables tailing, even if C<tailable>
was previously called.
=head2 skip
$cursor->skip( 50 );
Skips the first N results.
Returns this cursor for chaining operations.
=head2 snapshot
$cursor->snapshot(1);
Uses snapshot mode for the query. Snapshot mode assures no duplicates are
returned due an intervening write relocating a document. Note that if an
object is inserted, updated or deleted during the query, it may or may not
be returned when snapshot mode is enabled. Short query responses (less than
1MB) are always effectively snapshotted. Currently, snapshot mode may not
be used with sorting or explicit hints.
Returns this cursor for chaining operations.
=head2 hint
$cursor->hint({'x' => 1});
$cursor->hint(['x', 1]);
$cursor->hint('x_1');
Force Mongo to use a specific index for a query.
Returns this cursor for chaining operations.
=head2 partial
$cursor->partial(1);
If a shard is down, mongos will return an error when it tries to query that
shard. If this is set, mongos will just skip that shard, instead.
Boolean value, defaults to 0.
Returns this cursor for chaining operations.
=head2 read_preference
$cursor->read_preference($read_preference_object);
$cursor->read_preference('secondary', [{foo => 'bar'}]);
Sets read preference for the cursor's connection.
If given a single argument that is a L<MongoDB::ReadPreference> object, the
read preference is set to that object. Otherwise, it takes positional
arguments: the read preference mode and a tag set list, which must be a valid
mode and tag set list as described in the L<MongoDB::ReadPreference>
documentation.
Returns this cursor for chaining operations.
=head1 QUERY INTROSPECTION AND RESET
These methods run introspection methods on the query conditions and modifiers
stored within the cursor object.
=head2 explain
my $explanation = $cursor->explain;
This will tell you the type of cursor used, the number of records the DB had to
examine as part of this query, the number of records returned by the query, and
the time in milliseconds the query took to execute.
See also core documentation on explain:
L<http://dochub.mongodb.org/core/explain>.
=head1 QUERY ITERATION
These methods allow you to iterate over results.
=head2 result
my $result = $cursor->result;
This method will execute the query and return a L<MongoDB::QueryResult> object
with the results.
The C<has_next>, C<next>, and C<all> methods call C<result> internally,
which executes the query "on demand".
Iterating with a MongoDB::QueryResult object directly instead of a
L<MongoDB::Cursor> will be slightly faster, since the L<MongoDB::Cursor>
methods below just internally call the corresponding method on the result
object.
=head2 has_next
while ($cursor->has_next) {
...
}
Checks if there is another result to fetch. Will automatically fetch more
data from the server if necessary.
=head2 next
while (my $object = $cursor->next) {
...
}
Returns the next object in the cursor. Will automatically fetch more data from
the server if necessary. Returns undef if no more data is available.
=head2 batch
while (my @batch = $cursor->batch) {
...
}
Returns the next batch of data from the cursor. Will automatically fetch more
data from the server if necessary. Returns an empty list if no more data is available.
=head2 all
my @objects = $cursor->all;
Returns a list of all objects in the result.
=head2 reset
Resets the cursor. After being reset, pre-query methods can be
called on the cursor (sort, limit, etc.) and subsequent calls to
result, next, has_next, or all will re-query the database.
=head2 info
Returns a hash of information about this cursor. This is intended for
debugging purposes and users should not rely on the contents of this method for
production use. Currently the fields are:
=over 4
=item *
C<cursor_id> -- the server-side id for this cursor. See below for details.
=item *
C<num> -- the number of results received from the server so far
=item *
C<at> -- the (zero-based) index of the document that will be returned next from L</next>
=item *
C<flag> -- if the database could not find the cursor or another error occurred, C<flag> may contain a hash reference of flags set in the response (depending on the error). See L<http://www.mongodb.org/display/DOCS/Mongo+Wire+Protocol#MongoWireProtocol-OPREPLY> for a full list of flag values.
=item *
C<start> -- the index of the result that the current batch of results starts at.
=back
If the cursor has not yet executed, only the C<num> field will be returned with
a value of 0.
The C<cursor_id> could appear in one of three forms:
=over 4
=item *
MongoDB::CursorID object (a blessed reference to an 8-byte string)
=item *
A perl scalar (an integer)
=item *
A Math::BigInt object (64 bit integer on 32-bit perl)
=back
When the C<cursor_id> is zero, there are no more results to fetch.
=head1 SEE ALSO
Core documentation on cursors: L<http://dochub.mongodb.org/core/cursors>.
=head1 AUTHORS
=over 4
=item *
David Golden <david@mongodb.com>
=item *
Rassi <rassi@mongodb.com>
=item *
Mike Friedman <friedo@friedo.com>
=item *
Kristina Chodorow <k.chodorow@gmail.com>
=item *
Florian Ragwitz <rafl@debian.org>
=back
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2018 by MongoDB, Inc.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
=cut
|