Php/docs/class.mongoclient

PHP Manual
コアクラス群
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 bool $connected = false

public string $status = null

protected string $server = null

protected bool $persistent = null

/* メソッド */

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

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

public Mongo::connect ( ) : bool

public dropDB ( mixed $db ) : array

public Mongo::__get ( string $dbname ) : MongoDB

public static getConnections ( ) : array

public Mongo::getHosts ( ) : array

public getReadPreference ( ) : array

public getWriteConcern ( ) : array

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

public listDBs ( ) : array

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

public selectDB ( string $name ) : MongoDB

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

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

public Mongo::__toString ( ) : string

}

定義済み定数

MongoClient 定数

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

フィールド

connected

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

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

status

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