Class yii\mongodb\Connection
Inheritance | yii\mongodb\Connection » yii\base\Component |
---|---|
Available since version | 2.0 |
Connection represents a connection to a MongoDb server.
Connection works together with yii\mongodb\Database and yii\mongodb\Collection to provide data access to the Mongo database. They are wrappers of the [[MongoDB PHP extension]](http://us1.php.net/manual/en/book.mongo.php).
To establish a DB connection, set $dsn and then call open() to be true.
The following example shows how to create a Connection instance and establish the DB connection:
$connection = new \yii\mongodb\Connection([
'dsn' => $dsn,
]);
$connection->open();
After the Mongo connection is established, one can access Mongo databases and collections:
$database = $connection->getDatabase('my_mongo_db');
$collection = $database->getCollection('customer');
$collection->insert(['name' => 'John Smith', 'status' => 1]);
You can work with several different databases at the same server using this class. However, while it is unlikely your application will actually need it, the Connection class provides ability to use $defaultDatabaseName as well as a shortcut method getCollection() to retrieve a particular collection instance:
// get collection 'customer' from default database:
$collection = $connection->getCollection('customer');
// get collection 'customer' from database 'mydatabase':
$collection = $connection->getCollection(['mydatabase', 'customer']);
Connection is often used as an application component and configured in the application configuration like the following:
[
'components' => [
'mongodb' => [
'class' => '\yii\mongodb\Connection',
'dsn' => 'mongodb://developer:password@localhost:27017/mydatabase',
],
],
]
Public Properties
Property | Type | Description | Defined By |
---|---|---|---|
$defaultDatabaseName | string | Name of the Mongo database to use by default. | yii\mongodb\Connection |
$driverOptions | array | Options for the MongoDB driver. | yii\mongodb\Connection |
$dsn | string | Host:port Correct syntax is: mongodb://[username:password@]host1[:port1][,host2[:port2:],. | yii\mongodb\Connection |
$mongoClient | \MongoClient | Mongo client instance. | yii\mongodb\Connection |
$options | array | Connection options. | yii\mongodb\Connection |
Public Methods
Method | Description | Defined By |
---|---|---|
close() | Closes the currently active DB connection. | yii\mongodb\Connection |
getCollection() | Returns the Mongo collection with the given name. | yii\mongodb\Connection |
getDatabase() | Returns the Mongo collection with the given name. | yii\mongodb\Connection |
getFileCollection() | Returns the Mongo GridFS collection. | yii\mongodb\Connection |
getIsActive() | Returns a value indicating whether the Mongo connection is established. | yii\mongodb\Connection |
open() | Establishes a Mongo connection. | yii\mongodb\Connection |
Protected Methods
Method | Description | Defined By |
---|---|---|
fetchDefaultDatabaseName() | Returns $defaultDatabaseName value, if it is not set, attempts to determine it from $dsn value. | yii\mongodb\Connection |
initConnection() | Initializes the DB connection. | yii\mongodb\Connection |
selectDatabase() | Selects the database with given name. | yii\mongodb\Connection |
Events
Event | Type | Description | Defined By |
---|---|---|---|
EVENT_AFTER_OPEN | \yii\mongodb\Event | An event that is triggered after a DB connection is established | yii\mongodb\Connection |
Property Details
Name of the Mongo database to use by default. If this field left blank, connection instance will attempt to determine it from $options and $dsn automatically, if needed.
Options for the MongoDB driver.
See also http://www.php.net/manual/en/mongoclient.construct.php.
Host:port
Correct syntax is: mongodb://[username:password@]host1[:port1][,host2[:port2:],...][/dbname] For example: mongodb://localhost:27017 mongodb://developer:password@localhost:27017 mongodb://developer:password@localhost:27017/mydatabase
Mongo client instance.
Connection options. For example:
[
'socketTimeoutMS' => 1000, // how long a send or receive on a socket can take before timing out
'journal' => true // block write operations until the journal be flushed the to disk
]
See also http://www.php.net/manual/en/mongoclient.construct.php.
Method Details
Closes the currently active DB connection.
It does nothing if the connection is already closed.
public void close ( ) |
Returns $defaultDatabaseName value, if it is not set, attempts to determine it from $dsn value.
protected string fetchDefaultDatabaseName ( ) | ||
return | string | Default database name |
---|---|---|
throws | \yii\base\InvalidConfigException | if unable to determine default database name. |
Returns the Mongo collection with the given name.
public yii\mongodb\Collection getCollection ( $name, $refresh = false ) | ||
$name | string|array | Collection name. If string considered as the name of the collection inside the default database. If array - first element considered as the name of the database, second - as name of collection inside that database |
$refresh | boolean | Whether to reload the collection instance even if it is found in the cache. |
return | yii\mongodb\Collection | Mongo collection instance. |
---|
Returns the Mongo collection with the given name.
public yii\mongodb\Database getDatabase ( $name = null, $refresh = false ) | ||
$name | string|null | Collection name, if null default one will be used. |
$refresh | boolean | Whether to reestablish the database connection even if it is found in the cache. |
return | yii\mongodb\Database | Database instance. |
---|
Returns the Mongo GridFS collection.
public yii\mongodb\file\Collection getFileCollection ( $prefix = 'fs', $refresh = false ) | ||
$prefix | string|array | Collection prefix. If string considered as the prefix of the GridFS collection inside the default database. If array - first element considered as the name of the database, second - as prefix of the GridFS collection inside that database, if no second element present default "fs" prefix will be used. |
$refresh | boolean | Whether to reload the collection instance even if it is found in the cache. |
return | yii\mongodb\file\Collection | Mongo GridFS collection instance. |
---|
Returns a value indicating whether the Mongo connection is established.
public boolean getIsActive ( ) | ||
return | boolean | Whether the Mongo connection is established |
---|
Initializes the DB connection.
This method is invoked right after the DB connection is established. The default implementation triggers an EVENT_AFTER_OPEN event.
protected void initConnection ( ) |
Establishes a Mongo connection.
It does nothing if a Mongo connection has already been established.
public void open ( ) | ||
throws | yii\mongodb\Exception | if connection fails |
---|
Selects the database with given name.
protected yii\mongodb\Database selectDatabase ( $name ) | ||
$name | string | Database name. |
return | yii\mongodb\Database | Database instance. |
---|