PHP Conference China 2020

MongoCursor::setFlag

(PECL mongo >=1.2.11)

MongoCursor::setFlagSets arbitrary flags in case there is no method available the specific flag

Beschreibung

public MongoCursor::setFlag ( int $flag [, bool $set = TRUE ] ) : MongoCursor

The MongoCursor class has several methods for setting flags on the query object. This method is available in case the MongoDB wire protocol has acquired a new flag, and the driver has not been updated with a method for this new flag. In all other cases, the method should be used. See the "See also" section for available methods.

Parameter-Liste

flag

Which flag to set. You can not set flag 6 (EXHAUST) as the driver does not know how to handle them. You will get a warning if you try to use this flag. For available flags, please refer to the wire protocol » documentation.

set

Whether the flag should be set (TRUE) or unset (FALSE).

R├╝ckgabewerte

Returns this cursor.

Fehler/Exceptions

Shows a warning when an unsupport flag is attempted to be set.

Changelog

Version Beschreibung
1.4.0 Support for flag 3 (OPLOG_REPLAY) is added. Versions before 1.4.0 would throw a warning saying that the flag is unsupported.

Beispiele

Beispiel #1 MongoCursor::setFlag() example

<?php
$m 
= new MongoClient'mongodb://localhost:13000', array( 'replSet' => 'seta' ) );
$c $m->local->selectCollection'oplog.rs' );
$cursor $c->find( array( 'ns' => 'demo.article''op' => 'i' ) );
$cursor->setFlag1true ); // sets the tailable flag
$cursor->setFlag5true ); // sets the await data flag
?>

Siehe auch

add a note add a note

User Contributed Notes

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