Edit Report a Bug

    The MongoDB\Driver\Exception\RuntimeException class

    (mongodb >= 1.0.0)

    Introduction

    Thrown when the driver encounters a runtime error (e.g. internal error from » libmongoc).

    Class synopsis

    class MongoDB\Driver\Exception\RuntimeException extends RuntimeException implements MongoDB\Driver\Exception\Exception {
    /* Properties */
    protected ?array $errorLabels;
    /* Inherited properties */
    protected string $message = "";
    private string $string = "";
    protected int $code;
    protected string $file = "";
    protected int $line;
    private array $trace = [];
    private ?Throwable $previous = null;
    /* Methods */
    final public hasErrorLabel(string $errorLabel): bool
    /* Inherited methods */
    final public Exception::getMessage(): string
    final public Exception::getPrevious(): ?Throwable
    final public Exception::getCode(): int
    final public Exception::getFile(): string
    final public Exception::getLine(): int
    final public Exception::getTrace(): array
    final public Exception::getTraceAsString(): string
    public Exception::__toString(): string
    private Exception::__clone(): void
    }

    Properties

    errorLabels

    Contains an array of error labels to go with an exception. For example, error labels can be used to detect whether a transaction can be retried safely if the TransientTransactionError label is present. The existence of a specific error label should be tested for with the MongoDB\Driver\Exception\RuntimeException::hasErrorLabel(), instead of interpreting this errorLabels property manually.

    Changelog

    Version Description
    PECL mongodb 1.6.0

    The MongoDB\Driver\Exception\RuntimeException::hasErrorLabel() method and MongoDB\Driver\Exception\RuntimeException::errorLabels property have been added.

    Table of Contents

    add a note add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top