Current File : /home/opti/optisoftcom-new/perl/usr/man/man3/MongoDB::BulkWriteView.3pm
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "MongoDB::BulkWriteView 3"
.TH MongoDB::BulkWriteView 3 "2018-11-30" "perl v5.16.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"
MongoDB::BulkWriteView \- Bulk write operations against a query document
.SH "VERSION"
.IX Header "VERSION"
version v2.0.2
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& my $bulk = $collection\->initialize_ordered_bulk_op;
\&
\& # Update one document matching the selector
\& bulk\->find( { a => 1 } )\->update_one( { \*(Aq$inc\*(Aq => { x => 1 } } );
\&
\& # Update all documents matching the selector
\& bulk\->find( { a => 2 } )\->update_many( { \*(Aq$inc\*(Aq => { x => 2 } } );
\&
\& # Update all documents matching the selector, with respect to a collation
\& bulk\->find( { a => { \*(Aq$gte\*(Aq => \*(AqF\*(Aq } )\->collation($collation)
\& \->update_many( { \*(Aq$inc\*(Aq => { x => 2 } } );
\&
\& # Update all documents
\& bulk\->find( {} )\->update_many( { \*(Aq$inc\*(Aq => { x => 2 } } );
\&
\& # Replace entire document (update with whole doc replace)
\& bulk\->find( { a => 3 } )\->replace_one( { x => 3 } );
\&
\& # Update one document matching the selector or upsert
\& bulk\->find( { a => 1 } )\->upsert()\->update_one( { \*(Aq$inc\*(Aq => { x => 1 } } );
\&
\& # Update all documents matching the selector or upsert
\& bulk\->find( { a => 2 } )\->upsert()\->update_many( { \*(Aq$inc\*(Aq => { x => 2 } } );
\&
\& # Replaces a single document matching the selector or upsert
\& bulk\->find( { a => 3 } )\->upsert()\->replace_one( { x => 3 } );
\&
\& # Remove a single document matching the selector
\& bulk\->find( { a => 4 } )\->delete_one();
\&
\& # Remove all documents matching the selector
\& bulk\->find( { a => 5 } )\->delete_many();
\&
\& # Update any arrays with the matching filter
\& bulk\->find( {} )\->arrayFilters([ { \*(Aqi.b\*(Aq => 1 } ])\->update_many( { \*(Aq$set\*(Aq => { \*(Aqy.$[i].b\*(Aq => 2 } } );
\&
\& # Remove all documents matching the selector, with respect to a collation
\& bulk\->find( { a => { \*(Aq$gte\*(Aq => \*(AqF\*(Aq } )\->collation($collation)\->delete_many();
\&
\& # Remove all documents
\& bulk\->find( {} )\->delete_many();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class provides means to specify write operations constrained by a query
document.
.PP
To instantiate a \f(CW\*(C`MongoDB::BulkWriteView\*(C'\fR, use the find
method from MongoDB::BulkWrite.
.PP
Except for \*(L"arrayFilters\*(R", \*(L"collation\*(R" and \*(L"upsert\*(R", all methods have an
empty return on success; an exception will be thrown on error.
.SH "METHODS"
.IX Header "METHODS"
.SS "arrayFilters"
.IX Subsection "arrayFilters"
.Vb 1
\& $bulk\->arrayFilters( $array_filters )\->update_many( $modification );
.Ve
.PP
Returns a new \f(CW\*(C`MongoDB::BulkWriteView\*(C'\fR object, where the specified arrayFilter
will be used to determine which array elements to modify for an update
operation on an array field.
.SS "collation"
.IX Subsection "collation"
.Vb 1
\& $bulk\->collation( $collation )\->delete_one;
.Ve
.PP
Returns a new \f(CW\*(C`MongoDB::BulkWriteView\*(C'\fR object, where the specified
collation will be used to determine which documents match the query
document. A collation can be specified for any deletion, replacement,
or update.
.SS "delete_many"
.IX Subsection "delete_many"
.Vb 1
\& $bulk\->delete_many;
.Ve
.PP
Removes all documents matching the query document.
.SS "delete_one"
.IX Subsection "delete_one"
.Vb 1
\& $bulk\->delete_one;
.Ve
.PP
Removes a single document matching the query document.
.SS "replace_one"
.IX Subsection "replace_one"
.Vb 1
\& $bulk\->replace_one( $doc );
.Ve
.PP
Replaces the document matching the query document. The document
to replace must not have any keys that begin with a dollar sign, \f(CW\*(C`$\*(C'\fR.
.SS "update_many"
.IX Subsection "update_many"
.Vb 1
\& $bulk\->update_many( $modification );
.Ve
.PP
Updates all documents matching the query document. The modification
document must have all its keys begin with a dollar sign, \f(CW\*(C`$\*(C'\fR.
.SS "update_one"
.IX Subsection "update_one"
.Vb 1
\& $bulk\->update_one( $modification );
.Ve
.PP
Updates a single document matching the query document. The modification
document must have all its keys begin with a dollar sign, \f(CW\*(C`$\*(C'\fR.
.SS "upsert"
.IX Subsection "upsert"
.Vb 1
\& $bulk\->upsert\->replace_one( $doc );
.Ve
.PP
Returns a new \f(CW\*(C`MongoDB::BulkWriteView\*(C'\fR object that will treat every
update, update_one or replace_one operation as an upsert operation.
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
David Golden <david@mongodb.com>
.IP "\(bu" 4
Rassi <rassi@mongodb.com>
.IP "\(bu" 4
Mike Friedman <friedo@friedo.com>
.IP "\(bu" 4
Kristina Chodorow <k.chodorow@gmail.com>
.IP "\(bu" 4
Florian Ragwitz <rafl@debian.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2018 by MongoDB, Inc.
.PP
This is free software, licensed under:
.PP
.Vb 1
\& The Apache License, Version 2.0, January 2004
.Ve
Mini Shell