63 lines
1.8 KiB
Markdown
63 lines
1.8 KiB
Markdown
<p align="center">
|
|
<a href="https://www.mongodb.com/" target="_blank" rel="external">
|
|
<img src="https://webassets.mongodb.com/_com_assets/cms/mongodb-logo-rgb-j6w271g1xn.jpg" height="80px">
|
|
</a>
|
|
<h1 align="center">MongoDB Extension for Yii 2</h1>
|
|
<br>
|
|
</p>
|
|
|
|
This extension provides the [MongoDB](https://www.mongodb.com/) integration for the [Yii framework 2.0](http://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://travis-ci.org/yiisoft/yii2-mongodb)
|
|
|
|
|
|
Installation
|
|
------------
|
|
|
|
This extension requires [MongoDB PHP Extension](http://us1.php.net/manual/en/set.mongodb.php) version 1.0.0 or higher.
|
|
|
|
This extension requires MongoDB server version 3.0 or higher.
|
|
|
|
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
|
|
|
|
Either run
|
|
|
|
```
|
|
php composer.phar require --prefer-dist yiisoft/yii2-mongodb
|
|
```
|
|
|
|
or add
|
|
|
|
```
|
|
"yiisoft/yii2-mongodb": "~2.1.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"
|
|
]
|
|
],
|
|
],
|
|
];
|
|
```
|