MongoDB::BulkWriteResult(3pm) User Contributed Perl Documentation MongoDB::BulkWriteResult(3pm)

MongoDB::BulkWriteResult - MongoDB bulk write result document

version v2.2.2

    # returned directly
    my $result = $bulk->execute;
    # from a WriteError or WriteConcernError
    my $result = $error->result;
    if ( $result->acknowledged ) {
        ...
    }

This class encapsulates the results from a bulk write operation. It may be returned directly from "execute" or it may be in the "result" attribute of a "MongoDB::DatabaseError" subclass like "MongoDB::WriteError" or "MongoDB::WriteConcernError".

Number of documents inserted

Number of documents upserted

Number of documents matched for an update or replace operation.

Number of documents removed

Number of documents actually modified by an update operation. This is not necessarily the same as "matched_count" if the document was not actually modified as a result of the update.

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 "undef".

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

An array reference containing information about upserted documents (if any). Each document will have the following fields:

  • index — 0-based index indicating which operation failed
  • _id — the object ID of the upserted document

A hash reference built lazily from "upserted" mapping indexes to object IDs.

An array reference containing information about inserted documents (if any). Documents are just as in "upserted".

A hash reference built lazily from "inserted" mapping indexes to object IDs.

An array reference containing write errors (if any). Each error document will have the following fields:

  • index — 0-based index indicating which operation failed
  • code — numeric error code
  • errmsg — textual error string
  • op — a representation of the actual operation sent to the server

An array reference containing write concern errors (if any). Each error document will have the following fields:

  • index — 0-based index indicating which operation failed
  • code — numeric error code

The number of operations sent to the database.

The number of database commands issued to the server. This will be less than the "op_count" if multiple operations were grouped together.

Throws an error if write errors or write concern errors occurred.

Throws a MongoDB::WriteError if "count_write_errors" is non-zero; otherwise returns 1.

Throws a MongoDB::WriteConcernError if "count_write_concern_errors" is non-zero; otherwise returns 1.

Returns the number of write errors

Returns the number of write errors

Returns the last "code" field from either the list of "write_errors" or "write_concern_errors" or 0 if there are no errors.

Returns the last "errmsg" field from either the list of "write_errors" or "write_concern_errors" or the empty string if there are no errors.

True if a write concern timed out or false otherwise.

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

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004
2022-06-30 perl v5.34.0