Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yiisoft/db-mongodb
Yii Framework MongoDB extension
https://github.com/yiisoft/db-mongodb
hacktoberfest mongodb optionalforframeworkannounce yii3
Last synced: about 1 month ago
JSON representation
Yii Framework MongoDB extension
- Host: GitHub
- URL: https://github.com/yiisoft/db-mongodb
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2018-08-02T16:02:37.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-16T22:23:18.000Z (almost 2 years ago)
- Last Synced: 2024-03-21T14:17:42.660Z (8 months ago)
- Topics: hacktoberfest, mongodb, optionalforframeworkannounce, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 10.1 MB
- Stars: 12
- Watchers: 19
- Forks: 5
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii Database MongoDB driver
[](https://packagist.org/packages/yiisoft/db-mongodb)
[](https://packagist.org/packages/yiisoft/db-mongodb)
[](https://github.com/yiisoft/db-mongodb/actions?query=workflow%3Abuild)
[](https://codecov.io/gh/yiisoft/db-mongodb)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/db-mongodb/master)
[](https://github.com/yiisoft/db-mongodb/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/db-mongodb)
[](https://shepherd.dev/github/yiisoft/db-mongodb)
This extension provides the [MongoDB](https://www.mongodb.com/) integration for the [Yii framework](https://www.yiiframework.com).
## Requirements
- [MongoDB PHP Extension](https://www.php.net/manual/en/set.mongodb.php) version 1.8.0 or higher.
- MongoDB server version 3.0 or higher.
- PHP 8.1 or higher.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/db-mongodb
```
## General usage
To use this extension, simply add the following code in your application configuration:
```php
return [
//....
'components' => [
'mongodb' => [
'class' => Yiisoft\Db\MongoDb\Connection::class,
'dsn' => 'mongodb://@localhost:27017/mydatabase',
'options' => [
"username" => "Username",
"password" => "Password"
]
],
],
];
```
Once you have a MongoDB connection instance, you can execute a MongoDB commands and queries
using `Yiisoft\Db\MongoDb\Command`:
```php
// execute command:
$result = Yii::$app->mongodb->createCommand(['listIndexes' => 'some_collection'])->execute();
// execute query (find):
$cursor = Yii::$app->mongodb->createCommand(['projection' => ['name' => true]])->query('some_collection');
// execute batch (bulk) operations:
Yii::$app->mongodb->createCommand()
->addInsert(['name' => 'new'])
->addUpdate(['name' => 'existing'], ['name' => 'updated'])
->addDelete(['name' => 'old'])
->executeBatch('customer');
```
Using the connection instance you may access databases and collections.
Most of the MongoDB commands are accessible via `\Yiisoft\Db\MongoDb\Collection` instance:
```php
$collection = Yii::$app->mongodb->getCollection('customer');
$collection->insert(['name' => 'John Smith', 'status' => 1]);
```
To perform `find` queries, you should use `\Yiisoft\Db\MongoDb\Query`:
```php
use Yiisoft\Db\MongoDb\Query;
$query = new Query();
// compose the query
$query->select(['name', 'status'])
->from('customer')
->limit(10);
// execute the query
$rows = $query->all();
```
## Documentation
- Guide: [English](docs/guide/en/README.md), [Français](docs/guide/fr/README.md), [Русский](docs/guide/ru/README.md), [日本語](docs/guide/ja/README.md)
- [Internals](docs/internals.md)
If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.
You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
## License
The Yii Database MongoDB driver is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.
Maintained by [Yii Software](https://www.yiiframework.com/).
## Support the project
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)