MongoCursor::timeout

(PECL mongo >=1.0.3)

MongoCursor::timeout — Sets a client-side timeout for this query

说明

public MongoCursor::timeout ( int $ms ) : MongoCursor

A timeout can be set at any time and will affect subsequent queries on the cursor, including fetching more results from the database.

参数

ms

The number of milliseconds for the cursor to wait for a response. Use -1 to wait forever. By default, the cursor will wait 30000 milliseconds (30 seconds).

返回值

This cursor.

错误／异常

Causes methods that fetch results to throw a MongoCursorTimeoutException if the query takes longer than the specified number of milliseconds.

范例

Example #1 MongoCursor::timeout() example

In the following example, the driver will wait forever for the initial database response, and then wait 100ms for subsequent responses.

<?php

$cursor = $collection->find();
$cursor->timeout(-1);

/* $cursor->hasNext() executes the query. An infinite timeout has been set, so
 * the driver will wait as long as necessary for a response.
 */
while ($cursor->hasNext()) {
    $cursor->timeout(100);

    /* A timeout has now been set, so if the cursor needs to get more results
     * from the database, it will only wait 100ms for a response.
     */
    try {
        print_r($cursor->getNext());
    } catch (MongoCursorTimeoutException $e) {
        echo "query took too long!";
    }
}

?>

注释

Warning

This does not cause the MongoDB server to cancel long-running operations; it only instructs the driver to stop waiting for a response and throw a MongoCursorTimeoutException after a set time. If you need to specify a server-side timeout for a query, consider using MongoCursor::maxTimeMS().

参见

相关文章
php cubrid 函数 get the query timeout value of the requestphp gupnp 函数 sets the event subscription timeoutphp ldap 函数 sort ldap result entries on the client sidephp oci8 函数 sets a millisecond timeout for database callsphp swoole 函数 exit the eventloop only available at the client sidephp mongocommandcursor sets a client side timeout for this commandphp mongocursor adds a top level key/value pair to a queryphp mongocursor sets whether this cursor will wait for a while for a tailable cursor to return more dataphp mongocursor counts the number of results for this queryphp mongocursor sets the fields for a queryphp mongocursor sets whether this cursor will timeoutphp mongocursor sets a server side timeout for this queryphp mongocursor if this query should fetch partial results from mongos if a shard is downphp mongocursor sets whether this query can be done on a secondary deprecated php mongocursor sets a client side timeout for this queryphp mongocursorinterface sets a client side timeout for this queryphp solrdismaxquery directly sets boost query parameter bq php solrquery sets the explainother common query parameterphp solrquery sets the search queryphp swoole event exit the eventloop only available at client side.
关注编程学问公众号