MongoDB Datasource for CakePHP

Installs: 3 011

Dependents: 0

Stars: 348

Watchers: 48

Forks: 150

Open Issues: 56

Type: cakephp-plugin

dev-cake2.2 / 2.2.x-dev 2014-06-24 00:47 UTC


Build Status Coverage Status



this repository should be installed in the same way as any other plugin.

To install the driver for use in a single application:

cd my/app/Plugin
git clone git://github.com/ichikaway/cakephp-mongodb.git Mongodb

To install the driver for use in any/multiple application(s)

# where ROOT is the name of the directory parent to the base index.php of CakePHP.
cd ROOT/Plugin
git clone git://github.com/ichikaway/cakephp-mongodb.git Mongodb


This plugin on the Packagist.


Sample Code

To use this DB driver, install (obviously) and define a db source such as follows:


// app/Config/database.php
    public $default = array(
        'datasource' => 'Mongodb.MongodbSource',
        'host' => 'localhost',
        'database' => 'blog',
        'port' => 27017,
        'prefix' => '',
        'persistent' => 'true',
        /* optional auth fields
        'login' => 'mongo', 
        'password' => 'awesomeness',
        'replicaset' => array('host' => 'mongodb://hoge:hogehoge@localhost:27021,localhost:27022/blog', 
                              'options' => array('replicaSet' => 'myRepl')

    // To make sure all tests are passing create the following entry in app/Config/database.php
    public $test = array(
        'datasource' => 'Mongodb.MongodbSource',
        'database' => 'test_mongo',
        'host' => 'localhost',
        'port' => 27017,

More detail of replicaset in wiki: https://github.com/ichikaway/cakephp-mongodb/wiki/How-to-connect-to-replicaset-servers

Model files need to have mongoSchema property - or make use of the schemaless behavior.

Mongo uses a primary key named "_id" (cannot be renamed). It can be any format you like but if you don't explicitly set it Mongo will use an automatic 24 character (uu)id.

Before you start, you may find it useful to see a model sample. There are also some sample controller actions: find,save,delete,deleteAll,updateAll note that your controller code needs no specific code to use this datasource.


Yasushi Ichikawa (ichikaway)

Andy Dawson (AD7six)


Predominant : Cleanup code, add documentation

Jrbasso : Cleanup code

tkyk : Fix bug, Add some function.


Reference code, Thank you!

Nate Abele's lithium mongoDB datasource

Joél Perras' divan