Class CollectionInsertManyError

Overview

Represents an error that occurred during a (potentially paginated) insertMany operation on a Collection.

Contains the inserted IDs of the documents that were successfully inserted, as well as the cumulative errors that occurred during the operation.

If the operation was ordered, the insertedIds will be in the same order as the documents that were attempted to be inserted.

Example

try {
  await collection.insertMany([
    { _id: 'id1', desc: 'An innocent little document' },
    { _id: 'id2', desc: 'Another little document minding its own business' },
    { _id: 'id2', desc: 'A mean document commiting _identity theft' },
    { _id: 'id3', desc: 'A document that will never see the light of day-tabase' },
  ], { ordered: true });
} catch (e) {
  if (e instanceof CollectionInsertManyError) {
    console.log(e.message); // "Document already exists with the given _id"
    console.log(e.insertedIds()); // ['id1', 'id2']
    console.log(e.errors()); // [DataAPIResponseError(...)]
  }
}
Collections vs Tables

There is a sister TableInsertManyError class that is used for insertMany operations on tables. It's identical in structure, but uses the appropriate SomeRow type for the IDs.

See

  • Collection.insertMany
  • TableInsertManyError

Hierarchy (view full)

Constructors

constructor

Properties

#causes #partialResult message name stack? stackTraceLimit

Methods

errors insertedIds withTransientDupesForEvents captureStackTrace prepareStackTrace

Constructors

constructor

Properties

Private Readonly #causes

#causes: NonEmpty<DataAPIResponseError>

Private Readonly #partialResult

#partialResult: CollectionInsertManyResult<SomeDoc>

message

message: string

name

name: string = 'CollectionInsertManyError'

The name of the error. This is always 'InsertManyError'.

Optional stack

stack?: string

Static stackTraceLimit

stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Methods

errors

insertedIds

withTransientDupesForEvents

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

    const myObject = {};
    Error.captureStackTrace(myObject);
    myObject.stack;  // Similar to `new Error().stack`

    The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

    The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

    The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

    function a() {
      b();
    }

    function b() {
      c();
    }

    function c() {
      // Create an error without stack trace to avoid calculating the stack trace twice.
      const { stackTraceLimit } = Error;
      Error.stackTraceLimit = 0;
      const error = new Error();
      Error.stackTraceLimit = stackTraceLimit;

      // Capture the stack trace above function b
      Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
      throw error;
    }

    a();

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Static prepareStackTrace

Settings

Member Visibility

Theme

On This Page

constructor#causes#partialResultmessagenamestackstackTraceLimiterrorsinsertedIdswithTransientDupesForEventscaptureStackTraceprepareStackTrace