Mango::Collection - MongoDB collection
use Mango::Collection; my $collection = Mango::Collection->new(db => $db); my $cursor = $collection->find({foo => 'bar'});
Mango::Collection is a container for MongoDB collections used by Mango::Database.
Mango::Collection implements the following attributes.
my $db = $collection->db; $collection = $collection->db(Mango::Database->new);
Mango::Database object this collection belongs to.
my $name = $collection->name; $collection = $collection->name('bar');
Name of this collection.
Mango::Collection inherits all methods from Mojo::Base and implements the following new ones.
my $docs = $collection->aggregate( [{'$group' => {_id => undef, total => {'$sum' => '$foo'}}}]); my $cursor = $collection->aggregate( [{'$match' => {'$gt' => 23}}], {cursor => {}}); my $collection = $collection->aggregate( [{'$match' => {'$gt' => 23}}, {'$out' => 'some_collection'}]);
Aggregate collection with aggregation framework, additional options will be passed along to the server verbatim.. You can also append a callback to perform operation non-blocking.
my $pipeline = [{'$group' => {_id => undef, total => {'$sum' => '$foo'}}}]; $collection->aggregate($pipeline => sub { my ($collection, $err, $docs) = @_; ... }); Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
my $name = $collection->build_index_name(bson_doc(foo => 1, bar => -1)); my $name = $collection->build_index_name({foo => 1});
Build name for index specification, the order of keys matters for compound indexes.
$collection->create; $collection->create({capped => bson_true, max => 5, size => 10000});
Create collection. You can also append a callback to perform operation non-blocking.
$collection->create({capped => bson_true, max => 5, size => 10000} => sub { my ($collection, $err) = @_; ... }); Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
$collection->drop;
Drop collection. You can also append a callback to perform operation non-blocking.
$collection->drop(sub { my ($collection, $err) = @_; ... }); Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
$collection->drop_index('foo');
Drop index. You can also append a callback to perform operation non-blocking.
$collection->drop_index(foo => sub { my ($collection, $err) = @_; ... }); Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
$collection->ensure_index(bson_doc(foo => 1, bar => -1)); $collection->ensure_index({foo => 1}); $collection->ensure_index({foo => 1}, {unique => bson_true});
Make sure an index exists, the order of keys matters for compound indexes, additional options will be passed along to the server verbatim. You can also append a callback to perform operation non-blocking.
$collection->ensure_index(({foo => 1}, {unique => bson_true}) => sub { my ($collection, $err) = @_; ... }); Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
my $cursor = $collection->find; my $cursor = $collection->find({foo => 'bar'}); my $cursor = $collection->find({foo => 'bar'}, {foo => 1});
Get Mango::Cursor object for query.
my $doc = $collection->find_and_modify( {query => {foo => 'bar'}, update => {'$set' => {foo => 'baz'}}});
Update document atomically. You can also append a callback to perform operation non-blocking.
my $opts = {query => {foo => 'bar'}, update => {'$set' => {foo => 'baz'}}}; $collection->find_and_modify($opts => sub { my ($collection, $err, $doc) = @_; ... }); Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
my $doc = $collection->find_one({foo => 'bar'}); my $doc = $collection->find_one({foo => 'bar'}, {foo => 1}); my $doc = $collection->find_one($oid, {foo => 1});
Find one document. You can also append a callback to perform operation non-blocking.
$collection->find_one({foo => 'bar'} => sub { my ($collection, $err, $doc) = @_; ... }); Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
my $name = $collection->full_name;
Full name of this collection.
my $info = $collection->index_information;
Get index information for collection. You can also append a callback to perform operation non-blocking.
$collection->index_information(sub { my ($collection, $err, $info) = @_; ... }); Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
my $oid = $collection->insert({foo => 'bar'}); my $oids = $collection->insert([{foo => 'bar'}, {baz => 'yada'}]);
Insert one or more documents into collection. You can also append a callback to perform operation non-blocking.
$collection->insert({foo => 'bar'} => sub { my ($collection, $err, $oid) = @_; ... }); Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
my $foo = $collection->map_reduce($map, $reduce, {out => 'foo'}); my $docs = $collection->map_reduce($map, $reduce, {out => {inline => 1}}); my $docs = $collection->map_reduce( bson_code($map), bson_code($reduce), {out => {inline => 1}});
Perform map/reduce operation on this collection, additional options will be passed along to the server verbatim. You can also append a callback to perform operation non-blocking.
$collection->map_reduce(($map, $reduce, {out => {inline => 1}}) => sub { my ($collection, $err, $docs) = @_; ... } ); Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
my $doc = $collection->remove; my $doc = $collection->remove({foo => 'bar'}); my $doc = $collection->remove({foo => 'bar'}, {single => 1});
Remove documents from collection. You can also append a callback to perform operation non-blocking.
$collection->remove(({foo => 'bar'}, {single => 1}) => sub { my ($collection, $err, $doc) = @_; ... }); Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
These options are currently available:
Remove only one document.
my $oid = $collection->save({foo => 'bar'});
Save document to collection. You can also append a callback to perform operation non-blocking.
$collection->save({foo => 'bar'} => sub { my ($collection, $err, $oid) = @_; ... }); Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
my $stats = $collection->stats;
Get collection statistics. You can also append a callback to perform operation non-blocking.
$collection->stats(sub { my ($collection, $err, $stats) = @_; ... }); Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
my $doc = $collection->update({foo => 'bar'}, {foo => 'baz'}); my $doc = $collection->update({foo => 'bar'}, {foo => 'baz'}, {multi => 1});
Update document in collection. You can also append a callback to perform operation non-blocking.
$collection->update(({foo => 'bar'}, {foo => 'baz'}, {multi => 1}) => sub { my ($collection, $err, $doc) = @_; ... }); Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
Update more than one document.
Insert document if none could be updated.
Mango, Mojolicious::Guides, http://mojolicio.us.
To install Mango, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Mango
CPAN shell
perl -MCPAN -e shell install Mango
For more information on module installation, please visit the detailed CPAN module installation guide.