mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 13:58:55 +00:00
2bbc330460
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@294371 c90b9560-bf6c-de11-be94-00142212c4b1
67 lines
1.9 KiB
XML
67 lines
1.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="mongocursor.snapshot" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>MongoCursor::snapshot</refname>
|
|
<refpurpose>Use snapshot mode for the query</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>MongoCursor</type><methodname>MongoCursor::snapshot</methodname>
|
|
<void/>
|
|
</methodsynopsis>
|
|
<para>
|
|
Use snapshot mode for the query. Snapshot mode assures no duplicates are returned,
|
|
or objects missed, which were present at both the start and end of the query's
|
|
execution (if an object is new during the query, or deleted during the query, it
|
|
may or may not be returned, even with snapshot mode).
|
|
</para>
|
|
<para>
|
|
Note that short query responses (less than 1MB) are always effectively snapshotted.
|
|
</para>
|
|
<para>
|
|
Currently, snapshot mode may not be used with sorting or explicit hints.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
&no.function.parameters;
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns this cursor.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="errors">
|
|
&reftitle.errors;
|
|
<para>
|
|
Throws <classname>MongoCursorException</classname> if this cursor has started iterating.
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|