MongoClient クラス

(PECL mongo >=1.3.0)

警告

このクラスを定義している拡張モジュールは非推奨です。かわりに MongoDB 拡張モジュールを使うべきです。このクラスの代替として、以下が使えます。

MongoDB\Driver\Manager

はじめに

PHP と MongoDB の接続を管理します。

このクラスを使って、接続を作ったり管理したりします。典型的な使いかたは、このようになります。

例1 MongoClient の基本的な使いかた


<?php

$m = new MongoClient(); // 接続します
$db = $m->foo; // "foo" というデータベースを取得します

?>

接続の作成に関する詳細な情報は、 MongoClient::__construct() および接続のセクションを参照ください。

クラス概要

MongoClient {

/* 定数 */

const string VERSION ;

const string DEFAULT_HOST = "localhost" ;

const int DEFAULT_PORT = 27017 ;

const string RP_PRIMARY = "primary" ;

const string RP_PRIMARY_PREFERRED = "primaryPreferred" ;

const string RP_SECONDARY = "secondary" ;

const string RP_SECONDARY_PREFERRED = "secondaryPreferred" ;

const string RP_NEAREST = "nearest" ;

/* プロパティ */

public boolean $connected = FALSE ;

public string $status = NULL ;

protected string $server = NULL ;

protected boolean $persistent = NULL ;

/* メソッド */

public __construct ([ string $server = "mongodb://localhost:27017" [, array $options = array("connect" => TRUE) [, array $driver_options ]]] )

public bool Mongo::close ([ boolean|string $connection ] )

public bool Mongo::connect ( void )

public array dropDB ( mixed $db )

public MongoDB Mongo::__get ( string $dbname )

public static array getConnections ( void )

public array Mongo::getHosts ( void )

public array getReadPreference ( void )

public array getWriteConcern ( void )

public bool killCursor ( string $server_hash , int|MongoInt64 $id )

public array Mongo::listDBs ( void )

public MongoCollection selectCollection ( string $db , string $collection )

public MongoDB selectDB ( string $name )

public bool setReadPreference ( string $read_preference [, array $tags ] )

public bool setWriteConcern ( mixed $w [, int $wtimeout ] )

public string Mongo::__toString ( void )

}

定義済み定数

MongoClient 定数

MongoClient::VERSION: PHP ドライバのバージョン。中間バージョンの場合は最後に "dev" や "+"、そして "-" がつくことがあります。
MongoClient::DEFAULT_HOST
"localhost": ホストを指定しない場合に接続するホスト。
MongoClient::DEFAULT_PORT
27017: ポートを指定しない場合に接続するポート。
MongoClient::RP_PRIMARY
"primary": プライマリのレプリカセットメンバーを優先読み込みする。
MongoClient::RP_PRIMARY_PREFERRED
"primaryPreferred": プライマリのレプリカセットメンバーのほうを優先して優先読み込みする。
MongoClient::RP_SECONDARY
"secondary": セカンダリのレプリカセットメンバーを優先読み込みする。
MongoClient::RP_SECONDARY_PREFERRED
"secondaryPreferred": セカンダリのレプリカセットメンバーの方を優先して優先読み込みする。
MongoClient::RP_NEAREST
"nearest": 最も近いレプリカセットメンバーを優先読み込みする。

フィールド

connected

このプロパティに TRUE が設定されるのは、データベース接続がオープンしている場合です。それ以外の場合は FALSE が設定されます。レプリカセットへの接続の場合は、現在の優先読み込みにマッチするノードに接続している場合にのみ TRUE となります。このプロパティは、認証を考慮しません。

このプロパティは、バージョン 1.5.0 以降で 非推奨 となりました。

status

このプロパティはもう使われておらず、値は NULL に設定されます。バージョン 1.1.x より前のドライバでは、持続的接続を使う場合にここに文字列 ("recycled" や "new" など) が設定されていました。