Класс yii\mongodb\Connection

Connection представляет собой подключение к серверу MongoDb.

Connection работает совместно с yii\mongodb\Database и yii\mongodb\Collection для обеспечения доступа к данным в базе данных Mongo. Они являются оболочками для [[MongoDB PHP extension]](http://us1.php.net/manual/en/book.mongo.php).

Для установления подключения к базе данных, задайте $dsn, а затем вызовите open() со значением true.

Следующий пример демонстрирует, как создать экземпляр Connection и установить подключение к базе данных:

$connection = new \yii\mongodb\Connection([
    'dsn' => $dsn,
]);
$connection->open();

После установления подключения к Mongo, можно получить доступ к базам данных и коллекциям Mongo:

$database = $connection->getDatabase('my_mongo_db');
$collection = $database->getCollection('customer');
$collection->insert(['name' => 'John Smith', 'status' => 1]);

Вы можете работать с несколькими разными базами данных на одном сервере с помощью этого класса. Однако, хотя маловероятно, что вашему приложению это понадобится, класс Connection предоставляет возможность использовать $defaultDatabaseName, а также сокращенный метод getCollection() для получения конкретного экземпляра коллекции:

// get collection 'customer' from default database:
$collection = $connection->getCollection('customer');
// get collection 'customer' from database 'mydatabase':
$collection = $connection->getCollection(['mydatabase', 'customer']);

Connection часто используется как компонент приложения и настраивается в конфигурации приложения, как показано ниже:

[
     'components' => [
         'mongodb' => [
             'class' => '\yii\mongodb\Connection',
             'dsn' => 'mongodb://developer:password@localhost:27017/mydatabase',
         ],
     ],
]

Публичные свойства

Публичные методы

Защищённые методы

События

Подробное описание свойств

$database общедоступное только для чтения свойство

Экземпляр базы данных.

public yii\mongodb\Database getDatabase ( $name = null, $refresh = false )

$defaultDatabaseName общедоступное свойство

Имя базы данных по умолчанию.

public string getDefaultDatabaseName ( )
public void setDefaultDatabaseName ( $name )

$driverOptions общедоступное свойство

Параметры для драйвера MongoDB. Любые специфичные для драйвера параметры, не включённые в строку подключения к MongoDB.

См. также http://php.net/manual/en/mongodb-driver-manager.construct.php.

public array $driverOptions = []

$dsn общедоступное свойство

Хост:порт

Правильный синтаксис: mongodb://[имя пользователя:пароль@]хост1[:порт1][,хост2[:порт2:],...][/имя базы данных] Например: mongodb://localhost:27017 mongodb://разработчик:пароль@localhost:27017 mongodb://разработчик:пароль@localhost:27017/моябазаданных

public string $dsn = null

$enableLogging общедоступное свойство (доступно с версии 2.1)

Включать ли протоколирование выполнения команд и запросов. При включенном режиме производительность может снизиться. Команды MongoDB могут содержать большие данные, потребляя при этом процессор и память. В производственной среде рекомендуется отключить этот параметр.

public boolean $enableLogging = true

$enableProfiling свойство общедоступное (доступно с версии 2.1)

Включить ли профилирование команд и запросов, которые выполняются. Этот параметр не будет иметь эффекта, если $enableLogging отключен.

public boolean $enableProfiling = true

$fileCollection общедоступное только для чтения свойство

Экземпляр коллекции Mongo GridFS.

public yii\mongodb\file\Collection getFileCollection ( $prefix = 'fs', $refresh = false )

$fileStreamProtocol общедоступное свойство (доступно с версии 2.1)

Имя протокола, который должен использоваться для оболочки потока GridFS. Разрешены только буквенно-цифровые значения: не используйте специальные символы URL, такие как '/', '&', ':' и т. д.

См. также yii\mongodb\file\StreamWrapper.

public string $fileStreamProtocol = 'gridfs'

$fileStreamWrapperClass общедоступное свойство (доступно с версии 2.1)

Имя класса, который должен служить оболочкой потока для протокола $fileStreamProtocol.

public string $fileStreamWrapperClass = 'yii\mongodb\file\StreamWrapper'

$isActive общедоступное только для чтения свойство

Установлено ли соединение с Mongo.

public boolean getIsActive ( )

$logBuilder общедоступное свойство

Построитель логов для этого соединения.

public yii\mongodb\LogBuilder getLogBuilder ( )
public void setLogBuilder ( $logBuilder )

$manager общедоступное свойство (доступно с версии 2.1)

Менеджер драйвера MongoDB.

public \MongoDB\Driver\Manager $manager = null

$options общедоступное свойство

Параметры подключения. Например:

[
    'socketTimeoutMS' => 1000, // how long a send or receive on a socket can take before timing out
    'ssl' => true // initiate the connection with TLS/SSL
]

См. также https://docs.mongodb.com/manual/reference/connection-string/#connections-connection-options.

public array $options = []

$queryBuilder общедоступное свойство

Построитель запросов для этого соединения MongoDB.

public yii\mongodb\QueryBuilder getQueryBuilder ( )
public void setQueryBuilder ( $queryBuilder )

$typeMap общедоступное свойство (доступно с версии 2.1)

Карта типов, используемая для BSON-десериализации. Примечание: карта типов по умолчанию будет автоматически объединена с этим полем, возможно, перезаписывая значения, заданные пользователем.

См. также http://php.net/manual/en/mongodb-driver-cursor.settypemap.php.

public array $typeMap = []

Подробное описание методов

Подробное описание событий