MongoDB\ChangeStream Class

Definition

MongoDB\ChangeStream

This class extends PHP's

Iteratorinterface. An instance of this class is returned byMongoDB\Client::watch(), MongoDB\Database::watch(), and MongoDB\Collection::watch().

This class allows for iteration of events in a change stream. It also allows iteration to automatically resume after certain errors, such as a replica set failover.

Methods

• MongoDB\ChangeStream::current()

• MongoDB\ChangeStream::getCursorId()

• MongoDB\ChangeStream::getResumeToken()

• MongoDB\ChangeStream::key()

• MongoDB\ChangeStream::next()

• MongoDB\ChangeStream::rewind()

• MongoDB\ChangeStream::valid()