KO
|
EN
gitlite — search
Search
#typescript
#ai-agents
#ai
#dsh-plugin
#deepseek-harness
#open-source
#cli
#claude-code
#codex
#developer-tools
#react
#windows
db-mongodb
★ 12
Open GitHub ↗
Yii Framework MongoDB extension
Download README (.md)
Explore Similar Repositories
yii-auth-client
:
Yii Framework external authentication via OAuth and OpenID Extension
requirements
:
Requirements checker
db-redis
:
Yii DBAL Redis connection
db-elasticsearch
:
Yii Framework Elasticsearch Query and ActiveRecord
yii-debug-viewer
:
Debugger frontend
// repository documentation
Was this content helpful?
★ 0
(0 ratings)
Select Rating:
★
★
★
★
★
Submit Feedback
Recent Feedback
×
Download README
Do you want to download the
README.md
file for
db-mongodb
?
Download (.md)
> [!WARNING] > There is no official MongoDB support planned for Yii3 DB. [Use official PHP client instead](https://www.mongodb.com/docs/php-library/current/). <p align="center"> <a href="https://github.com/yiisoft" target="_blank"> <img src="https://yiisoft.github.io/docs/images/yii_logo.svg" height="100px" alt="Yii"> </a> <a href="https://www.mongodb.com/" target="_blank"> <img src="https://webassets.mongodb.com/_com_assets/cms/mongodb-logo-rgb-j6w271g1xn.jpg" height="100px" alt="MongoDB"> </a> <h1 align="center">Yii Database MongoDB driver</h1> <br> </p> [](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)
