PHP 5.4.33 Released

MongoCursor::snapshot

(PECL mongo >=0.9.4)

MongoCursor::snapshotUse snapshot mode for the query

Description

public MongoCursor MongoCursor::snapshot ( void )

Use snapshot mode for the query. Snapshot mode ensures that a document will not be returned more than once because an intervening write operation results in a move of the document. Documents inserted or deleted during the lifetime of the cursor may or may not be returned, irrespective of snapshot mode.

Queries with short responses (less than 1MB) are always effectively snapshotted.

Snapshot mode may not be used with sorting, explicit hints, or queries on sharded collections.

Parameters

This function has no parameters.

Return Values

Returns this cursor.

Errors/Exceptions

Throws MongoCursorException if this cursor has started iterating.

See Also

MongoDB core docs on » $snapshot operator.

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top