yiisoft / db-mongodb
Yii Framework MongoDB extension
Fund package maintenance!
Opencollective
yiisoft
Installs: 98
Dependents: 0
Suggesters: 0
Security: 0
Stars: 12
Watchers: 20
Forks: 7
Open Issues: 3
Language:Dockerfile
Requires
- php: ^8.1
- ext-mongodb: >=1.8.0
Requires (Dev)
- phpunit/phpunit: ^9.5|^10.0
- roave/infection-static-analysis-plugin: ^1.6
- spatie/phpunit-watcher: ^1.23
- vimeo/psalm: ^5.20
- yiisoft/arrays: ^2.0|^3.0
- yiisoft/cache: ^1.0
- yiisoft/di: dev-master
- yiisoft/factory: ^1.0
- yiisoft/log: ^1.0
- yiisoft/strings: ^2.0
- yiisoft/var-dumper: ^1.0
This package is auto-updated.
Last update: 2024-10-30 05:11:44 UTC
README
Yii Database MongoDB driver
This extension provides the MongoDB integration for the Yii framework.
Requirements
- MongoDB PHP Extension 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:
composer require yiisoft/db-mongodb
General usage
To use this extension, simply add the following code in your application configuration:
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
:
// 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:
$collection = Yii::$app->mongodb->getCollection('customer'); $collection->insert(['name' => 'John Smith', 'status' => 1]);
To perform find
queries, you should use \Yiisoft\Db\MongoDb\Query
:
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
If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.
License
The Yii Database MongoDB driver is free software. It is released under the terms of the BSD License.
Please see LICENSE
for more information.
Maintained by Yii Software.