NAME

MongoDB::UpdateResult - MongoDB update result object

VERSION

version v2.2.2

SYNOPSIS

my $result = $coll->update( @parameters );

if ( $result->acknowledged ) {
    ...
}

DESCRIPTION

This class encapsulates the results from an update or replace operations.

ATTRIBUTES

matched_count

The number of documents that matched the filter.

modified_count

The number of documents that were modified. Note: this is only available from MongoDB version 2.6 or later. It will return undef from earlier servers.

You can call has_modified_count to find out if this attribute is defined or not.

upserted_id

The identifier of the inserted document if an upsert took place. If no upsert took place, it returns undef.

METHODS

acknowledged

Indicates whether this write result was acknowledged. Always true for this class.

assert

Throws an error if write errors or write concern errors occurred. Otherwise, returns the invocant.

assert_no_write_error

Throws a MongoDB::WriteError if write errors occurred. Otherwise, returns the invocant.

assert_no_write_concern_error

Throws a MongoDB::WriteConcernError if write concern errors occurred. Otherwise, returns the invocant.

AUTHORS

  • David Golden <david@mongodb.com>

  • Rassi <rassi@mongodb.com>

  • Mike Friedman <friedo@friedo.com>

  • Kristina Chodorow <k.chodorow@gmail.com>

  • Florian Ragwitz <rafl@debian.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2020 by MongoDB, Inc.

This is free software, licensed under:

The Apache License, Version 2.0, January 2004