stratadb / BulkWriteResult

Type Alias: BulkWriteResult<T>

type BulkWriteResult<T> = object;

Defined in: src/core-types.ts:159

Result type for bulk insert operations.

Remarks

Provides detailed results for insertMany() operations, including:

• Successfully inserted documents with generated IDs
• Errors for documents that failed validation or insertion
• Original document inputs for failed operations

When ordered: false, insertion continues despite errors. When ordered: true, insertion stops at the first error.

Example

const result = await users.insertMany([
  { name: 'Alice', email: 'alice@example.com' },
  { name: 'Bob', email: 'invalid' },  // Validation error
  { name: 'Charlie', email: 'charlie@example.com' }
], { ordered: false });

console.log(result.insertedCount);  // 2 (Alice and Charlie)
console.log(result.errors.length);  // 1 (Bob failed)
console.log(result.errors[0].index);  // 1
console.log(result.errors[0].error);  // ValidationError

Type Parameters

T

T extends Document

The document type extending Document

Properties

documents

readonly documents: readonly T[];

Defined in: src/core-types.ts:167

Array of successfully inserted documents with IDs

---

errors

readonly errors: readonly object[];

Defined in: src/core-types.ts:170

Array of errors for failed insertions

---

insertedCount

readonly insertedCount: number;

Defined in: src/core-types.ts:161

Number of documents successfully inserted

---

insertedIds

readonly insertedIds: readonly string[];

Defined in: src/core-types.ts:164

Array of generated IDs for successfully inserted documents