.\" Automatically generated by Pod::Man 4.09 (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 .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "Mango::Bulk 3pm" .TH Mango::Bulk 3pm "2018-04-14" "perl v5.26.1" "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::Bulk \- MongoDB bulk operations .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Mango::Bulk; \& \& my $bulk = Mango::Bulk\->new(collection => $collection); \& $bulk\->insert({foo => \*(Aqbar\*(Aq})\->insert({foo => \*(Aqbaz\*(Aq})\->execute; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Mango::Bulk is a container for MongoDB bulk operations, all operations will be automatically grouped so they don't exceed \*(L"max_bson_size\*(R" in Mango. .SH "ATTRIBUTES" .IX Header "ATTRIBUTES" Mango::Bulk implements the following attributes. .SS "collection" .IX Subsection "collection" .Vb 2 \& my $collection = $bulk\->collection; \& $bulk = $bulk\->collection(Mango::Collection\->new); .Ve .PP Mango::Collection object this bulk operation belongs to. .SS "ordered" .IX Subsection "ordered" .Vb 2 \& my $bool = $bulk\->ordered; \& $bulk = $bulk\->ordered($bool); .Ve .PP Bulk operations are ordered, defaults to a true value. .SH "METHODS" .IX Header "METHODS" Mango::Bulk inherits all methods from Mojo::Base and implements the following new ones. .SS "execute" .IX Subsection "execute" .Vb 1 \& my $results = $bulk\->execute; .Ve .PP Execute bulk operations. You can also append a callback to perform operation non-blocking. .PP .Vb 5 \& $bulk\->execute(sub { \& my ($bulk, $err, $results) = @_; \& ... \& }); \& Mojo::IOLoop\->start unless Mojo::IOLoop\->is_running; .Ve .SS "find" .IX Subsection "find" .Vb 1 \& $bulk = $bulk\->find({foo => \*(Aqbar\*(Aq}); .Ve .PP Query for next update or remove operation. .SS "insert" .IX Subsection "insert" .Vb 1 \& $bulk = $bulk\->insert({foo => \*(Aqbar\*(Aq}); .Ve .PP Insert document. .SS "remove" .IX Subsection "remove" .Vb 1 \& $bulk = $bulk\->remove; .Ve .PP Remove multiple documents. .SS "remove_one" .IX Subsection "remove_one" .Vb 1 \& $bulk = $bulk\->remove_one; .Ve .PP Remove one document. .SS "update" .IX Subsection "update" .Vb 1 \& $bulk = $bulk\->update({foo => \*(Aqbar\*(Aq}); .Ve .PP Update multiple documents. .SS "update_one" .IX Subsection "update_one" .Vb 1 \& $bulk = $bulk\->update_one({foo => \*(Aqbaz\*(Aq}); .Ve .PP Update one document. .SS "upsert" .IX Subsection "upsert" .Vb 1 \& $bulk = $bulk\->upsert; .Ve .PP Next update operation will be an \f(CW\*(C`upsert\*(C'\fR. .SH "SEE ALSO" .IX Header "SEE ALSO" Mango, Mojolicious::Guides, .