.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mango::Collection 3pm"
.TH Mango::Collection 3pm "2020-06-05" "perl v5.30.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Mango::Collection \- MongoDB collection
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Mango::Collection;
\&
\&  my $collection = Mango::Collection\->new(db => $db);
\&  my $cursor     = $collection\->find({foo => \*(Aqbar\*(Aq});
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Mango::Collection is a container for MongoDB collections used by
Mango::Database.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
Mango::Collection implements the following attributes.
.SS "db"
.IX Subsection "db"
.Vb 2
\&  my $db      = $collection\->db;
\&  $collection = $collection\->db(Mango::Database\->new);
.Ve
.PP
Mango::Database object this collection belongs to.
.SS "name"
.IX Subsection "name"
.Vb 2
\&  my $name    = $collection\->name;
\&  $collection = $collection\->name(\*(Aqbar\*(Aq);
.Ve
.PP
Name of this collection.
.SH "METHODS"
.IX Header "METHODS"
Mango::Collection inherits all methods from Mojo::Base and implements
the following new ones.
.SS "aggregate"
.IX Subsection "aggregate"
.Vb 6
\&  my $cursor = $collection\->aggregate(
\&    [{\*(Aq$group\*(Aq => {_id => undef, total => {\*(Aq$sum\*(Aq => \*(Aq$foo\*(Aq}}}]);
\&  my $collection = $collection\->aggregate(
\&    [{\*(Aq$match\*(Aq => {\*(Aq$gt\*(Aq => 23}}, {\*(Aq$out\*(Aq => \*(Aqsome_collection\*(Aq}]);
\&  my $doc = $collection\->aggregate(
\&    [{\*(Aq$match\*(Aq => {\*(Aq$gt\*(Aq => 23}}], {explain => bson_true});
.Ve
.PP
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.
.PP
.Vb 6
\&  my $pipeline = [{\*(Aq$group\*(Aq => {_id => undef, total => {\*(Aq$sum\*(Aq => \*(Aq$foo\*(Aq}}}];
\&  $collection\->aggregate($pipeline => sub {
\&    my ($collection, $err, $cursor) = @_;
\&    ...
\&  });
\&  Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running;
.Ve
.SS "build_index_name"
.IX Subsection "build_index_name"
.Vb 2
\&  my $name = $collection\->build_index_name(bson_doc(foo => 1, bar => \-1));
\&  my $name = $collection\->build_index_name({foo => 1});
.Ve
.PP
Build name for index specification, the order of keys matters for compound
indexes.
.SS "bulk"
.IX Subsection "bulk"
.Vb 1
\&  my $bulk = $collection\->bulk;
.Ve
.PP
Build Mango::Bulk object.
.PP
.Vb 5
\&  my $bulk = $collection\->bulk;
\&  $bulk\->insert({foo => $_}) for 1 .. 10;
\&  $bulk\->find({foo => 4})\->update_one({\*(Aq$set\*(Aq => {bar => \*(Aqbaz\*(Aq}});
\&  $bulk\->find({foo => 7})\->remove_one;
\&  my $results = $bulk\->execute;
.Ve
.SS "create"
.IX Subsection "create"
.Vb 2
\&  $collection\->create;
\&  $collection\->create({capped => bson_true, max => 5, size => 10000});
.Ve
.PP
Create collection. You can also append a callback to perform operation
non-blocking.
.PP
.Vb 5
\&  $collection\->create({capped => bson_true, max => 5, size => 10000} => sub {
\&    my ($collection, $err) = @_;
\&    ...
\&  });
\&  Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running;
.Ve
.SS "drop"
.IX Subsection "drop"
.Vb 1
\&  $collection\->drop;
.Ve
.PP
Drop collection. You can also append a callback to perform operation
non-blocking.
.PP
.Vb 5
\&  $collection\->drop(sub {
\&    my ($collection, $err) = @_;
\&    ...
\&  });
\&  Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running;
.Ve
.SS "drop_index"
.IX Subsection "drop_index"
.Vb 1
\&  $collection\->drop_index(\*(Aqfoo\*(Aq);
.Ve
.PP
Drop index. You can also append a callback to perform operation non-blocking.
.PP
.Vb 5
\&  $collection\->drop_index(foo => sub {
\&    my ($collection, $err) = @_;
\&    ...
\&  });
\&  Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running;
.Ve
.SS "ensure_index"
.IX Subsection "ensure_index"
.Vb 3
\&  $collection\->ensure_index(bson_doc(foo => 1, bar => \-1));
\&  $collection\->ensure_index({foo => 1});
\&  $collection\->ensure_index({foo => 1}, {unique => bson_true});
.Ve
.PP
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.
.PP
.Vb 5
\&  $collection\->ensure_index(({foo => 1}, {unique => bson_true}) => sub {
\&    my ($collection, $err) = @_;
\&    ...
\&  });
\&  Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running;
.Ve
.SS "find"
.IX Subsection "find"
.Vb 3
\&  my $cursor = $collection\->find;
\&  my $cursor = $collection\->find({foo => \*(Aqbar\*(Aq});
\&  my $cursor = $collection\->find({foo => \*(Aqbar\*(Aq}, {foo => 1});
.Ve
.PP
Build Mango::Cursor::Query object for query.
.PP
.Vb 2
\&  # Exclude "_id" field from results
\&  my $docs = $collection\->find({foo => \*(Aqbar\*(Aq}, {_id => 0})\->all;
.Ve
.SS "find_and_modify"
.IX Subsection "find_and_modify"
.Vb 2
\&  my $doc = $collection\->find_and_modify(
\&    {query => {foo => \*(Aqbar\*(Aq}, update => {\*(Aq$set\*(Aq => {foo => \*(Aqbaz\*(Aq}}});
.Ve
.PP
Fetch and update or remove a document atomically. You can also append a callback
to perform operation non-blocking.
.PP
.Vb 6
\&  my $opts = {query => {foo => \*(Aqbar\*(Aq}, update => {\*(Aq$set\*(Aq => {foo => \*(Aqbaz\*(Aq}}};
\&  $collection\->find_and_modify($opts => sub {
\&    my ($collection, $err, $doc) = @_;
\&    ...
\&  });
\&  Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running;
.Ve
.PP
By default this method returns the unmodified version of the document. To
change this behaviour, add the option \f(CW\*(C`new => 1\*(C'\fR.
.SS "find_one"
.IX Subsection "find_one"
.Vb 3
\&  my $doc = $collection\->find_one({foo => \*(Aqbar\*(Aq});
\&  my $doc = $collection\->find_one({foo => \*(Aqbar\*(Aq}, {foo => 1});
\&  my $doc = $collection\->find_one($oid, {foo => 1});
.Ve
.PP
Find one document. You can also append a callback to perform operation
non-blocking.
.PP
.Vb 5
\&  $collection\->find_one({foo => \*(Aqbar\*(Aq} => sub {
\&    my ($collection, $err, $doc) = @_;
\&    ...
\&  });
\&  Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running;
.Ve
.SS "full_name"
.IX Subsection "full_name"
.Vb 1
\&  my $name = $collection\->full_name;
.Ve
.PP
Full name of this collection.
.SS "index_information"
.IX Subsection "index_information"
.Vb 3
\&  my $info = $collection\->index_information;
\&  # return only the 5 first indexes
\&  my $info = $collection\->index_information(cursor => { batchSize => 5 });
.Ve
.PP
Get index information for collection. You can also append a callback to
perform operation non-blocking.
.PP
.Vb 5
\&  $collection\->index_information(sub {
\&    my ($collection, $err, $info) = @_;
\&    ...
\&  });
\&  Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running;
.Ve
.SS "insert"
.IX Subsection "insert"
.Vb 2
\&  my $oid  = $collection\->insert({foo => \*(Aqbar\*(Aq});
\&  my $oids = $collection\->insert([{foo => \*(Aqbar\*(Aq}, {baz => \*(Aqyada\*(Aq}]);
.Ve
.PP
Insert one or more documents into collection. You can also append a callback
to perform operation non-blocking.
.PP
.Vb 5
\&  $collection\->insert({foo => \*(Aqbar\*(Aq} => sub {
\&    my ($collection, $err, $oid) = @_;
\&    ...
\&  });
\&  Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running;
.Ve
.PP
Note that \f(CW\*(C`insert\*(C'\fR has to ensure each document has an \f(CW\*(C`_id\*(C'\fR before sending
them to MongoDB. To avoid modifying your data, it makes a copy of the
documents. This can be a bit slow if you are sending big objects like
pictures. To avoid that, consider using \f(CW\*(C`save\*(C'\fR instead.
.SS "map_reduce"
.IX Subsection "map_reduce"
.Vb 4
\&  my $collection = $collection\->map_reduce($map, $reduce, {out => \*(Aqfoo\*(Aq});
\&  my $docs = $collection\->map_reduce($map, $reduce, {out => {inline => 1}});
\&  my $docs = $collection\->map_reduce(
\&    bson_code($map), bson_code($reduce), {out => {inline => 1}});
.Ve
.PP
Perform map/reduce operation on collection, additional options will be passed
along to the server verbatim. You can also append a callback to perform
operation non-blocking.
.PP
.Vb 6
\&  $collection\->map_reduce(($map, $reduce, {out => {inline => 1}}) => sub {
\&      my ($collection, $err, $docs) = @_;
\&      ...
\&    }
\&  );
\&  Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running;
.Ve
.SS "options"
.IX Subsection "options"
.Vb 1
\&  my $doc = $collection\->options;
.Ve
.PP
Get options for collection. You can also append a callback to perform
operation non-blocking.
.PP
.Vb 5
\&  $collection\->options(sub {
\&    my ($collection, $err, $doc) = @_;
\&    ...
\&  });
\&  Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running;
.Ve
.SS "remove"
.IX Subsection "remove"
.Vb 4
\&  my $result = $collection\->remove;
\&  my $result = $collection\->remove($oid);
\&  my $result = $collection\->remove({foo => \*(Aqbar\*(Aq});
\&  my $result = $collection\->remove({foo => \*(Aqbar\*(Aq}, {single => 1});
.Ve
.PP
Remove documents from collection. You can also append a callback to perform
operation non-blocking. Returns a WriteResult document.
.PP
.Vb 5
\&  $collection\->remove(({foo => \*(Aqbar\*(Aq}, {single => 1}) => sub {
\&    my ($collection, $err, $doc) = @_;
\&    ...
\&  });
\&  Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running;
.Ve
.PP
These options are currently available:
.IP "single" 2
.IX Item "single"
.Vb 1
\&  single => 1
.Ve
.Sp
Remove only one document.
.SS "rename"
.IX Subsection "rename"
.Vb 1
\&  my $new_collection = $collection\->rename(\*(AqNewName\*(Aq);
.Ve
.PP
Rename a collection, keeping all of its original contents and options. Returns
a new Mango::Collection object pointing to the renamed collection. You can
also append a callback to perform operation non-blocking.
.PP
.Vb 5
\&  $collection\->rename(\*(AqNewName\*(Aq => sub {
\&    my ($collection, $err, $oid) = @_;
\&    ...
\&  });
\&  Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running;
.Ve
.SS "save"
.IX Subsection "save"
.Vb 1
\&  my $oid = $collection\->save({foo => \*(Aqbar\*(Aq});
.Ve
.PP
Save document to collection. The document \s-1MUST\s0 have an \f(CW\*(C`_id\*(C'\fR. You can also
append a callback to perform operation non-blocking.
.PP
.Vb 5
\&  $collection\->save({foo => \*(Aqbar\*(Aq} => sub {
\&    my ($collection, $err, $oid) = @_;
\&    ...
\&  });
\&  Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running;
.Ve
.SS "stats"
.IX Subsection "stats"
.Vb 1
\&  my $stats = $collection\->stats;
.Ve
.PP
Get collection statistics. You can also append a callback to perform operation
non-blocking.
.PP
.Vb 5
\&  $collection\->stats(sub {
\&    my ($collection, $err, $stats) = @_;
\&    ...
\&  });
\&  Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running;
.Ve
.SS "update"
.IX Subsection "update"
.Vb 3
\&  my $result = $collection\->update($oid, {foo => \*(Aqbaz\*(Aq});
\&  my $result = $collection\->update({foo => \*(Aqbar\*(Aq}, {foo => \*(Aqbaz\*(Aq});
\&  my $result = $collection\->update({foo => \*(Aqbar\*(Aq}, {foo => \*(Aqbaz\*(Aq}, {multi => 1});
.Ve
.PP
Update document in collection. You can also append a callback to perform
operation non-blocking. Returns a WriteResult document.
.PP
.Vb 5
\&  $collection\->update(({foo => \*(Aqbar\*(Aq}, {foo => \*(Aqbaz\*(Aq}, {multi => 1}) => sub {
\&    my ($collection, $err, $doc) = @_;
\&    ...
\&  });
\&  Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running;
.Ve
.PP
These options are currently available:
.IP "multi" 2
.IX Item "multi"
.Vb 1
\&  multi => 1
.Ve
.Sp
Update more than one document.
.IP "upsert" 2
.IX Item "upsert"
.Vb 1
\&  upsert => 1
.Ve
.Sp
Insert document if none could be updated.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mango, Mojolicious::Guides, <http://mojolicio.us>.