Php/docs/class.mongoclient
(PECL mongo >=1.3.0)
Warning This extension that defines this class is deprecated. Instead, the MongoDB extension should be used. Alternatives to this class include:
简介
PHP 和 MongoDB 的连接管理器。
这个类用于创建和管理连接。典型的用法:
Example #1 MongoClient 基本用法
<?php$m = new MongoClient(); // 连接$db = $m->foo; // 获取名称为 "foo" 的数据库?>
关于创建连接的更多信息,参见 MongoClient::__construct() 和 connecting 的章节。
类摘要
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
)
]] )
public close
([ boolean|string $connection
] ) : bool
public connect ( ) : bool
public static getConnections ( ) : array
public 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 setReadPreference
( string $read_preference
[, array $tags
] ) : bool
public setWriteConcern
( mixed $w
[, int $wtimeout
] ) : bool
public __toString ( ) : string
}
预定义常量
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
。 如果连接副本集(replica set)里一个节点并匹配当前的读取选项 ,该属性仅会是true
。 这个属性不考虑账户是否已认证。版本 1.5.0 后该属性已经废弃( deprecated)。
status
这个属性不会再被使用,将会被设置为
null
在驱动版本 1.1.x 及更早版本中,使用持久连接时这可能会被设置为字符串的值(比如"recycled"
,"new"
)。版本 1.5.0 后该属性已经废弃( deprecated)。
Table of Contents
- MongoClient::close — 关闭连接
- MongoClient::connect — 连接到数据库服务器
- MongoClient::__construct — 创建一个新的数据库连接对象
- MongoClient::dropDB — 删除一个数据库 [已废弃]
- MongoClient::__get — 取得一个数据库
- MongoClient::getConnections — 返回所有已打开连接的信息
- MongoClient::getHosts — 更新所有关联主机的状态信息
- MongoClient::getReadPreference — 获取此连接的读取首选项
- MongoClient::getWriteConcern — Get the write concern for this connection
- MongoClient::killCursor — Kills a specific cursor on the server
- MongoClient::listDBs — 列出所有有效数据库
- MongoClient::selectCollection — 获取数据库的文档集
- MongoClient::selectDB — 获取一个数据库
- MongoClient::setReadPreference — 为该连接设置读取选项
- MongoClient::setWriteConcern — Set the write concern for this connection
- MongoClient::__toString — 该连接的字符串表达方式
/* 常量 */