Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MongoDB::BulkWriteResuUser)Contributed Perl DocumenMongoDB::BulkWriteResult(3)

NAME
       MongoDB::BulkWriteResult	- MongoDB bulk write result document

VERSION
       version v1.8.0

SYNOPSIS
	   # returned directly
	   my $result =	$bulk->execute;

	   # from a WriteError or WriteConcernError
	   my $result =	$error->result;

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

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

ATTRIBUTES
   inserted_count
       Number of documents inserted

   upserted_count
       Number of documents upserted

   matched_count
       Number of documents matched for an update or replace operation.

   deleted_count
       Number of documents removed

   modified_count
       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.

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

       o   index a 0-based index indicating which operation failed

       o   _id a the object ID of the upserted document

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

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

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

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

       o   index a 0-based index indicating which operation failed

       o   code	a numeric error	code

       o   errmsg a textual error string

       o   op a	a representation of the	actual operation sent to the server

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

       o   index a 0-based index indicating which operation failed

       o   code	a numeric error	code

   op_count
       The number of operations	sent to	the database.

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

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

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

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

   count_write_errors
       Returns the number of write errors

   count_write_concern_errors
       Returns the number of write errors

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

   last_errmsg
       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.

   last_wtimeout
       True if a write concern timed out or false otherwise.

AUTHORS
       o   David Golden	<david@mongodb.com>

       o   Rassi <rassi@mongodb.com>

       o   Mike	Friedman <friedo@friedo.com>

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

       o   Florian Ragwitz <rafl@debian.org>

COPYRIGHT AND LICENSE
       This software is	Copyright (c) 2017 by MongoDB, Inc.

       This is free software, licensed under:

	 The Apache License, Version 2.0, January 2004

perl v5.24.1			  2017-04-10	   MongoDB::BulkWriteResult(3)

NAME | VERSION | SYNOPSIS | DESCRIPTION | ATTRIBUTES | METHODS | AUTHORS | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=MongoDB::BulkWriteResult&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help