Mongoat

A straight forward Mongo ODM (ORM) for Symfony2

Menu

• Configuration - configuring Mongoat with Symfony2 or standalone
• Schemas - defining fields and relationships
• Queries - finding and updating documents
• Models - getting and setting, saving and loading data
• Relationships - getting and setting related documents
• Populating - getting related documents efficiently

Features

• Simple, concise, well tested code
• Complex relationships with simple caching and no hassle
• Populate relationships with join-like queries
• Inherit any part of Mongoat in your project
• Define your schema in code, in the model
• No code generation

Planned:

• Generate migration files automatically to migrate data easily
• Migrate your database forwards or backwards
• More Symfony integration

Simple example

Define a model by extending Mongoat's Model class.

namespace Acme\YourBundle\Model;
use WhiteOctober\MongoatBundle\Core\Model;

class User extends Model
{
	public function definition($schema)
	{
		$schema->fields(array(
			'name' => array('type' => 'string'),
			'score' => array('type' => 'integer')
		));

		$schema->relationships(
			'cat' => array('type' => 'hasOne', 'class' => 'Cat'),
			'team' => array('type' => 'belongsTo', 'class' => 'Team'),
		));

		return $schema;
	}
}

Create and save a new user:

$user = $mongoat->create('User');
$user->name('John');
$user->score(33);
$user->save();

Find that user again and delete them:

$query = $mongoat->find('User');
$user = $query->where('name', 'John')->one();
$user->delete();

TODO

• Store changes separately to field data
• Provide support for scoped class references (e.g. Mongoat:User)
• Automatically scope symfony bundles (e.g AcmeEpicBundle:Cat)
• Build better foreign key names for relationships, allow custom foreign key name
• Look into mongo date timezones, normalise?
• Add default sort for queries and relationships
• Build field update/insert generator
• Complete population feature
• Add support for symfony validation
• Add logging
• Add query analyser
• Support additional operators: $slice, $regex, $where, $elemMatch, $bit, $mod
• Add map method for queries
• Check reserved field names
• Tests:
  • Model
    • Advanced relationship caching
  • Mongoat
    • Test connections
    • Making find query
    • Making update query
    • Making delete query
    • Unit of work
    • Populating
  • Query
    • where() method
    • fields() method
    • limit(), skip(), page()
    • Populating
    • Find: one, all
    • Update: one, all
    • Delete: one, all