table of contents
MongoDB::ChangeStream(3pm) | User Contributed Perl Documentation | MongoDB::ChangeStream(3pm) |
NAME¶
MongoDB::ChangeStream - A stream providing update information for collections.VERSION¶
version v2.0.3SYNOPSIS¶
$stream = $collection->watch( $pipeline, $options ); while(1) { # This inner loop will only iterate until there are no more # changes available. while (my $change = $stream->next) { ... } }
DESCRIPTION¶
This class models change stream results as returned by the "watch" in MongoDB::Collection method.STREAM METHODS¶
next¶
$change_stream = $collection->watch(...); $change = $change_stream->next;
Waits for the next change in the collection and returns it.
Note: This method will wait for the amount of milliseconds passed as "maxAwaitTimeMS" to "watch" in MongoDB::Collection or the server's default wait-time. It will not wait indefinitely.
SEE ALSO¶
The Change Streams manual section <https://docs.mongodb.com/manual/changeStreams/>.The Change Streams specification <https://github.com/mongodb/specifications/blob/master/source/change-streams.rst>.
AUTHORS¶
- David Golden <david@mongodb.com>
- Rassi <rassi@mongodb.com>
- Mike Friedman <friedo@friedo.com>
- Kristina Chodorow <k.chodorow@gmail.com>
- Florian Ragwitz <rafl@debian.org>
COPYRIGHT AND LICENSE¶
This software is Copyright (c) 2019 by MongoDB, Inc.This is free software, licensed under:
The Apache License, Version 2.0, January 2004
2019-02-09 | perl v5.28.1 |