NAME Mongoose - MongoDB document to Moose object mapper VERSION version 0.07 SYNOPSIS package Person; use Moose; with 'Mongoose::Document'; has 'name' => ( is => 'rw', isa => 'Str' ); package main; use Mongoose; Mongoose->db('mydb'); my $person = Person->new( name => 'Jack' ); $person->save; my $person = Person->find_one( { name => 'Jack' } ); say $person->name; # Jack my $cursor = Person->find( { name => 'Jack' } ); die "Not found" unless defined $cursor; while ( my $person = $cursor->next ) { say "You're " . $person->name; } $person->delete; DESCRIPTION This is a MongoDB to Moose object mapper. This module allows you to use the full power of MongoDB within your Moose classes, without sacrificing MongoDB's power, flexibility and speed. It's loosely inspired by Ruby's MongoMapper, which is in turn loosely based on the ActiveRecord pattern. Start by reading the introduction Mongoose::Intro. Or proceed directly to the Mongoose::Cookbook for many day-to-day recipes. METHODS db Sets the current MongoDB connection and/or db name. Mongoose->db( 'mydb' ); The connection defaults to whatever MongoDB defaults are (typically localhost:27017). For more control over the connection, "db" takes the same parameters as MongoDB::Connection, plus "db_name". my $db = Mongoose->db( host => 'mongodb://localhost:27017', query_timeout => 60, db_name => 'mydb' ); This will, in turn, instantiate a MongoDB::Connection instance with all given parameters and return a MongoDB::Database object. Important: Mongoose will always defer connecting to Mongo until the last possible moment. This is done to prevent using the MongoDB driver in a forked environment (ie. with a prefork appserver like Starman, Hypnotoad or Catalyst's HTTP::Prefork). If you prefer to connect while setting the connection string, use one of these 2 options: Mongoose->db( db_name=>'mydb', -now=>1 ); # connect now # or by wating for a return value my $db = Mongoose->db( 'mydb' ); # or explicitly: Mongoose->db( 'mydb' ); Mongoose->connect; connect Connects to Mongo using the connection arguments passed to the "db" method. load_schema Uses Module::Pluggable to "require" all modules under a given search path or search dir. All arguments will be sent to Module::Pluggable's "import", except for Mongoose specific ones. package main; use Mongoose; # to load a schema from a namespace path: Mongoose->load_schema( search_path=>'MyApp::Schema' ); This method can be used to shorten class names, aliasing them for convenience if you wish: Mongoose->load_schema( search_path=>'MyApp::Schema', shorten=>1 ); Will shorten the module name to it's last bit: MyApp::Schema::Author->new( ... ); # becomes Author->new( ... ); naming By default, Mongoose composes the Mongo collection name from your package name by replacing double-colon "::" with underscores "_", separating camel-case, such as "aB" with "a_b" and uppercase with lowercase letters. This method let's you change this behaviour, by setting the collection naming routine with a "closure". The closure receives the package name as first parameter and should return the collection name. # let me change the naming strategy # for my mongo collections # to plain lowercase Mongoose->naming( sub { lc(shift) } ); # if you prefer, use a predefined naming template Mongoose->naming( 'plural' ); # my favorite # or combine them Mongoose->naming( ['decamel','plural' ] ); # same as 'shorties' Here are the templates available: template | package name | collection --------------+--------------------------+--------------------------- short | MyApp::Schema::FooBar | foobar plural | MyApp::Schema::FooBar | foobars decamel | MyApp::Schema::FooBar | foo_bar lower | MyApp::Schema::FooBar | myapp::schema::author upper | MyApp::Schema::FooBar | MYAPP::SCHEMA::AUTHOR undercolon | MyApp::Schema::FooBar | myapp_schema_foobar default | MyApp::Schema::FooBar | myapp_schema_foo_bar none | MyApp::Schema::Author | MyApp::Schema::Author BTW, you can just use the full package name (template "none") as a collection in Mongo, as it won't complain about colons in the collection name. connection Sets/returns the current connection object, of class MongoDB::Connection. Defaults to whatever MongoDB defaults. REPOSITORY Fork me on github: BUGS This is a WIP, barely *beta* quality software. Report bugs via RT. Send me test cases. TODO * Better error control * Finish-up multiple database support * Allow query->fields to control which fields get expanded into the object. * Cleanup internals. * More tests and use cases. * Better documentation. SEE ALSO KiokuDB AUTHOR Rodrigo de Oliveira (rodrigolive), C CONTRIBUTORS Arthur Wolf Solli Moreira Honorio (shonorio) LICENSE This library is free software. You can redistribute it and/or modify it under the same terms as Perl itself.