.\" 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 "MongoDB::CommandResult 3pm" .TH MongoDB::CommandResult 3pm "2020-08-15" "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" MongoDB::CommandResult \- MongoDB generic command result document .SH "VERSION" .IX Header "VERSION" version v2.2.2 .SH "DESCRIPTION" .IX Header "DESCRIPTION" This class encapsulates the results from a database command. Currently, it is only available from the \f(CW\*(C`result\*(C'\fR attribute of \f(CW\*(C`MongoDB::DatabaseError\*(C'\fR. .SH "ATTRIBUTES" .IX Header "ATTRIBUTES" .SS "output" .IX Subsection "output" Hash reference with the output document of a database command .SS "address" .IX Subsection "address" Address (\*(L"host:port\*(R") of server that ran the command .SS "session" .IX Subsection "session" ClientSession which the command was ran with, if any .SH "METHODS" .IX Header "METHODS" .SS "last_code" .IX Subsection "last_code" Error code (if any) or 0 if there was no error. .SS "last_errmsg" .IX Subsection "last_errmsg" Error string (if any) or the empty string if there was no error. .SS "last_wtimeout" .IX Subsection "last_wtimeout" True if a write concern error or timeout occurred or false otherwise. .SS "last_error_labels" .IX Subsection "last_error_labels" Returns an array of error labels from the command, or an empty array if there are none .SS "assert" .IX Subsection "assert" Throws an exception if the command failed. .SS "assert_no_write_concern_error" .IX Subsection "assert_no_write_concern_error" Throws an exception if a write concern error occurred .SH "AUTHORS" .IX Header "AUTHORS" .IP "\(bu" 4 David Golden .IP "\(bu" 4 Rassi .IP "\(bu" 4 Mike Friedman .IP "\(bu" 4 Kristina Chodorow .IP "\(bu" 4 Florian Ragwitz .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is Copyright (c) 2020 by MongoDB, Inc. .PP This is free software, licensed under: .PP .Vb 1 \& The Apache License, Version 2.0, January 2004 .Ve