Class yii\mongodb\Connection

Inheritanceyii\mongodb\Connection » yii\base\Component » yii\base\Object
Implementsyii\base\Configurable
Available since version2.0
Source Code https://github.com/yiisoft/yii2-mongodb/blob/master/Connection.php

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

Hide inherited properties

PropertyTypeDescriptionDefined By
$behaviors yii\base\Behavior[] List of behaviors attached to this component yii\base\Component
$database yii\mongodb\Database Database instance. yii\mongodb\Connection
$defaultDatabaseName string Name of the Mongo database to use by default. yii\mongodb\Connection
$dsn string Host:port Correct syntax is: mongodb://[username:password@]host1[:port1][,host2[:port2:],. yii\mongodb\Connection
$fileCollection yii\mongodb\file\Collection Mongo GridFS collection instance. yii\mongodb\Connection
$isActive boolean Whether the Mongo connection is established yii\mongodb\Connection
$mongoClient \MongoClient Mongo client instance. yii\mongodb\Connection
$options array Connection options. yii\mongodb\Connection

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Component
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\Object
__get() Returns the value of a component property. yii\base\Component
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Component
__set() Sets the value of a component property. yii\base\Component
__unset() Sets a component property to be null. yii\base\Component
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Component
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Component
className() Returns the fully qualified name of this class. yii\base\Object
close() Closes the currently active DB connection. yii\mongodb\Connection
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
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
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\Component
hasProperty() Returns a value indicating whether a property is defined for this component. yii\base\Component
init() Initializes the object. yii\base\Object
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
open() Establishes a Mongo connection. yii\mongodb\Connection
trigger() Triggers an event. yii\base\Component

Protected Methods

Hide inherited methods

MethodDescriptionDefined 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

Hide inherited events

EventTypeDescriptionDefined By
EVENT_AFTER_OPEN \yii\mongodb\Event An event that is triggered after a DB connection is established yii\mongodb\Connection

Property Details

$database public read-only property
yii\mongodb\Database getDatabase$name null$refresh false )

Database instance.

$defaultDatabaseName public property

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.

$dsn public property
string $dsn null

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

$fileCollection public read-only property
yii\mongodb\file\Collection getFileCollection$prefix 'fs'$refresh false )

Mongo GridFS collection instance.

$isActive public read-only property

Whether the Mongo connection is established

$mongoClient public property
\MongoClient $mongoClient null

Mongo client instance.

$options public property

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

close() public method

Closes the currently active DB connection.

It does nothing if the connection is already closed.

void close( )
fetchDefaultDatabaseName() protected method

Returns $defaultDatabaseName value, if it is not set, attempts to determine it from $dsn value.

string fetchDefaultDatabaseName( )
return string

Default database name

throws yii\base\InvalidConfigException

if unable to determine default database name.

getCollection() public method

Returns the Mongo collection with the given name.

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.

getDatabase() public method

Returns the Mongo collection with the given name.

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.

getFileCollection() public method

Returns the Mongo GridFS collection.

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.

getIsActive() public method

Returns a value indicating whether the Mongo connection is established.

boolean getIsActive( )
return boolean

Whether the Mongo connection is established

initConnection() protected method

Initializes the DB connection.

This method is invoked right after the DB connection is established. The default implementation triggers an EVENT_AFTER_OPEN event.

void initConnection( )
open() public method

Establishes a Mongo connection.

It does nothing if a Mongo connection has already been established.

void open( )
throws yii\mongodb\Exception

if connection fails

selectDatabase() protected method

Selects the database with given name.

yii\mongodb\Database selectDatabase$name )
$name string

Database name.

return yii\mongodb\Database

Database instance.

Event Details

EVENT_AFTER_OPEN event

An event that is triggered after a DB connection is established