• NAME
• VERSION
• DESCRIPTION
• ATTRIBUTES
• output
• address
• session
• METHODS
• last_code
• last_errmsg
• last_wtimeout
• last_error_labels
• assert
• assert_no_write_concern_error
• AUTHORS
• COPYRIGHT AND LICENSE

NAME

MongoDB::CommandResult - MongoDB generic command result document

VERSION

version v2.2.2

DESCRIPTION

This class encapsulates the results from a database command. Currently, it is only available from the result attribute of MongoDB::DatabaseError.

ATTRIBUTES

output

Hash reference with the output document of a database command

address

Address (``host:port'') of server that ran the command

session

ClientSession which the command was ran with, if any

METHODS

last_code

Error code (if any) or 0 if there was no error.

last_errmsg

Error string (if any) or the empty string if there was no error.

last_wtimeout

True if a write concern error or timeout occurred or false otherwise.

last_error_labels

Returns an array of error labels from the command, or an empty array if there are none

assert

Throws an exception if the command failed.

assert_no_write_concern_error

Throws an exception if a write concern error occurred

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