.\" Automatically generated by Pod::Man 2.28 (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::WriteResult 3pm"
.TH MongoDB::WriteResult 3pm "2014-10-09" "perl v5.20.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"
MongoDB::WriteResult \- MongoDB write result document
.SH "VERSION"
.IX Header "VERSION"
version v0.705.0.0
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    # returned directly
\&    my $result = $bulk\->execute;
\&
\&    # from a WriteError or WriteConcernError
\&    my $result = $error\->result;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class encapsulates the results from a bulk write operation. It may be
returned directly from \f(CW\*(C`execute\*(C'\fR or it may be in the \f(CW\*(C`result\*(C'\fR attribute of a
\&\f(CW\*(C`MongoDB::DatabaseError\*(C'\fR subclass like \f(CW\*(C`MongoDB::WriteError\*(C'\fR or
\&\f(CW\*(C`MongoDB::WriteConcernError\*(C'\fR.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "nInserted"
.IX Subsection "nInserted"
Number of documents inserted
.SS "nUpserted"
.IX Subsection "nUpserted"
Number of documents upserted
.SS "nMatched"
.IX Subsection "nMatched"
Number of documents matched for an update or replace operation.
.SS "nRemoved"
.IX Subsection "nRemoved"
Number of documents removed
.SS "nModified"
.IX Subsection "nModified"
Number of documents actually modified by an update operation. This
is not necessarily the same as \*(L"nMatched\*(R" if the document was
not actually modified as a result of the update.
.PP
This field is not available from legacy servers before version 2.6.
If results are seen from a legacy server (or from a mongos proxying
for a legacy server) this attribute will be \f(CW\*(C`undef\*(C'\fR.
.SS "upserted"
.IX Subsection "upserted"
An array reference containing information about upserted documetns (if any).
Each document will have the following fields:
.IP "\(bu" 4
index X 0\-based index indicating which operation failed
.IP "\(bu" 4
_id X the object \s-1ID\s0 of the upserted document
.SS "writeErrors"
.IX Subsection "writeErrors"
An array reference containing write errors (if any).  Each error document
will have the following fields:
.IP "\(bu" 4
index X 0\-based index indicating which operation failed
.IP "\(bu" 4
code X numeric error code
.IP "\(bu" 4
errmsg X textual error string
.IP "\(bu" 4
op X a representation of the actual operation sent to the server
.SS "writeConcernErrors"
.IX Subsection "writeConcernErrors"
An array reference containing write concern errors (if any).  Each error
document will have the following fields:
.IP "\(bu" 4
index X 0\-based index indicating which operation failed
.IP "\(bu" 4
code X numeric error code
.SS "op_count"
.IX Subsection "op_count"
The number of operations sent to the database.
.SS "batch_count"
.IX Subsection "batch_count"
The number of database commands issued to the server.  This will be less than the
\&\f(CW\*(C`op_count\*(C'\fR if multiple operations were grouped together.
.SH "METHODS"
.IX Header "METHODS"
.SS "count_writeErrors"
.IX Subsection "count_writeErrors"
Returns the number of write errors
.SS "count_writeConcernErrors"
.IX Subsection "count_writeConcernErrors"
Returns the number of write errors
.SS "last_errmsg"
.IX Subsection "last_errmsg"
Returns the last \f(CW\*(C`errmsg\*(C'\fR field from either the list of \f(CW\*(C`writeErrors\*(C'\fR or
\&\f(CW\*(C`writeConcernErrors\*(C'\fR or the empty string if there are no errors.
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
David Golden <david.golden@mongodb.org>
.IP "\(bu" 4
Mike Friedman <friedo@mongodb.com>
.IP "\(bu" 4
Kristina Chodorow <kristina@mongodb.org>
.IP "\(bu" 4
Florian Ragwitz <rafl@debian.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2014 by MongoDB, Inc..
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The Apache License, Version 2.0, January 2004
.Ve