/usr/lib/x86_64-linux-gnu/perl5/5.26/MongoDB/CommandResult.pm is in libmongodb-perl 1.8.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 | #
# Copyright 2014 MongoDB, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
use strict;
use warnings;
package MongoDB::CommandResult;
# ABSTRACT: MongoDB generic command result document
use version;
our $VERSION = 'v1.8.1';
use Moo;
use MongoDB::Error;
use MongoDB::_Constants;
use MongoDB::_Types qw(
HostAddress
);
use Types::Standard qw(
HashRef
);
use namespace::clean;
with $_ for qw(
MongoDB::Role::_PrivateConstructor
MongoDB::Role::_DatabaseErrorThrower
MongoDB::Role::_DeprecationWarner
);
#pod =attr output
#pod
#pod Hash reference with the output document of a database command
#pod
#pod =cut
has output => (
is => 'ro',
required => 1,
isa => HashRef,
);
#pod =attr address
#pod
#pod Address ("host:port") of server that ran the command
#pod
#pod =cut
has address => (
is => 'ro',
required => 1,
isa => HostAddress,
);
#pod =method last_code
#pod
#pod Error code (if any) or 0 if there was no error.
#pod
#pod =cut
sub last_code {
my ($self) = @_;
my $output = $self->output;
if ( $output->{code} ) {
return $output->{code};
}
elsif ( $output->{lastErrorObject} ) {
return $output->{lastErrorObject}{code} || 0;
}
elsif ( $output->{writeConcernError} ) {
return $output->{writeConcernError}{code} || 0;
}
else {
return 0;
}
}
#pod =method last_errmsg
#pod
#pod Error string (if any) or the empty string if there was no error.
#pod
#pod =cut
sub last_errmsg {
my ($self) = @_;
my $output = $self->output;
for my $err_key (qw/$err err errmsg/) {
return $output->{$err_key} if exists $output->{$err_key};
}
if ( exists $output->{writeConcernError} ) {
return $output->{writeConcernError}{errmsg}
}
return "";
}
#pod =method last_wtimeout
#pod
#pod True if a write concern error or timeout occurred or false otherwise.
#pod
#pod =cut
sub last_wtimeout {
my ($self) = @_;
return !!( exists $self->output->{wtimeout}
|| exists $self->output->{writeConcernError} );
}
#pod =method assert
#pod
#pod Throws an exception if the command failed.
#pod
#pod =cut
sub assert {
my ($self, $default_class) = @_;
$self->_throw_database_error( $default_class )
if ! $self->output->{ok};
return 1;
}
#pod =method assert_no_write_concern_error
#pod
#pod Throws an exception if a write concern error occurred
#pod
#pod =cut
sub assert_no_write_concern_error {
my ($self) = @_;
$self->_throw_database_error( "MongoDB::WriteConcernError" )
if $self->last_wtimeout;
return 1;
}
# deprecated
sub result {
my $self = shift;
$self->_warn_deprecated( 'result' => [qw/output/] );
return $self->output;
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
MongoDB::CommandResult - MongoDB generic command result document
=head1 VERSION
version v1.8.1
=head1 DESCRIPTION
This class encapsulates the results from a database command. Currently, it is
only available from the C<result> attribute of C<MongoDB::DatabaseError>.
=head1 ATTRIBUTES
=head2 output
Hash reference with the output document of a database command
=head2 address
Address ("host:port") of server that ran the command
=head1 METHODS
=head2 last_code
Error code (if any) or 0 if there was no error.
=head2 last_errmsg
Error string (if any) or the empty string if there was no error.
=head2 last_wtimeout
True if a write concern error or timeout occurred or false otherwise.
=head2 assert
Throws an exception if the command failed.
=head2 assert_no_write_concern_error
Throws an exception if a write concern error occurred
=for Pod::Coverage result
=head1 DEPRECATIONS
The methods still exist, but are no longer documented. In a future version
they will warn when used, then will eventually be removed.
=over 4
=item *
result
=back
=head1 AUTHORS
=over 4
=item *
David Golden <david@mongodb.com>
=item *
Rassi <rassi@mongodb.com>
=item *
Mike Friedman <friedo@friedo.com>
=item *
Kristina Chodorow <k.chodorow@gmail.com>
=item *
Florian Ragwitz <rafl@debian.org>
=back
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2018 by MongoDB, Inc.
This is free software, licensed under:
The Apache License, Version 2.0, January 2004
=cut
|