—

              
#
#  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.
#
package MongoDB::UpdateResult;
# ABSTRACT: MongoDB update result object
use version;
our $VERSION = 'v0.999.998.6'; # TRIAL
use Moose;
use MongoDB::_Types -types;
use Types::Standard -types;
use namespace::clean -except => 'meta';
with 'MongoDB::Role::_WriteResult';
#pod =attr acknowledged
#pod
#pod Indicates whether this write result was ackowledged. If not, then all other
#pod members of this result will be zero or undefined.
#pod
#pod =cut
#pod =attr matched_count
#pod
#pod The number of documents that matched the filter.
#pod
#pod =cut
has matched_count => (
    is      => 'ro',
    isa     => Num,
    default => 0,
);
#pod =attr modified_count
#pod
#pod The number of documents that were modified.  Note: this is only available
#pod from MongoDB version 2.6 or later.  It will return C<undef> from earlier
#pod servers.
#pod
#pod =cut
has modified_count => (
    is      => 'ro',
    isa     => Maybe[Num],
);
#pod =attr upserted_id
#pod
#pod The identifier of the inserted document if an upsert took place.  If
#pod no upsert took place, it returns C<undef>.
#pod
#pod =cut
has upserted_id => (
    is  => 'ro',
    isa => Any,
);
__PACKAGE__->meta->make_immutable;
1;
#pod =method assert
#pod
#pod Throws an error if write errors or write concern errors occurred.
#pod
#pod =cut
#pod =method assert_no_write_error
#pod
#pod Throws a MongoDB::WriteError if C<count_write_errors> is non-zero; otherwise
#pod returns 1.
#pod
#pod =cut
#pod =method assert_no_write_concern_error
#pod
#pod Throws a MongoDB::WriteConcernError if C<count_write_concern_errors> is non-zero; otherwise
#pod returns 1.
#pod
#pod =cut
__END__
HideShow 94 lines of Pod
=pod
=encoding UTF-8
=head1 NAME
MongoDB::UpdateResult - MongoDB update result object
=head1 VERSION
version v0.999.998.6
=head1 SYNOPSIS
    my $result = $coll->update( @parameters );
    if ( $result->acknowledged ) {
        ...
    }
=head1 DESCRIPTION
This class encapsulates the results from an update or replace operations.
=head1 ATTRIBUTES
=head2 acknowledged
Indicates whether this write result was ackowledged. If not, then all other
members of this result will be zero or undefined.
=head2 matched_count
The number of documents that matched the filter.
=head2 modified_count
The number of documents that were modified.  Note: this is only available
from MongoDB version 2.6 or later.  It will return C<undef> from earlier
servers.
=head2 upserted_id
The identifier of the inserted document if an upsert took place.  If
no upsert took place, it returns C<undef>.
=head1 METHODS
=head2 assert
Throws an error if write errors or write concern errors occurred.
=head2 assert_no_write_error
Throws a MongoDB::WriteError if C<count_write_errors> is non-zero; otherwise
returns 1.
=head2 assert_no_write_concern_error
Throws a MongoDB::WriteConcernError if C<count_write_concern_errors> is non-zero; otherwise
returns 1.
=head1 AUTHORS
=over 4
=item *
David Golden <david@mongodb.com>
=item *
Mike Friedman <friedo@mongodb.com>
=item *
Kristina Chodorow <kristina@mongodb.com>
=item *
Florian Ragwitz <rafl@debian.org>
=back
=head1 COPYRIGHT AND LICENSE
This software is Copyright (c) 2015 by MongoDB, Inc..
This is free software, licensed under:
  The Apache License, Version 2.0, January 2004
=cut