MongoDB Extension for Yii 2
This extension provides the [MongoDB](https://www.mongodb.com/) integration for the [Yii framework 2.0](https://www.yiiframework.com).
For license information check the [LICENSE](LICENSE.md)-file.
Documentation is at [docs/guide/README.md](docs/guide/README.md).
[](https://packagist.org/packages/yiisoft/yii2-mongodb)
[](https://packagist.org/packages/yiisoft/yii2-mongodb)
[](https://github.com/yiisoft/yii2-mongodb/actions)
[](https://codecov.io/gh/yiisoft/yii2-mongodb)
Requirements
------------
This extension requires [MongoDB PHP Extension](https://www.php.net/manual/en/set.mongodb.php) version 1.20.1 or higher.
This extension requires MongoDB server version 4.0 or higher.
Installation
------------
> [!IMPORTANT]
> - The minimum required [PHP](https://www.php.net/) version is PHP `7.4`.
> - It works best with PHP `8`.
The preferred way to install this extension is through [composer](https://getcomposer.org/download/).
Either run
```
php composer.phar require --prefer-dist yiisoft/yii2-mongodb
```
or add
```
"yiisoft/yii2-mongodb": "~3.0.0"
```
to the `require` section of your `composer.json`.
Configuration
-------------
To use this extension, simply add the following code in your application configuration:
```php
return [
//....
'components' => [
'mongodb' => [
'class' => '\yii\mongodb\Connection',
'dsn' => 'mongodb://localhost:27017/mydatabase',
'options' => [
"username" => "Username",
"password" => "Password"
]
],
],
];
```
Known issues
------------
- yii\mongodb\Exception: no such command: 'group' with MongoDB server version 4.2 or higher.
Starting in version 4.2, MongoDB removes the group command (deprecated since version 3.4) and its mongo shell helper db.collection.group().