« MongoDB\Driver\ReadConcern::getLevel
MongoDB\Driver\Cursor »

MongoDB\Driver\ReadConcern::isDefault

(mongodb >=1.3.0)

MongoDB\Driver\ReadConcern::isDefault — Checks if this is the default read concern

説明

final public function MongoDB\Driver\ReadConcern::isDefault(): bool

Returns whether this is the default read concern (i.e. no options are specified). This method is primarily intended to be used in conjunction with MongoDB\Driver\Manager::getReadConcern() to determine whether the Manager has been constructed without any read concern options.

The driver will not include a default read concern in its read operations (e.g. MongoDB\Driver\Manager::executeQuery()) in order to allow the server to apply its own default. Libraries that access the Manager's read concern to include it in their own read commands should use this method to ensure that default read concerns are left unset.

パラメータ

この関数にはパラメータはありません。

戻り値

Returns true if this is the default read concern and false otherwise.

エラー / 例外

例

例1 MongoDB\Driver\ReadConcern::isDefault() example

<?php

$rc = new MongoDB\Driver\ReadConcern(null);
var_dump($rc->isDefault());

$rc = new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY);
var_dump($rc->isDefault());

$manager = new MongoDB\Driver\Manager('mongodb://127.0.0.1/?readConcernLevel=majority');
$rc = $manager->getReadConcern();
var_dump($rc->isDefault());

$manager = new MongoDB\Driver\Manager('mongodb://127.0.0.1/');
$rc = $manager->getReadConcern();
var_dump($rc->isDefault());

?>

上の例の出力は以下となります。

bool(true)
bool(false)
bool(false)
bool(true)

参考

関連キーワード:
MongoDB   Driver   read   ReadConcern   default   concern   isDefault   Manager   getReadConcern   dump   manager   Checks   mongodb   whether   options   method   getLevel   Cursor   final   specified   primarily   intended   used   conjunction   determine
関連する関数・ページ:
mongodb-driver-manager.getreadconcern   mongodb-driver-writeconcern.isdefault   mongodb-driver-readconcern.construct   mongodb-driver-readconcern.getlevel   mongodb-driver-readconcern.bsonserialize   class.mongodb-driver-readconcern