From af6306f935ca37427b3eb3ae41e42c8d4bdc8114 Mon Sep 17 00:00:00 2001 From: baileympearson <23407842+baileympearson@users.noreply.github.com> Date: Wed, 11 Dec 2024 22:50:19 +0000 Subject: [PATCH] [create-pull-request] automated change --- docs/404.html | 32 +++++++-------- docs/Next/assets/navigation.js | 2 +- docs/Next/assets/search.js | 2 +- docs/Next/classes/BSON.ObjectId.html | 36 ++++++++--------- docs/Next/classes/Batch.html | 4 +- docs/Next/classes/BulkOperationBase.html | 10 ++--- docs/Next/classes/BulkWriteResult.html | 32 +++++++-------- docs/Next/classes/ChangeStream.html | 28 ++++++------- docs/Next/classes/ClientSession.html | 35 ++++++++--------- docs/Next/classes/Collection.html | 39 ++++++++++--------- docs/Next/classes/FindOperators.html | 22 +++++------ docs/Next/classes/MongoAPIError.html | 8 ++-- docs/Next/classes/MongoAWSError.html | 8 ++-- docs/Next/classes/MongoAzureError.html | 8 ++-- .../classes/MongoBatchReExecutionError.html | 8 ++-- docs/Next/classes/MongoBulkWriteError.html | 24 ++++++------ docs/Next/classes/MongoChangeStreamError.html | 8 ++-- docs/Next/classes/MongoClient.html | 34 ++++++++-------- .../MongoClientBulkWriteCursorError.html | 8 ++-- .../classes/MongoClientBulkWriteError.html | 16 ++++---- .../MongoClientBulkWriteExecutionError.html | 8 ++-- .../Next/classes/MongoCompatibilityError.html | 8 ++-- .../MongoCryptAzureKMSRequestError.html | 6 +-- .../classes/MongoCryptCreateDataKeyError.html | 6 +-- ...goCryptCreateEncryptedCollectionError.html | 6 +-- docs/Next/classes/MongoCryptError.html | 6 +-- .../MongoCryptInvalidArgumentError.html | 6 +-- ...ngoCryptKMSRequestNetworkTimeoutError.html | 6 +-- .../classes/MongoCursorExhaustedError.html | 8 ++-- docs/Next/classes/MongoCursorInUseError.html | 8 ++-- .../Next/classes/MongoDecompressionError.html | 8 ++-- docs/Next/classes/MongoDriverError.html | 8 ++-- docs/Next/classes/MongoError.html | 8 ++-- .../classes/MongoExpiredSessionError.html | 8 ++-- docs/Next/classes/MongoGCPError.html | 8 ++-- docs/Next/classes/MongoGridFSChunkError.html | 8 ++-- docs/Next/classes/MongoGridFSStreamError.html | 8 ++-- .../classes/MongoInvalidArgumentError.html | 8 ++-- docs/Next/classes/MongoKerberosError.html | 8 ++-- .../classes/MongoMissingCredentialsError.html | 8 ++-- .../classes/MongoMissingDependencyError.html | 10 ++--- docs/Next/classes/MongoNetworkError.html | 8 ++-- .../classes/MongoNetworkTimeoutError.html | 8 ++-- docs/Next/classes/MongoNotConnectedError.html | 8 ++-- docs/Next/classes/MongoOIDCError.html | 8 ++-- .../classes/MongoOperationTimeoutError.html | 8 ++-- docs/Next/classes/MongoParseError.html | 8 ++-- docs/Next/classes/MongoRuntimeError.html | 8 ++-- docs/Next/classes/MongoServerClosedError.html | 8 ++-- docs/Next/classes/MongoServerError.html | 10 ++--- .../classes/MongoServerSelectionError.html | 10 ++--- docs/Next/classes/MongoStalePrimaryError.html | 29 ++++++++++++++ docs/Next/classes/MongoSystemError.html | 10 ++--- .../classes/MongoTailableCursorError.html | 8 ++-- .../classes/MongoTopologyClosedError.html | 8 ++-- docs/Next/classes/MongoTransactionError.html | 8 ++-- .../MongoUnexpectedServerResponseError.html | 8 ++-- docs/Next/classes/MongoWriteConcernError.html | 12 +++--- docs/Next/classes/OrderedBulkOperation.html | 8 ++-- docs/Next/classes/ServerCapabilities.html | 4 +- docs/Next/classes/ServerDescription.html | 10 ++--- docs/Next/classes/ServerSession.html | 6 +-- docs/Next/classes/UnorderedBulkOperation.html | 8 ++-- docs/Next/classes/WriteConcernError.html | 10 ++--- docs/Next/classes/WriteError.html | 14 +++---- docs/Next/hierarchy.html | 2 +- docs/Next/index.html | 9 ++++- .../interfaces/BulkWriteOperationError.html | 4 +- docs/Next/interfaces/BulkWriteOptions.html | 10 ++--- .../ChangeStreamCollModDocument.html | 16 ++++---- .../ChangeStreamCreateDocument.html | 16 ++++---- .../ChangeStreamCreateIndexDocument.html | 18 ++++----- .../ChangeStreamDeleteDocument.html | 22 +++++------ .../ChangeStreamDocumentCollectionUUID.html | 4 +- .../ChangeStreamDocumentCommon.html | 12 +++--- .../interfaces/ChangeStreamDocumentKey.html | 4 +- ...ngeStreamDocumentOperationDescription.html | 4 +- .../ChangeStreamDropDatabaseDocument.html | 16 ++++---- .../interfaces/ChangeStreamDropDocument.html | 18 ++++----- .../ChangeStreamDropIndexDocument.html | 18 ++++----- .../ChangeStreamInsertDocument.html | 22 +++++------ .../ChangeStreamInvalidateDocument.html | 14 +++---- .../interfaces/ChangeStreamNameSpace.html | 4 +- docs/Next/interfaces/ChangeStreamOptions.html | 18 ++++----- ...treamRefineCollectionShardKeyDocument.html | 18 ++++----- .../ChangeStreamRenameDocument.html | 20 +++++----- .../ChangeStreamReplaceDocument.html | 22 +++++------ ...ChangeStreamReshardCollectionDocument.html | 18 ++++----- .../ChangeStreamShardCollectionDocument.html | 18 ++++----- .../interfaces/ChangeStreamSplitEvent.html | 6 +-- .../ChangeStreamUpdateDocument.html | 26 ++++++------- docs/Next/interfaces/CloseOptions.html | 4 +- docs/Next/interfaces/ConnectOptions.html | 4 +- .../interfaces/ConnectionPoolOptions.html | 14 +++---- docs/Next/interfaces/DeleteManyModel.html | 8 ++-- docs/Next/interfaces/DeleteOneModel.html | 8 ++-- docs/Next/interfaces/EndSessionOptions.html | 6 +-- docs/Next/interfaces/ErrorDescription.html | 4 +- docs/Next/interfaces/InsertOneModel.html | 4 +- .../interfaces/MongoNetworkErrorOptions.html | 4 +- docs/Next/interfaces/MongoOptions.html | 34 ++++++++-------- docs/Next/interfaces/MonitorOptions.html | 10 ++--- docs/Next/interfaces/ReplaceOneModel.html | 12 +++--- docs/Next/interfaces/ResumeOptions.html | 4 +- docs/Next/interfaces/SelectServerOptions.html | 6 +-- docs/Next/interfaces/UpdateDescription.html | 10 ++--- docs/Next/interfaces/UpdateManyModel.html | 14 +++---- docs/Next/interfaces/UpdateOneModel.html | 14 +++---- .../interfaces/WriteConcernErrorData.html | 4 +- .../interfaces/WriteConcernErrorResult.html | 4 +- docs/Next/modules.html | 1 + docs/Next/types/AnyBulkWriteOperation.html | 2 +- docs/Next/types/BatchType.html | 2 +- docs/Next/types/ChangeStreamDocument.html | 2 +- docs/Next/types/ChangeStreamEvents.html | 4 +- docs/Next/types/ConnectionPoolEvents.html | 2 +- docs/Next/types/MongoErrorLabel.html | 2 +- docs/Next/types/MonitorEvents.html | 2 +- docs/Next/types/OperationTime.html | 2 +- docs/Next/types/ResumeToken.html | 2 +- docs/Next/types/ServerEvents.html | 2 +- docs/Next/types/ServerMonitoringMode.html | 2 +- docs/Next/types/ServerSessionId.html | 2 +- docs/Next/types/TopologyEvents.html | 2 +- docs/Next/variables/BatchType-1.html | 2 +- docs/Next/variables/MongoErrorLabel-1.html | 2 +- .../variables/ServerMonitoringMode-1.html | 2 +- docs/categories/index.xml | 5 +-- docs/index.html | 34 ++++++++-------- docs/index.xml | 5 +-- docs/tags/index.xml | 5 +-- 131 files changed, 697 insertions(+), 663 deletions(-) create mode 100644 docs/Next/classes/MongoStalePrimaryError.html diff --git a/docs/404.html b/docs/404.html index 1a8ae099da8..ef939e8cf63 100644 --- a/docs/404.html +++ b/docs/404.html @@ -7,16 +7,16 @@ - + 404 Page not found - - - - - - + + + + + + @@ -26,8 +26,8 @@
@@ -81,13 +81,13 @@

404: Page not found

- - - - - - - + + + + + + +

Class Batch<T>

Keeps the state of a unordered batch so we can rewrite the results correctly after command execution

-

Type Parameters

Constructors

constructor +

Type Parameters

Constructors

constructor

Properties

batchType currentIndex operations @@ -8,4 +8,4 @@ originalZeroIndex size sizeBytes -

Constructors

constructor

Properties

batchType

batchType: BatchType

currentIndex

currentIndex: number

operations

operations: T[]

originalIndexes

originalIndexes: number[]

originalZeroIndex

originalZeroIndex: number

size

size: number

sizeBytes

sizeBytes: number

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

batchType

batchType: BatchType

currentIndex

currentIndex: number

operations

operations: T[]

originalIndexes

originalIndexes: number[]

originalZeroIndex

originalZeroIndex: number

size

size: number

sizeBytes

sizeBytes: number

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/Next/classes/BulkOperationBase.html b/docs/Next/classes/BulkOperationBase.html index d1486059b1f..15483d66b58 100644 --- a/docs/Next/classes/BulkOperationBase.html +++ b/docs/Next/classes/BulkOperationBase.html @@ -1,4 +1,4 @@ -BulkOperationBase | mongodb

Class BulkOperationBaseAbstract

Hierarchy (view full)

Properties

isOrdered +BulkOperationBase | mongodb

Class BulkOperationBaseAbstract

Hierarchy (view full)

Properties

isOrdered operationId?

Accessors

batches bsonOptions @@ -9,14 +9,14 @@ find insert raw -

Properties

isOrdered

isOrdered: boolean

OptionaloperationId

operationId?: number

Accessors

batches

bsonOptions

length

writeConcern

Methods

AbstractaddToOperationsList

execute

find

  • find(selector): FindOperators

  • Builds a find operation for an update/updateOne/delete/deleteOne/replaceOne. +

Properties

isOrdered

isOrdered: boolean

OptionaloperationId

operationId?: number

Accessors

batches

bsonOptions

length

writeConcern

Methods

AbstractaddToOperationsList

execute

find

  • find(selector): FindOperators

  • Builds a find operation for an update/updateOne/delete/deleteOne/replaceOne. Returns a builder object used to complete the definition of the operation.

    Parameters

    Returns FindOperators

    Example

    const bulkOp = collection.initializeOrderedBulkOp();

    // Add an updateOne to the bulkOp
    bulkOp.find({ a: 1 }).updateOne({ $set: { b: 2 } });

    // Add an updateMany to the bulkOp
    bulkOp.find({ c: 3 }).update({ $set: { d: 4 } });

    // Add an upsert
    bulkOp.find({ e: 5 }).upsert().updateOne({ $set: { f: 6 } });

    // Add a deletion
    bulkOp.find({ g: 7 }).deleteOne();

    // Add a multi deletion
    bulkOp.find({ h: 8 }).delete();

    // Add a replaceOne
    bulkOp.find({ i: 9 }).replaceOne({writeConcern: { j: 10 }});

    // Update using a pipeline (requires Mongodb 4.2 or higher)
    bulk.find({ k: 11, y: { $exists: true }, z: { $exists: true } }).updateOne([
      { $set: { total: { $sum: [ '$y', '$z' ] } } }
    ]);

    // All of the ops will now be executed
    await bulkOp.execute();
    -

insert

insert

  • insert(document): BulkOperationBase

  • Add a single insert document to the bulk operation

    Parameters

    Returns BulkOperationBase

    Example

    const bulkOp = collection.initializeOrderedBulkOp();

    // Adds three inserts to the bulkOp.
    bulkOp
      .insert({ a: 1 })
      .insert({ b: 2 })
      .insert({ c: 3 });
    await bulkOp.execute();
    -

raw

Settings

Member Visibility

On This Page

Properties
Accessors
Methods
+

raw

Settings

Member Visibility

On This Page

Properties
Accessors
Methods
diff --git a/docs/Next/classes/BulkWriteResult.html b/docs/Next/classes/BulkWriteResult.html index 1ba3638d474..1d25108bd1c 100644 --- a/docs/Next/classes/BulkWriteResult.html +++ b/docs/Next/classes/BulkWriteResult.html @@ -1,5 +1,5 @@ BulkWriteResult | mongodb

Class BulkWriteResult

The result of a bulk write.

-

Properties

deletedCount +

Properties

deletedCount insertedCount insertedIds matchedCount @@ -17,18 +17,18 @@ isOk toString

Properties

ReadonlydeletedCount

deletedCount: number

Number of documents deleted.

-

ReadonlyinsertedCount

insertedCount: number

Number of documents inserted.

-

ReadonlyinsertedIds

insertedIds: {
    [key: number]: any;
}

Inserted document generated Id's, hash key is the index of the originating operation

-

ReadonlymatchedCount

matchedCount: number

Number of documents matched for update.

-

ReadonlymodifiedCount

modifiedCount: number

Number of documents modified.

-

ReadonlyupsertedCount

upsertedCount: number

Number of documents upserted.

-

ReadonlyupsertedIds

upsertedIds: {
    [key: number]: any;
}

Upserted document generated Id's, hash key is the index of the originating operation

-

Accessors

ok

  • get ok(): number

  • Evaluates to true if the bulk operation correctly executes

    -

    Returns number

Methods

getRawResponse

getUpsertedIdAt

getWriteConcernError

getWriteErrorAt

getWriteErrorCount

  • getWriteErrorCount(): number

  • Returns the number of write errors off the bulk operation

    -

    Returns number

getWriteErrors

hasWriteErrors

  • hasWriteErrors(): boolean

  • Returns true if the bulk operation contains a write error

    -

    Returns boolean

isOk

toString

Settings

Member Visibility

On This Page

Properties
Accessors
Methods
+

ReadonlyinsertedCount

insertedCount: number

Number of documents inserted.

+

ReadonlyinsertedIds

insertedIds: {
    [key: number]: any;
}

Inserted document generated Id's, hash key is the index of the originating operation

+

ReadonlymatchedCount

matchedCount: number

Number of documents matched for update.

+

ReadonlymodifiedCount

modifiedCount: number

Number of documents modified.

+

ReadonlyupsertedCount

upsertedCount: number

Number of documents upserted.

+

ReadonlyupsertedIds

upsertedIds: {
    [key: number]: any;
}

Upserted document generated Id's, hash key is the index of the originating operation

+

Accessors

ok

  • get ok(): number

  • Evaluates to true if the bulk operation correctly executes

    +

    Returns number

Methods

getRawResponse

getUpsertedIdAt

getWriteConcernError

getWriteErrorAt

getWriteErrorCount

  • getWriteErrorCount(): number

  • Returns the number of write errors off the bulk operation

    +

    Returns number

getWriteErrors

hasWriteErrors

  • hasWriteErrors(): boolean

  • Returns true if the bulk operation contains a write error

    +

    Returns boolean

isOk

toString

Settings

Member Visibility

On This Page

Properties
Accessors
Methods
diff --git a/docs/Next/classes/ChangeStream.html b/docs/Next/classes/ChangeStream.html index 9622972da5d..8c0145d7246 100644 --- a/docs/Next/classes/ChangeStream.html +++ b/docs/Next/classes/ChangeStream.html @@ -1,5 +1,5 @@ ChangeStream | mongodb

Class ChangeStream<TSchema, TChange>

Creates a new Change Stream instance. Normally created using Collection.watch().

-

Type Parameters

Hierarchy (view full)

Implements

Properties

[asyncDispose] +

Type Parameters

Hierarchy (view full)

Implements

Properties

[asyncDispose] namespace options parent @@ -50,12 +50,12 @@ once setMaxListeners

Properties

[asyncDispose]

[asyncDispose]: (() => Promise<void>)

An alias for ChangeStream.close|ChangeStream.close().

-

namespace

namespace: MongoDBNamespace

options

options: ChangeStreamOptions & {
    writeConcern?: undefined;
}

Remarks

WriteConcern can still be present on the options because +

namespace

namespace: MongoDBNamespace

options

options: ChangeStreamOptions & {
    writeConcern?: undefined;
}

Remarks

WriteConcern can still be present on the options because we inherit options from the client/db/collection. The key must be present on the options in order to delete it. This allows typescript to delete the key but will not allow a writeConcern to be assigned as a property on options.

-

parent

parent: MongoClient | Db | Collection<Document>

pipeline

pipeline: Document[]

OptionalstreamOptions

streamOptions?: CursorStreamOptions

type

type: symbol

StaticcaptureRejections

captureRejections: boolean

Value: boolean

+

parent

parent: MongoClient | Db | Collection<Document>

pipeline

pipeline: Document[]

OptionalstreamOptions

streamOptions?: CursorStreamOptions

type

type: symbol

StaticcaptureRejections

captureRejections: boolean

Value: boolean

Change the default captureRejections option on all new EventEmitter objects.

Since

v13.4.0, v12.16.0

Static ReadonlycaptureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Value: Symbol.for('nodejs.rejection')

@@ -64,7 +64,7 @@

Static ReadonlyCHANGE

CHANGE: "change" = CHANGE

Fired for each new matching change in the specified namespace. Attaching a change event listener to a Change Stream will switch the stream into flowing mode. Data will then be passed as soon as it is available.

-

Event

Static ReadonlyCLOSE

CLOSE: "close" = CLOSE

Event

StaticdefaultMaxListeners

defaultMaxListeners: number

By default, a maximum of 10 listeners can be registered for any single +

Event

Static ReadonlyCLOSE

CLOSE: "close" = CLOSE

Event

StaticdefaultMaxListeners

defaultMaxListeners: number

By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListeners property @@ -89,21 +89,21 @@ listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

Since

v0.11.2

-

Static ReadonlyEND

END: "end" = END

Event

Static ReadonlyERROR

ERROR: "error" = ERROR

Event

Static ReadonlyerrorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

+

Static ReadonlyEND

END: "end" = END

Event

Static ReadonlyERROR

ERROR: "error" = ERROR

Event

Static ReadonlyerrorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

Since

v13.6.0, v12.17.0

-

Static ReadonlyINIT

INIT: "init" = INIT

Event

Static ReadonlyMORE

MORE: "more" = MORE

Event

Static ReadonlyRESPONSE

RESPONSE: "response" = RESPONSE

Event

Static ReadonlyRESUME_TOKEN_CHANGED

RESUME_TOKEN_CHANGED: "resumeTokenChanged" = RESUME_TOKEN_CHANGED

Emitted each time the change stream stores a new resume token.

-

Event

Accessors

closed

resumeToken

  • get resumeToken(): unknown

  • The cached resume token that is used to resume after the most recently returned change.

    -

    Returns unknown

Methods

[asyncIterator]

Optional[captureRejectionSymbol]

  • [captureRejectionSymbol]<K>(error, event, ...args): void

  • Type Parameters

    • K

    Parameters

    • error: Error
    • event: string | symbol
    • Rest...args: AnyRest

    Returns void

addListener

Static ReadonlyINIT

INIT: "init" = INIT

Event

Static ReadonlyMORE

MORE: "more" = MORE

Event

Static ReadonlyRESPONSE

RESPONSE: "response" = RESPONSE

Event

Static ReadonlyRESUME_TOKEN_CHANGED

RESUME_TOKEN_CHANGED: "resumeTokenChanged" = RESUME_TOKEN_CHANGED

Emitted each time the change stream stores a new resume token.

+

Event

Accessors

closed

resumeToken

  • get resumeToken(): unknown

  • The cached resume token that is used to resume after the most recently returned change.

    +

    Returns unknown

Methods

[asyncIterator]

Optional[captureRejectionSymbol]

  • [captureRejectionSymbol]<K>(error, event, ...args): void

  • Type Parameters

    • K

    Parameters

    • error: Error
    • event: string | symbol
    • Rest...args: AnyRest

    Returns void

addListener

close

  • close(): Promise<void>

  • Frees the internal resources used by the change stream.

    -

    Returns Promise<void>

emit

  • emit<EventKey>(event, ...args): boolean

  • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments +

    Returns Promise<void>

emit

  • emit<EventKey>(event, ...args): boolean

  • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

    Returns true if the event had listeners, false otherwise.

    import { EventEmitter } from 'node:events';
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
      console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
      const parameters = args.join(', ');
      console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    //   [Function: firstListener],
    //   [Function: secondListener],
    //   [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener
@@ -120,7 +120,7 @@
 set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    Returns number

    Since

    v1.0.0

hasNext

  • hasNext(): Promise<boolean>

  • Check if there is any document still available in the Change Stream

    -

    Returns Promise<boolean>

listenerCount

  • listenerCount<EventKey>(type): number

  • Returns the number of listeners listening for the event named eventName. +

    Returns Promise<boolean>

listenerCount

next

off

off

tryNext

  • tryNext(): Promise<null | TChange>

  • Try to get the next available document from the Change Stream's cursor or null if an empty batch is returned

    -

    Returns Promise<null | TChange>

StaticaddAbortListener

  • addAbortListener(signal, resource): Disposable
  • Experimental

    Listens once to the abort event on the provided signal.

    +

tryNext

  • tryNext(): Promise<null | TChange>

  • Try to get the next available document from the Change Stream's cursor or null if an empty batch is returned

    +

    Returns Promise<null | TChange>

StaticaddAbortListener

addListener

advanceClusterTime

  • advanceClusterTime(clusterTime): void

  • Advances the clusterTime for a ClientSession to the provided clusterTime of another ClientSession

    Parameters

    • clusterTime: ClusterTime

      the $clusterTime returned by the server from another session in the form of a document containing the BSON.Timestamp clusterTime and signature

      -

    Returns void

advanceOperationTime

  • advanceOperationTime(operationTime): void

  • Advances the operationTime for a ClientSession.

    +

Returns void

advanceOperationTime

  • advanceOperationTime(operationTime): void

  • Advances the operationTime for a ClientSession.

    Parameters

    • operationTime: Timestamp

      the BSON.Timestamp of the operation type it is desired to advance to

      -

    Returns void

commitTransaction

  • commitTransaction(options?): Promise<void>

  • Commits the currently active transaction in this session.

    +

Returns void

commitTransaction

  • commitTransaction(options?): Promise<void>

  • Commits the currently active transaction in this session.

    Parameters

    • Optionaloptions: {
          timeoutMS?: number;
      }

      Optional options, can be used to override defaultTimeoutMS.

      -
      • OptionaltimeoutMS?: number

    Returns Promise<void>

emit

  • emit<EventKey>(event, ...args): boolean

  • Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments +

    • OptionaltimeoutMS?: number

Returns Promise<void>

emit

equals

  • equals(session): boolean

  • Used to determine if this session equals another

    +

Returns Promise<void>

equals

  • equals(session): boolean

  • Used to determine if this session equals another

    Parameters

    Returns boolean

eventNames

  • eventNames(): string[]

  • Returns an array listing the events for which the emitter has registered +

Returns boolean

eventNames

  • eventNames(): string[]

  • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

    import { EventEmitter } from 'node:events';

    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
    @@ -129,8 +128,8 @@ set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    Returns number

    Since

    v1.0.0

incrementTransactionNumber

  • incrementTransactionNumber(): void

  • Increment the transaction number on the internal ServerSession

    -

    Returns void

inTransaction

  • inTransaction(): boolean

  • Returns boolean

    whether this session is currently in a transaction or not

    -

listenerCount

  • listenerCount<EventKey>(type): number

  • Returns the number of listeners listening for the event named eventName. +

    Returns void

inTransaction

  • inTransaction(): boolean

  • Returns boolean

    whether this session is currently in a transaction or not

    +

listenerCount

  • listenerCount<EventKey>(type): number

  • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

    Type Parameters

    • EventKey extends "ended"

    Parameters

    Returns number

    Since

    v3.2.0

    @@ -387,8 +386,8 @@

Returns void

Remarks

IMPORTANT: Running operations in parallel is not supported during a transaction. The use of Promise.all, Promise.allSettled, Promise.race, etc to parallelize operations inside a transaction is undefined behaviour.

-

toBSON

  • toBSON(): never

  • This is here to ensure that ClientSession is never serialized to BSON.

    -

    Returns never

withTransaction

  • withTransaction<T>(fn, options?): Promise<T>

  • Starts a transaction and runs a provided function, ensuring the commitTransaction is always attempted when all operations run in the function have completed.

    +

toBSON

  • toBSON(): never

  • This is here to ensure that ClientSession is never serialized to BSON.

    +

    Returns never

withTransaction

StaticaddAbortListener

  • addAbortListener(signal, resource): Disposable
  • Experimental

    Listens once to the abort event on the provided signal.

    +

StaticaddAbortListener

  • addAbortListener(signal, resource): Disposable
  • Experimental

    Listens once to the abort event on the provided signal.

    Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change @@ -504,4 +503,4 @@

    Deprecated

  • Rest...eventTargets: (EventEmitter<DefaultEventMap> | EventTarget)[]

    Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} objects.

Returns void

Since

v15.4.0

-

Settings

Member Visibility

On This Page

Properties
Accessors
Methods
+

Settings

Member Visibility

On This Page

Properties
Accessors
Methods
diff --git a/docs/Next/classes/Collection.html b/docs/Next/classes/Collection.html index f9b1c6cc87a..aee4faebfcc 100644 --- a/docs/Next/classes/Collection.html +++ b/docs/Next/classes/Collection.html @@ -64,7 +64,7 @@

Returns undefined | WriteConcern

Methods

aggregate

bulkWrite

  • bulkWrite(operations, options?): Promise<BulkWriteResult>

  • Perform a bulkWrite operation without a fluent API

    +

Returns AggregationCursor<T>

bulkWrite

  • bulkWrite(operations, options?): Promise<BulkWriteResult>

  • Perform a bulkWrite operation without a fluent API

    Legal operation types are

    • insertOne
      • @@ -87,9 +87,10 @@

    Parameters

    Returns Promise<number>

    Deprecated

    use Collection#countDocuments| countDocuments or Collection#estimatedDocumentCount| estimatedDocumentCount instead

    -

countDocuments

  • countDocuments(filter?, options?): Promise<number>

  • Gets the number of documents matching the filter. -For a fast count of the total documents in a collection see Collection#estimatedDocumentCount| estimatedDocumentCount. -Note: When migrating from Collection#count| count to Collection#countDocuments| countDocuments +

countDocuments

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/Next/interfaces/ChangeStreamCreateIndexDocument.html b/docs/Next/interfaces/ChangeStreamCreateIndexDocument.html index b10ac15b1ec..441a2c27155 100644 --- a/docs/Next/interfaces/ChangeStreamCreateIndexDocument.html +++ b/docs/Next/interfaces/ChangeStreamCreateIndexDocument.html @@ -1,6 +1,6 @@ ChangeStreamCreateIndexDocument | mongodb

Interface ChangeStreamCreateIndexDocument

Only present when the showExpandedEvents flag is enabled.

See

https://www.mongodb.com/docs/manual/reference/change-events/createIndexes/#mongodb-data-createIndexes

-
interface ChangeStreamCreateIndexDocument {
    _id: unknown;
    clusterTime?: Timestamp;
    collectionUUID: Binary;
    lsid?: ServerSessionId;
    operationDescription?: Document;
    operationType: "createIndexes";
    splitEvent?: ChangeStreamSplitEvent;
    txnNumber?: number;
}

Hierarchy (view full)

Properties

_id +
interface ChangeStreamCreateIndexDocument {
    _id: unknown;
    clusterTime?: Timestamp;
    collectionUUID: Binary;
    lsid?: ServerSessionId;
    operationDescription?: Document;
    operationType: "createIndexes";
    splitEvent?: ChangeStreamSplitEvent;
    txnNumber?: number;
}

Hierarchy (view full)

Properties

_id clusterTime? collectionUUID lsid? @@ -10,27 +10,27 @@ txnNumber?

Properties

_id

_id: unknown

The id functions as an opaque token for use when resuming an interrupted change stream.

-

OptionalclusterTime

clusterTime?: Timestamp

The timestamp from the oplog entry associated with the event. +

OptionalclusterTime

clusterTime?: Timestamp

The timestamp from the oplog entry associated with the event. For events that happened as part of a multi-document transaction, the associated change stream notifications will have the same clusterTime value, namely the time when the transaction was committed. On a sharded cluster, events that occur on different shards can have the same clusterTime but be associated with different transactions or even not be associated with any transaction. To identify events for a single transaction, you can use the combination of lsid and txnNumber in the change stream event document.

-

collectionUUID

collectionUUID: Binary

The UUID (Binary subtype 4) of the collection that the operation was performed on.

+

collectionUUID

collectionUUID: Binary

The UUID (Binary subtype 4) of the collection that the operation was performed on.

Only present when the showExpandedEvents flag is enabled.

NOTE: collectionUUID will be converted to a NodeJS Buffer if the promoteBuffers flag is enabled.

Since Server Version

6.1.0

-

Optionallsid

lsid?: ServerSessionId

The identifier for the session associated with the transaction. +

Optionallsid

lsid?: ServerSessionId

The identifier for the session associated with the transaction. Only present if the operation is part of a multi-document transaction.

-

OptionaloperationDescription

operationDescription?: Document

An description of the operation.

+

OptionaloperationDescription

operationDescription?: Document

An description of the operation.

Only present when the showExpandedEvents flag is enabled.

Since Server Version

6.1.0

-

operationType

operationType: "createIndexes"

Describes the type of operation represented in this change notification

-

OptionalsplitEvent

splitEvent?: ChangeStreamSplitEvent

When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent +

operationType

operationType: "createIndexes"

Describes the type of operation represented in this change notification

+

OptionalsplitEvent

splitEvent?: ChangeStreamSplitEvent

When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent stage, events larger than 16MB will be split into multiple events and contain the following information about which fragment the current event is.

-

OptionaltxnNumber

txnNumber?: number

The transaction number. +

OptionaltxnNumber

txnNumber?: number

The transaction number. Only present if the operation is part of a multi-document transaction.

NOTE: txnNumber can be a Long if promoteLongs is set to false

-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/Next/interfaces/ChangeStreamDeleteDocument.html b/docs/Next/interfaces/ChangeStreamDeleteDocument.html index f6c1d3a7595..ded0355552c 100644 --- a/docs/Next/interfaces/ChangeStreamDeleteDocument.html +++ b/docs/Next/interfaces/ChangeStreamDeleteDocument.html @@ -1,5 +1,5 @@ ChangeStreamDeleteDocument | mongodb

Interface ChangeStreamDeleteDocument<TSchema>

See

https://www.mongodb.com/docs/manual/reference/change-events/#delete-event

-
interface ChangeStreamDeleteDocument<TSchema> {
    _id: unknown;
    clusterTime?: Timestamp;
    collectionUUID: Binary;
    documentKey: {
        _id: InferIdType<TSchema>;
        [shardKey: string]: any;
    };
    fullDocumentBeforeChange?: TSchema;
    lsid?: ServerSessionId;
    ns: ChangeStreamNameSpace;
    operationType: "delete";
    splitEvent?: ChangeStreamSplitEvent;
    txnNumber?: number;
}

Type Parameters

Hierarchy (view full)

Properties

_id +
interface ChangeStreamDeleteDocument<TSchema> {
    _id: unknown;
    clusterTime?: Timestamp;
    collectionUUID: Binary;
    documentKey: {
        _id: InferIdType<TSchema>;
        [shardKey: string]: any;
    };
    fullDocumentBeforeChange?: TSchema;
    lsid?: ServerSessionId;
    ns: ChangeStreamNameSpace;
    operationType: "delete";
    splitEvent?: ChangeStreamSplitEvent;
    txnNumber?: number;
}

Type Parameters

Hierarchy (view full)

Properties

_id clusterTime? collectionUUID documentKey @@ -11,32 +11,32 @@ txnNumber?

Properties

_id

_id: unknown

The id functions as an opaque token for use when resuming an interrupted change stream.

-

OptionalclusterTime

clusterTime?: Timestamp

The timestamp from the oplog entry associated with the event. +

OptionalclusterTime

clusterTime?: Timestamp

The timestamp from the oplog entry associated with the event. For events that happened as part of a multi-document transaction, the associated change stream notifications will have the same clusterTime value, namely the time when the transaction was committed. On a sharded cluster, events that occur on different shards can have the same clusterTime but be associated with different transactions or even not be associated with any transaction. To identify events for a single transaction, you can use the combination of lsid and txnNumber in the change stream event document.

-

collectionUUID

collectionUUID: Binary

The UUID (Binary subtype 4) of the collection that the operation was performed on.

+

collectionUUID

collectionUUID: Binary

The UUID (Binary subtype 4) of the collection that the operation was performed on.

Only present when the showExpandedEvents flag is enabled.

NOTE: collectionUUID will be converted to a NodeJS Buffer if the promoteBuffers flag is enabled.

Since Server Version

6.1.0

-

documentKey

documentKey: {
    _id: InferIdType<TSchema>;
    [shardKey: string]: any;
}

For unsharded collections this contains a single field _id. +

documentKey

documentKey: {
    _id: InferIdType<TSchema>;
    [shardKey: string]: any;
}

For unsharded collections this contains a single field _id. For sharded collections, this will contain all the components of the shard key

-

OptionalfullDocumentBeforeChange

fullDocumentBeforeChange?: TSchema

Contains the pre-image of the modified or deleted document if the +

OptionalfullDocumentBeforeChange

fullDocumentBeforeChange?: TSchema

Contains the pre-image of the modified or deleted document if the pre-image is available for the change event and either 'required' or 'whenAvailable' was specified for the 'fullDocumentBeforeChange' option when creating the change stream. If 'whenAvailable' was specified but the pre-image is unavailable, this will be explicitly set to null.

-

Optionallsid

lsid?: ServerSessionId

The identifier for the session associated with the transaction. +

Optionallsid

lsid?: ServerSessionId

The identifier for the session associated with the transaction. Only present if the operation is part of a multi-document transaction.

-

ns

ns: ChangeStreamNameSpace

Namespace the delete event occurred on

-

operationType

operationType: "delete"

Describes the type of operation represented in this change notification

-

OptionalsplitEvent

splitEvent?: ChangeStreamSplitEvent

When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent +

ns

ns: ChangeStreamNameSpace

Namespace the delete event occurred on

+

operationType

operationType: "delete"

Describes the type of operation represented in this change notification

+

OptionalsplitEvent

splitEvent?: ChangeStreamSplitEvent

When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent stage, events larger than 16MB will be split into multiple events and contain the following information about which fragment the current event is.

-

OptionaltxnNumber

txnNumber?: number

The transaction number. +

OptionaltxnNumber

txnNumber?: number

The transaction number. Only present if the operation is part of a multi-document transaction.

NOTE: txnNumber can be a Long if promoteLongs is set to false

-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/Next/interfaces/ChangeStreamDocumentCollectionUUID.html b/docs/Next/interfaces/ChangeStreamDocumentCollectionUUID.html index 122ad87d67b..8abf52eb298 100644 --- a/docs/Next/interfaces/ChangeStreamDocumentCollectionUUID.html +++ b/docs/Next/interfaces/ChangeStreamDocumentCollectionUUID.html @@ -1,7 +1,7 @@ -ChangeStreamDocumentCollectionUUID | mongodb

Interface ChangeStreamDocumentCollectionUUID

interface ChangeStreamDocumentCollectionUUID {
    collectionUUID: Binary;
}

Hierarchy (view full)

Properties

collectionUUID +ChangeStreamDocumentCollectionUUID | mongodb

Interface ChangeStreamDocumentCollectionUUID

interface ChangeStreamDocumentCollectionUUID {
    collectionUUID: Binary;
}

Hierarchy (view full)

Properties

collectionUUID

Properties

collectionUUID

collectionUUID: Binary

The UUID (Binary subtype 4) of the collection that the operation was performed on.

Only present when the showExpandedEvents flag is enabled.

NOTE: collectionUUID will be converted to a NodeJS Buffer if the promoteBuffers flag is enabled.

Since Server Version

6.1.0

-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/Next/interfaces/ChangeStreamDocumentCommon.html b/docs/Next/interfaces/ChangeStreamDocumentCommon.html index 59c37363ae4..286be194fc7 100644 --- a/docs/Next/interfaces/ChangeStreamDocumentCommon.html +++ b/docs/Next/interfaces/ChangeStreamDocumentCommon.html @@ -1,22 +1,22 @@ -ChangeStreamDocumentCommon | mongodb

Interface ChangeStreamDocumentCommon

interface ChangeStreamDocumentCommon {
    _id: unknown;
    clusterTime?: Timestamp;
    lsid?: ServerSessionId;
    splitEvent?: ChangeStreamSplitEvent;
    txnNumber?: number;
}

Hierarchy (view full)

Properties

_id +ChangeStreamDocumentCommon | mongodb

Interface ChangeStreamDocumentCommon

interface ChangeStreamDocumentCommon {
    _id: unknown;
    clusterTime?: Timestamp;
    lsid?: ServerSessionId;
    splitEvent?: ChangeStreamSplitEvent;
    txnNumber?: number;
}

Hierarchy (view full)

Properties

_id clusterTime? lsid? splitEvent? txnNumber?

Properties

_id

_id: unknown

The id functions as an opaque token for use when resuming an interrupted change stream.

-

OptionalclusterTime

clusterTime?: Timestamp

The timestamp from the oplog entry associated with the event. +

OptionalclusterTime

clusterTime?: Timestamp

The timestamp from the oplog entry associated with the event. For events that happened as part of a multi-document transaction, the associated change stream notifications will have the same clusterTime value, namely the time when the transaction was committed. On a sharded cluster, events that occur on different shards can have the same clusterTime but be associated with different transactions or even not be associated with any transaction. To identify events for a single transaction, you can use the combination of lsid and txnNumber in the change stream event document.

-

Optionallsid

lsid?: ServerSessionId

The identifier for the session associated with the transaction. +

Optionallsid

lsid?: ServerSessionId

The identifier for the session associated with the transaction. Only present if the operation is part of a multi-document transaction.

-

OptionalsplitEvent

splitEvent?: ChangeStreamSplitEvent

When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent +

OptionalsplitEvent

splitEvent?: ChangeStreamSplitEvent

When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent stage, events larger than 16MB will be split into multiple events and contain the following information about which fragment the current event is.

-

OptionaltxnNumber

txnNumber?: number

The transaction number. +

OptionaltxnNumber

txnNumber?: number

The transaction number. Only present if the operation is part of a multi-document transaction.

NOTE: txnNumber can be a Long if promoteLongs is set to false

-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/Next/interfaces/ChangeStreamDocumentKey.html b/docs/Next/interfaces/ChangeStreamDocumentKey.html index 027f1501bb8..99b01ad446c 100644 --- a/docs/Next/interfaces/ChangeStreamDocumentKey.html +++ b/docs/Next/interfaces/ChangeStreamDocumentKey.html @@ -1,4 +1,4 @@ -ChangeStreamDocumentKey | mongodb

Interface ChangeStreamDocumentKey<TSchema>

interface ChangeStreamDocumentKey<TSchema> {
    documentKey: {
        _id: InferIdType<TSchema>;
        [shardKey: string]: any;
    };
}

Type Parameters

Hierarchy (view full)

Properties

documentKey +ChangeStreamDocumentKey | mongodb

Interface ChangeStreamDocumentKey<TSchema>

interface ChangeStreamDocumentKey<TSchema> {
    documentKey: {
        _id: InferIdType<TSchema>;
        [shardKey: string]: any;
    };
}

Type Parameters

Hierarchy (view full)

Properties

documentKey

Properties

documentKey

documentKey: {
    _id: InferIdType<TSchema>;
    [shardKey: string]: any;
}

For unsharded collections this contains a single field _id. For sharded collections, this will contain all the components of the shard key

-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/Next/interfaces/ChangeStreamDocumentOperationDescription.html b/docs/Next/interfaces/ChangeStreamDocumentOperationDescription.html index 0dd53bbdbbe..167780efcd9 100644 --- a/docs/Next/interfaces/ChangeStreamDocumentOperationDescription.html +++ b/docs/Next/interfaces/ChangeStreamDocumentOperationDescription.html @@ -1,5 +1,5 @@ -ChangeStreamDocumentOperationDescription | mongodb

Interface ChangeStreamDocumentOperationDescription

interface ChangeStreamDocumentOperationDescription {
    operationDescription?: Document;
}

Hierarchy (view full)

Properties

operationDescription? +ChangeStreamDocumentOperationDescription | mongodb

Interface ChangeStreamDocumentOperationDescription

interface ChangeStreamDocumentOperationDescription {
    operationDescription?: Document;
}

Hierarchy (view full)

Properties

operationDescription?

Properties

OptionaloperationDescription

operationDescription?: Document

An description of the operation.

Only present when the showExpandedEvents flag is enabled.

Since Server Version

6.1.0

-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/Next/interfaces/ChangeStreamDropDatabaseDocument.html b/docs/Next/interfaces/ChangeStreamDropDatabaseDocument.html index fa69af8b17a..7c1afa57566 100644 --- a/docs/Next/interfaces/ChangeStreamDropDatabaseDocument.html +++ b/docs/Next/interfaces/ChangeStreamDropDatabaseDocument.html @@ -1,5 +1,5 @@ ChangeStreamDropDatabaseDocument | mongodb

Interface ChangeStreamDropDatabaseDocument

See

https://www.mongodb.com/docs/manual/reference/change-events/#dropdatabase-event

-
interface ChangeStreamDropDatabaseDocument {
    _id: unknown;
    clusterTime?: Timestamp;
    lsid?: ServerSessionId;
    ns: {
        db: string;
    };
    operationType: "dropDatabase";
    splitEvent?: ChangeStreamSplitEvent;
    txnNumber?: number;
}

Hierarchy (view full)

Properties

_id +
interface ChangeStreamDropDatabaseDocument {
    _id: unknown;
    clusterTime?: Timestamp;
    lsid?: ServerSessionId;
    ns: {
        db: string;
    };
    operationType: "dropDatabase";
    splitEvent?: ChangeStreamSplitEvent;
    txnNumber?: number;
}

Hierarchy (view full)

Properties

_id clusterTime? lsid? ns @@ -8,20 +8,20 @@ txnNumber?

Properties

_id

_id: unknown

The id functions as an opaque token for use when resuming an interrupted change stream.

-

OptionalclusterTime

clusterTime?: Timestamp

The timestamp from the oplog entry associated with the event. +

OptionalclusterTime

clusterTime?: Timestamp

The timestamp from the oplog entry associated with the event. For events that happened as part of a multi-document transaction, the associated change stream notifications will have the same clusterTime value, namely the time when the transaction was committed. On a sharded cluster, events that occur on different shards can have the same clusterTime but be associated with different transactions or even not be associated with any transaction. To identify events for a single transaction, you can use the combination of lsid and txnNumber in the change stream event document.

-

Optionallsid

lsid?: ServerSessionId

The identifier for the session associated with the transaction. +

Optionallsid

lsid?: ServerSessionId

The identifier for the session associated with the transaction. Only present if the operation is part of a multi-document transaction.

-

ns

ns: {
    db: string;
}

The database dropped

-

operationType

operationType: "dropDatabase"

Describes the type of operation represented in this change notification

-

OptionalsplitEvent

splitEvent?: ChangeStreamSplitEvent

When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent +

ns

ns: {
    db: string;
}

The database dropped

+

operationType

operationType: "dropDatabase"

Describes the type of operation represented in this change notification

+

OptionalsplitEvent

splitEvent?: ChangeStreamSplitEvent

When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent stage, events larger than 16MB will be split into multiple events and contain the following information about which fragment the current event is.

-

OptionaltxnNumber

txnNumber?: number

The transaction number. +

OptionaltxnNumber

txnNumber?: number

The transaction number. Only present if the operation is part of a multi-document transaction.

NOTE: txnNumber can be a Long if promoteLongs is set to false

-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/Next/interfaces/ChangeStreamDropDocument.html b/docs/Next/interfaces/ChangeStreamDropDocument.html index 4fdd7f1056c..0de36d0142c 100644 --- a/docs/Next/interfaces/ChangeStreamDropDocument.html +++ b/docs/Next/interfaces/ChangeStreamDropDocument.html @@ -1,5 +1,5 @@ ChangeStreamDropDocument | mongodb

Interface ChangeStreamDropDocument

See

https://www.mongodb.com/docs/manual/reference/change-events/#drop-event

-
interface ChangeStreamDropDocument {
    _id: unknown;
    clusterTime?: Timestamp;
    collectionUUID: Binary;
    lsid?: ServerSessionId;
    ns: ChangeStreamNameSpace;
    operationType: "drop";
    splitEvent?: ChangeStreamSplitEvent;
    txnNumber?: number;
}

Hierarchy (view full)

Properties

_id +
interface ChangeStreamDropDocument {
    _id: unknown;
    clusterTime?: Timestamp;
    collectionUUID: Binary;
    lsid?: ServerSessionId;
    ns: ChangeStreamNameSpace;
    operationType: "drop";
    splitEvent?: ChangeStreamSplitEvent;
    txnNumber?: number;
}

Hierarchy (view full)

Properties

_id clusterTime? collectionUUID lsid? @@ -9,25 +9,25 @@ txnNumber?

Properties

_id

_id: unknown

The id functions as an opaque token for use when resuming an interrupted change stream.

-

OptionalclusterTime

clusterTime?: Timestamp

The timestamp from the oplog entry associated with the event. +

OptionalclusterTime

clusterTime?: Timestamp

The timestamp from the oplog entry associated with the event. For events that happened as part of a multi-document transaction, the associated change stream notifications will have the same clusterTime value, namely the time when the transaction was committed. On a sharded cluster, events that occur on different shards can have the same clusterTime but be associated with different transactions or even not be associated with any transaction. To identify events for a single transaction, you can use the combination of lsid and txnNumber in the change stream event document.

-

collectionUUID

collectionUUID: Binary

The UUID (Binary subtype 4) of the collection that the operation was performed on.

+

collectionUUID

collectionUUID: Binary

The UUID (Binary subtype 4) of the collection that the operation was performed on.

Only present when the showExpandedEvents flag is enabled.

NOTE: collectionUUID will be converted to a NodeJS Buffer if the promoteBuffers flag is enabled.

Since Server Version

6.1.0

-

Optionallsid

lsid?: ServerSessionId

The identifier for the session associated with the transaction. +

Optionallsid

lsid?: ServerSessionId

The identifier for the session associated with the transaction. Only present if the operation is part of a multi-document transaction.

-

ns

ns: ChangeStreamNameSpace

Namespace the drop event occurred on

-

operationType

operationType: "drop"

Describes the type of operation represented in this change notification

-

OptionalsplitEvent

splitEvent?: ChangeStreamSplitEvent

When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent +

ns

ns: ChangeStreamNameSpace

Namespace the drop event occurred on

+

operationType

operationType: "drop"

Describes the type of operation represented in this change notification

+

OptionalsplitEvent

splitEvent?: ChangeStreamSplitEvent

When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent stage, events larger than 16MB will be split into multiple events and contain the following information about which fragment the current event is.

-

OptionaltxnNumber

txnNumber?: number

The transaction number. +

OptionaltxnNumber

txnNumber?: number

The transaction number. Only present if the operation is part of a multi-document transaction.

NOTE: txnNumber can be a Long if promoteLongs is set to false

-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/Next/interfaces/ChangeStreamDropIndexDocument.html b/docs/Next/interfaces/ChangeStreamDropIndexDocument.html index dde5fb0b59f..f3f439a63ea 100644 --- a/docs/Next/interfaces/ChangeStreamDropIndexDocument.html +++ b/docs/Next/interfaces/ChangeStreamDropIndexDocument.html @@ -1,6 +1,6 @@ ChangeStreamDropIndexDocument | mongodb

Interface ChangeStreamDropIndexDocument

Only present when the showExpandedEvents flag is enabled.

See

https://www.mongodb.com/docs/manual/reference/change-events/dropIndexes/#mongodb-data-dropIndexes

-
interface ChangeStreamDropIndexDocument {
    _id: unknown;
    clusterTime?: Timestamp;
    collectionUUID: Binary;
    lsid?: ServerSessionId;
    operationDescription?: Document;
    operationType: "dropIndexes";
    splitEvent?: ChangeStreamSplitEvent;
    txnNumber?: number;
}

Hierarchy (view full)

Properties

_id +
interface ChangeStreamDropIndexDocument {
    _id: unknown;
    clusterTime?: Timestamp;
    collectionUUID: Binary;
    lsid?: ServerSessionId;
    operationDescription?: Document;
    operationType: "dropIndexes";
    splitEvent?: ChangeStreamSplitEvent;
    txnNumber?: number;
}

Hierarchy (view full)

Properties

_id clusterTime? collectionUUID lsid? @@ -10,27 +10,27 @@ txnNumber?

Properties

_id

_id: unknown

The id functions as an opaque token for use when resuming an interrupted change stream.

-

OptionalclusterTime

clusterTime?: Timestamp

The timestamp from the oplog entry associated with the event. +

OptionalclusterTime

clusterTime?: Timestamp

The timestamp from the oplog entry associated with the event. For events that happened as part of a multi-document transaction, the associated change stream notifications will have the same clusterTime value, namely the time when the transaction was committed. On a sharded cluster, events that occur on different shards can have the same clusterTime but be associated with different transactions or even not be associated with any transaction. To identify events for a single transaction, you can use the combination of lsid and txnNumber in the change stream event document.

-

collectionUUID

collectionUUID: Binary

The UUID (Binary subtype 4) of the collection that the operation was performed on.

+

collectionUUID

collectionUUID: Binary

The UUID (Binary subtype 4) of the collection that the operation was performed on.

Only present when the showExpandedEvents flag is enabled.

NOTE: collectionUUID will be converted to a NodeJS Buffer if the promoteBuffers flag is enabled.

Since Server Version

6.1.0

-

Optionallsid

lsid?: ServerSessionId

The identifier for the session associated with the transaction. +

Optionallsid

lsid?: ServerSessionId

The identifier for the session associated with the transaction. Only present if the operation is part of a multi-document transaction.

-

OptionaloperationDescription

operationDescription?: Document

An description of the operation.

+

OptionaloperationDescription

operationDescription?: Document

An description of the operation.

Only present when the showExpandedEvents flag is enabled.

Since Server Version

6.1.0

-

operationType

operationType: "dropIndexes"

Describes the type of operation represented in this change notification

-

OptionalsplitEvent

splitEvent?: ChangeStreamSplitEvent

When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent +

operationType

operationType: "dropIndexes"

Describes the type of operation represented in this change notification

+

OptionalsplitEvent

splitEvent?: ChangeStreamSplitEvent

When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent stage, events larger than 16MB will be split into multiple events and contain the following information about which fragment the current event is.

-

OptionaltxnNumber

txnNumber?: number

The transaction number. +

OptionaltxnNumber

txnNumber?: number

The transaction number. Only present if the operation is part of a multi-document transaction.

NOTE: txnNumber can be a Long if promoteLongs is set to false

-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/Next/interfaces/ChangeStreamInsertDocument.html b/docs/Next/interfaces/ChangeStreamInsertDocument.html index 43f05312a19..c4ab2e40146 100644 --- a/docs/Next/interfaces/ChangeStreamInsertDocument.html +++ b/docs/Next/interfaces/ChangeStreamInsertDocument.html @@ -1,5 +1,5 @@ ChangeStreamInsertDocument | mongodb

Interface ChangeStreamInsertDocument<TSchema>

See

https://www.mongodb.com/docs/manual/reference/change-events/#insert-event

-
interface ChangeStreamInsertDocument<TSchema> {
    _id: unknown;
    clusterTime?: Timestamp;
    collectionUUID: Binary;
    documentKey: {
        _id: InferIdType<TSchema>;
        [shardKey: string]: any;
    };
    fullDocument: TSchema;
    lsid?: ServerSessionId;
    ns: ChangeStreamNameSpace;
    operationType: "insert";
    splitEvent?: ChangeStreamSplitEvent;
    txnNumber?: number;
}

Type Parameters

Hierarchy (view full)

Properties

_id +
interface ChangeStreamInsertDocument<TSchema> {
    _id: unknown;
    clusterTime?: Timestamp;
    collectionUUID: Binary;
    documentKey: {
        _id: InferIdType<TSchema>;
        [shardKey: string]: any;
    };
    fullDocument: TSchema;
    lsid?: ServerSessionId;
    ns: ChangeStreamNameSpace;
    operationType: "insert";
    splitEvent?: ChangeStreamSplitEvent;
    txnNumber?: number;
}

Type Parameters

Hierarchy (view full)

Properties

_id clusterTime? collectionUUID documentKey @@ -11,28 +11,28 @@ txnNumber?

Properties

_id

_id: unknown

The id functions as an opaque token for use when resuming an interrupted change stream.

-

OptionalclusterTime

clusterTime?: Timestamp

The timestamp from the oplog entry associated with the event. +

OptionalclusterTime

clusterTime?: Timestamp

The timestamp from the oplog entry associated with the event. For events that happened as part of a multi-document transaction, the associated change stream notifications will have the same clusterTime value, namely the time when the transaction was committed. On a sharded cluster, events that occur on different shards can have the same clusterTime but be associated with different transactions or even not be associated with any transaction. To identify events for a single transaction, you can use the combination of lsid and txnNumber in the change stream event document.

-

collectionUUID

collectionUUID: Binary

The UUID (Binary subtype 4) of the collection that the operation was performed on.

+

collectionUUID

collectionUUID: Binary

The UUID (Binary subtype 4) of the collection that the operation was performed on.

Only present when the showExpandedEvents flag is enabled.

NOTE: collectionUUID will be converted to a NodeJS Buffer if the promoteBuffers flag is enabled.

Since Server Version

6.1.0

-

documentKey

documentKey: {
    _id: InferIdType<TSchema>;
    [shardKey: string]: any;
}

For unsharded collections this contains a single field _id. +

documentKey

documentKey: {
    _id: InferIdType<TSchema>;
    [shardKey: string]: any;
}

For unsharded collections this contains a single field _id. For sharded collections, this will contain all the components of the shard key

-

fullDocument

fullDocument: TSchema

This key will contain the document being inserted

-

Optionallsid

lsid?: ServerSessionId

The identifier for the session associated with the transaction. +

fullDocument

fullDocument: TSchema

This key will contain the document being inserted

+

Optionallsid

lsid?: ServerSessionId

The identifier for the session associated with the transaction. Only present if the operation is part of a multi-document transaction.

-

ns

ns: ChangeStreamNameSpace

Namespace the insert event occurred on

-

operationType

operationType: "insert"

Describes the type of operation represented in this change notification

-

OptionalsplitEvent

splitEvent?: ChangeStreamSplitEvent

When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent +

ns

ns: ChangeStreamNameSpace

Namespace the insert event occurred on

+

operationType

operationType: "insert"

Describes the type of operation represented in this change notification

+

OptionalsplitEvent

splitEvent?: ChangeStreamSplitEvent

When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent stage, events larger than 16MB will be split into multiple events and contain the following information about which fragment the current event is.

-

OptionaltxnNumber

txnNumber?: number

The transaction number. +

OptionaltxnNumber

txnNumber?: number

The transaction number. Only present if the operation is part of a multi-document transaction.

NOTE: txnNumber can be a Long if promoteLongs is set to false

-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/Next/interfaces/ChangeStreamInvalidateDocument.html b/docs/Next/interfaces/ChangeStreamInvalidateDocument.html index c957a44fd47..667927ea734 100644 --- a/docs/Next/interfaces/ChangeStreamInvalidateDocument.html +++ b/docs/Next/interfaces/ChangeStreamInvalidateDocument.html @@ -1,5 +1,5 @@ ChangeStreamInvalidateDocument | mongodb

Interface ChangeStreamInvalidateDocument

See

https://www.mongodb.com/docs/manual/reference/change-events/#invalidate-event

-
interface ChangeStreamInvalidateDocument {
    _id: unknown;
    clusterTime?: Timestamp;
    lsid?: ServerSessionId;
    operationType: "invalidate";
    splitEvent?: ChangeStreamSplitEvent;
    txnNumber?: number;
}

Hierarchy (view full)

Properties

_id +
interface ChangeStreamInvalidateDocument {
    _id: unknown;
    clusterTime?: Timestamp;
    lsid?: ServerSessionId;
    operationType: "invalidate";
    splitEvent?: ChangeStreamSplitEvent;
    txnNumber?: number;
}

Hierarchy (view full)

Properties

_id clusterTime? lsid? operationType @@ -7,19 +7,19 @@ txnNumber?

Properties

_id

_id: unknown

The id functions as an opaque token for use when resuming an interrupted change stream.

-

OptionalclusterTime

clusterTime?: Timestamp

The timestamp from the oplog entry associated with the event. +

OptionalclusterTime

clusterTime?: Timestamp

The timestamp from the oplog entry associated with the event. For events that happened as part of a multi-document transaction, the associated change stream notifications will have the same clusterTime value, namely the time when the transaction was committed. On a sharded cluster, events that occur on different shards can have the same clusterTime but be associated with different transactions or even not be associated with any transaction. To identify events for a single transaction, you can use the combination of lsid and txnNumber in the change stream event document.

-

Optionallsid

lsid?: ServerSessionId

The identifier for the session associated with the transaction. +

Optionallsid

lsid?: ServerSessionId

The identifier for the session associated with the transaction. Only present if the operation is part of a multi-document transaction.

-

operationType

operationType: "invalidate"

Describes the type of operation represented in this change notification

-

OptionalsplitEvent

splitEvent?: ChangeStreamSplitEvent

When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent +

operationType

operationType: "invalidate"

Describes the type of operation represented in this change notification

+

OptionalsplitEvent

splitEvent?: ChangeStreamSplitEvent

When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent stage, events larger than 16MB will be split into multiple events and contain the following information about which fragment the current event is.

-

OptionaltxnNumber

txnNumber?: number

The transaction number. +

OptionaltxnNumber

txnNumber?: number

The transaction number. Only present if the operation is part of a multi-document transaction.

NOTE: txnNumber can be a Long if promoteLongs is set to false

-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/Next/interfaces/ChangeStreamNameSpace.html b/docs/Next/interfaces/ChangeStreamNameSpace.html index 4194ae39b43..54b71e545bd 100644 --- a/docs/Next/interfaces/ChangeStreamNameSpace.html +++ b/docs/Next/interfaces/ChangeStreamNameSpace.html @@ -1,3 +1,3 @@ -ChangeStreamNameSpace | mongodb

Interface ChangeStreamNameSpace

interface ChangeStreamNameSpace {
    coll: string;
    db: string;
}

Properties

coll +ChangeStreamNameSpace | mongodb

Interface ChangeStreamNameSpace

interface ChangeStreamNameSpace {
    coll: string;
    db: string;
}

Properties

coll db -

Properties

coll

coll: string

db

db: string

Settings

Member Visibility

On This Page

Properties
+

Properties

coll

coll: string

db

db: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/Next/interfaces/ChangeStreamOptions.html b/docs/Next/interfaces/ChangeStreamOptions.html index 1376534093d..ea6e484cd0b 100644 --- a/docs/Next/interfaces/ChangeStreamOptions.html +++ b/docs/Next/interfaces/ChangeStreamOptions.html @@ -1,5 +1,5 @@ ChangeStreamOptions | mongodb

Interface ChangeStreamOptions

Options that can be passed to a ChangeStream. Note that startAfter, resumeAfter, and startAtOperationTime are all mutually exclusive, and the server will error if more than one is specified.

-
interface ChangeStreamOptions {
    allowDiskUse?: boolean;
    authdb?: string;
    batchSize?: number;
    bsonRegExp?: boolean;
    bypassDocumentValidation?: boolean;
    checkKeys?: boolean;
    collation?: CollationOptions;
    comment?: unknown;
    cursor?: Document;
    dbName?: string;
    enableUtf8Validation?: boolean;
    explain?: ExplainVerbosityLike | ExplainCommandOptions;
    fieldsAsRaw?: Document;
    fullDocument?: string;
    fullDocumentBeforeChange?: string;
    hint?: Hint;
    ignoreUndefined?: boolean;
    let?: Document;
    maxAwaitTimeMS?: number;
    maxTimeMS?: number;
    noResponse?: boolean;
    omitReadPreference?: boolean;
    out?: string;
    promoteBuffers?: boolean;
    promoteLongs?: boolean;
    promoteValues?: boolean;
    raw?: boolean;
    readConcern?: ReadConcernLike;
    readPreference?: ReadPreferenceLike;
    resumeAfter?: unknown;
    retryWrites?: boolean;
    serializeFunctions?: boolean;
    session?: ClientSession;
    showExpandedEvents?: boolean;
    startAfter?: unknown;
    startAtOperationTime?: Timestamp;
    timeoutMS?: number;
    useBigInt64?: boolean;
    willRetryWrite?: boolean;
}

Hierarchy

Properties

allowDiskUse? +
interface ChangeStreamOptions {
    allowDiskUse?: boolean;
    authdb?: string;
    batchSize?: number;
    bsonRegExp?: boolean;
    bypassDocumentValidation?: boolean;
    checkKeys?: boolean;
    collation?: CollationOptions;
    comment?: unknown;
    cursor?: Document;
    dbName?: string;
    enableUtf8Validation?: boolean;
    explain?: ExplainVerbosityLike | ExplainCommandOptions;
    fieldsAsRaw?: Document;
    fullDocument?: string;
    fullDocumentBeforeChange?: string;
    hint?: Hint;
    ignoreUndefined?: boolean;
    let?: Document;
    maxAwaitTimeMS?: number;
    maxTimeMS?: number;
    noResponse?: boolean;
    omitReadPreference?: boolean;
    out?: string;
    promoteBuffers?: boolean;
    promoteLongs?: boolean;
    promoteValues?: boolean;
    raw?: boolean;
    readConcern?: ReadConcernLike;
    readPreference?: ReadPreferenceLike;
    resumeAfter?: unknown;
    retryWrites?: boolean;
    serializeFunctions?: boolean;
    session?: ClientSession;
    showExpandedEvents?: boolean;
    startAfter?: unknown;
    startAtOperationTime?: Timestamp;
    timeoutMS?: number;
    useBigInt64?: boolean;
    willRetryWrite?: boolean;
}

Hierarchy

Properties

allowDiskUse? authdb? batchSize? bsonRegExp? @@ -41,7 +41,7 @@

Properties

OptionalallowDiskUse

allowDiskUse?: boolean

allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).

Optionalauthdb

authdb?: string

OptionalbatchSize

batchSize?: number

The number of documents to return per batch.

See

https://www.mongodb.com/docs/manual/reference/command/aggregate

-

OptionalbsonRegExp

bsonRegExp?: boolean

return BSON regular expressions as BSONRegExp instances.

+

OptionalbsonRegExp

bsonRegExp?: boolean

return BSON regular expressions as BSONRegExp instances.

Default Value

false

OptionalbypassDocumentValidation

bypassDocumentValidation?: boolean

Allow driver to bypass schema validation.

OptionalcheckKeys

checkKeys?: boolean

the serializer will check if keys are valid.

@@ -68,20 +68,20 @@ if the post-image for this event is available.

When set to 'required', the same behavior as 'whenAvailable' except that an error is raised if the post-image is not available.

-

OptionalfullDocumentBeforeChange

fullDocumentBeforeChange?: string

Allowed values: 'whenAvailable', 'required', 'off'.

+

OptionalfullDocumentBeforeChange

fullDocumentBeforeChange?: string

Allowed values: 'whenAvailable', 'required', 'off'.

The default is to not send a value, which is equivalent to 'off'.

When set to 'whenAvailable', configures the change stream to return the pre-image of the modified document for replace, update, and delete change events if it is available.

When set to 'required', the same behavior as 'whenAvailable' except that an error is raised if the pre-image is not available.

-

Optionalhint

hint?: Hint

Add an index selection hint to an aggregation command

+

Optionalhint

hint?: Hint

Add an index selection hint to an aggregation command

OptionalignoreUndefined

ignoreUndefined?: boolean

serialize will not emit undefined fields note that the driver sets this to false

Default Value

true

Optionallet

let?: Document

Map of parameter names and values that can be accessed using $$var (requires MongoDB 5.0).

OptionalmaxAwaitTimeMS

maxAwaitTimeMS?: number

The maximum amount of time for the server to wait on new documents to satisfy a change stream query.

-

OptionalmaxTimeMS

maxTimeMS?: number

Specifies a cumulative time limit in milliseconds for processing operations on the cursor. MongoDB interrupts the operation at the earliest following interrupt point.

+

OptionalmaxTimeMS

maxTimeMS?: number

Specifies a cumulative time limit in milliseconds for processing operations on the cursor. MongoDB interrupts the operation at the earliest following interrupt point.

OptionalnoResponse

noResponse?: boolean

OptionalomitReadPreference

omitReadPreference?: boolean

Optionalout

out?: string

OptionalpromoteBuffers

promoteBuffers?: boolean

when deserializing a Binary will return it as a node.js Buffer instance.

Default Value

false

OptionalpromoteLongs

promoteLongs?: boolean

when deserializing a Long will fit it into a Number if it's smaller than 53 bits.

@@ -103,7 +103,7 @@

Remarks

OptionalreadPreference

readPreference?: ReadPreferenceLike

The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).

OptionalresumeAfter

resumeAfter?: unknown

Allows you to start a changeStream after a specified event.

See

https://www.mongodb.com/docs/manual/changeStreams/#resumeafter-for-change-streams

-

OptionalretryWrites

retryWrites?: boolean

Should retry failed writes

+

OptionalretryWrites

retryWrites?: boolean

Should retry failed writes

OptionalserializeFunctions

serializeFunctions?: boolean

serialize the javascript functions

Default Value

false

Optionalsession

session?: ClientSession

Specify ClientSession for this command

@@ -117,10 +117,10 @@

RemarksreshardCollection
  • refineCollectionShardKey
    • -

    OptionalstartAfter

    startAfter?: unknown

    Similar to resumeAfter, but will allow you to start after an invalidated event.

    +

    OptionalstartAfter

    startAfter?: unknown

    Similar to resumeAfter, but will allow you to start after an invalidated event.

    See

    https://www.mongodb.com/docs/manual/changeStreams/#startafter-for-change-streams

    -

    OptionalstartAtOperationTime

    startAtOperationTime?: Timestamp

    Will start the changeStream after the specified operationTime.

    -

    Optional ExperimentaltimeoutMS

    timeoutMS?: number

    Specifies the time an operation will run until it throws a timeout error

    +

    OptionalstartAtOperationTime

    startAtOperationTime?: Timestamp

    Will start the changeStream after the specified operationTime.

    +

    Optional ExperimentaltimeoutMS

    timeoutMS?: number

    Specifies the time an operation will run until it throws a timeout error

    OptionaluseBigInt64

    useBigInt64?: boolean

    when deserializing a Long return as a BigInt.

    Default Value

    false

    OptionalwillRetryWrite

    willRetryWrite?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamRefineCollectionShardKeyDocument.html b/docs/Next/interfaces/ChangeStreamRefineCollectionShardKeyDocument.html index 1b25e24a2a2..ec706424147 100644 --- a/docs/Next/interfaces/ChangeStreamRefineCollectionShardKeyDocument.html +++ b/docs/Next/interfaces/ChangeStreamRefineCollectionShardKeyDocument.html @@ -1,5 +1,5 @@ ChangeStreamRefineCollectionShardKeyDocument | mongodb

    Interface ChangeStreamRefineCollectionShardKeyDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/refineCollectionShardKey/#mongodb-data-refineCollectionShardKey

    -
    interface ChangeStreamRefineCollectionShardKeyDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        operationDescription?: Document;
        operationType: "refineCollectionShardKey";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id +
    interface ChangeStreamRefineCollectionShardKeyDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        operationDescription?: Document;
        operationType: "refineCollectionShardKey";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID lsid? @@ -9,27 +9,27 @@ txnNumber?

    Properties

    _id

    _id: unknown

    The id functions as an opaque token for use when resuming an interrupted change stream.

    -

    OptionalclusterTime

    clusterTime?: Timestamp

    The timestamp from the oplog entry associated with the event. +

    OptionalclusterTime

    clusterTime?: Timestamp

    The timestamp from the oplog entry associated with the event. For events that happened as part of a multi-document transaction, the associated change stream notifications will have the same clusterTime value, namely the time when the transaction was committed. On a sharded cluster, events that occur on different shards can have the same clusterTime but be associated with different transactions or even not be associated with any transaction. To identify events for a single transaction, you can use the combination of lsid and txnNumber in the change stream event document.

    -

    collectionUUID

    collectionUUID: Binary

    The UUID (Binary subtype 4) of the collection that the operation was performed on.

    +

    collectionUUID

    collectionUUID: Binary

    The UUID (Binary subtype 4) of the collection that the operation was performed on.

    Only present when the showExpandedEvents flag is enabled.

    NOTE: collectionUUID will be converted to a NodeJS Buffer if the promoteBuffers flag is enabled.

    Since Server Version

    6.1.0

    -

    Optionallsid

    lsid?: ServerSessionId

    The identifier for the session associated with the transaction. +

    Optionallsid

    lsid?: ServerSessionId

    The identifier for the session associated with the transaction. Only present if the operation is part of a multi-document transaction.

    -

    OptionaloperationDescription

    operationDescription?: Document

    An description of the operation.

    +

    OptionaloperationDescription

    operationDescription?: Document

    An description of the operation.

    Only present when the showExpandedEvents flag is enabled.

    Since Server Version

    6.1.0

    -

    operationType

    operationType: "refineCollectionShardKey"

    Describes the type of operation represented in this change notification

    -

    OptionalsplitEvent

    splitEvent?: ChangeStreamSplitEvent

    When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent +

    operationType

    operationType: "refineCollectionShardKey"

    Describes the type of operation represented in this change notification

    +

    OptionalsplitEvent

    splitEvent?: ChangeStreamSplitEvent

    When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent stage, events larger than 16MB will be split into multiple events and contain the following information about which fragment the current event is.

    -

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. +

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamRenameDocument.html b/docs/Next/interfaces/ChangeStreamRenameDocument.html index f4dac5c21c7..63f8b44d2c9 100644 --- a/docs/Next/interfaces/ChangeStreamRenameDocument.html +++ b/docs/Next/interfaces/ChangeStreamRenameDocument.html @@ -1,5 +1,5 @@ ChangeStreamRenameDocument | mongodb

    Interface ChangeStreamRenameDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#rename-event

    -
    interface ChangeStreamRenameDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        ns: ChangeStreamNameSpace;
        operationType: "rename";
        splitEvent?: ChangeStreamSplitEvent;
        to: {
            coll: string;
            db: string;
        };
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id +
    interface ChangeStreamRenameDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        ns: ChangeStreamNameSpace;
        operationType: "rename";
        splitEvent?: ChangeStreamSplitEvent;
        to: {
            coll: string;
            db: string;
        };
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID lsid? @@ -10,26 +10,26 @@ txnNumber?

    Properties

    _id

    _id: unknown

    The id functions as an opaque token for use when resuming an interrupted change stream.

    -

    OptionalclusterTime

    clusterTime?: Timestamp

    The timestamp from the oplog entry associated with the event. +

    OptionalclusterTime

    clusterTime?: Timestamp

    The timestamp from the oplog entry associated with the event. For events that happened as part of a multi-document transaction, the associated change stream notifications will have the same clusterTime value, namely the time when the transaction was committed. On a sharded cluster, events that occur on different shards can have the same clusterTime but be associated with different transactions or even not be associated with any transaction. To identify events for a single transaction, you can use the combination of lsid and txnNumber in the change stream event document.

    -

    collectionUUID

    collectionUUID: Binary

    The UUID (Binary subtype 4) of the collection that the operation was performed on.

    +

    collectionUUID

    collectionUUID: Binary

    The UUID (Binary subtype 4) of the collection that the operation was performed on.

    Only present when the showExpandedEvents flag is enabled.

    NOTE: collectionUUID will be converted to a NodeJS Buffer if the promoteBuffers flag is enabled.

    Since Server Version

    6.1.0

    -

    Optionallsid

    lsid?: ServerSessionId

    The identifier for the session associated with the transaction. +

    Optionallsid

    lsid?: ServerSessionId

    The identifier for the session associated with the transaction. Only present if the operation is part of a multi-document transaction.

    -

    ns

    ns: ChangeStreamNameSpace

    The "from" namespace that the rename occurred on

    -

    operationType

    operationType: "rename"

    Describes the type of operation represented in this change notification

    -

    OptionalsplitEvent

    splitEvent?: ChangeStreamSplitEvent

    When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent +

    ns

    ns: ChangeStreamNameSpace

    The "from" namespace that the rename occurred on

    +

    operationType

    operationType: "rename"

    Describes the type of operation represented in this change notification

    +

    OptionalsplitEvent

    splitEvent?: ChangeStreamSplitEvent

    When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent stage, events larger than 16MB will be split into multiple events and contain the following information about which fragment the current event is.

    -

    to

    to: {
        coll: string;
        db: string;
    }

    The new name for the ns.coll collection

    -

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. +

    to

    to: {
        coll: string;
        db: string;
    }

    The new name for the ns.coll collection

    +

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamReplaceDocument.html b/docs/Next/interfaces/ChangeStreamReplaceDocument.html index de7126d51ff..c6dfa43abed 100644 --- a/docs/Next/interfaces/ChangeStreamReplaceDocument.html +++ b/docs/Next/interfaces/ChangeStreamReplaceDocument.html @@ -1,5 +1,5 @@ ChangeStreamReplaceDocument | mongodb

    Interface ChangeStreamReplaceDocument<TSchema>

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#replace-event

    -
    interface ChangeStreamReplaceDocument<TSchema> {
        _id: unknown;
        clusterTime?: Timestamp;
        documentKey: {
            _id: InferIdType<TSchema>;
            [shardKey: string]: any;
        };
        fullDocument: TSchema;
        fullDocumentBeforeChange?: TSchema;
        lsid?: ServerSessionId;
        ns: ChangeStreamNameSpace;
        operationType: "replace";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    _id +
    interface ChangeStreamReplaceDocument<TSchema> {
        _id: unknown;
        clusterTime?: Timestamp;
        documentKey: {
            _id: InferIdType<TSchema>;
            [shardKey: string]: any;
        };
        fullDocument: TSchema;
        fullDocumentBeforeChange?: TSchema;
        lsid?: ServerSessionId;
        ns: ChangeStreamNameSpace;
        operationType: "replace";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    _id clusterTime? documentKey fullDocument @@ -11,28 +11,28 @@ txnNumber?

    Properties

    _id

    _id: unknown

    The id functions as an opaque token for use when resuming an interrupted change stream.

    -

    OptionalclusterTime

    clusterTime?: Timestamp

    The timestamp from the oplog entry associated with the event. +

    OptionalclusterTime

    clusterTime?: Timestamp

    The timestamp from the oplog entry associated with the event. For events that happened as part of a multi-document transaction, the associated change stream notifications will have the same clusterTime value, namely the time when the transaction was committed. On a sharded cluster, events that occur on different shards can have the same clusterTime but be associated with different transactions or even not be associated with any transaction. To identify events for a single transaction, you can use the combination of lsid and txnNumber in the change stream event document.

    -

    documentKey

    documentKey: {
        _id: InferIdType<TSchema>;
        [shardKey: string]: any;
    }

    For unsharded collections this contains a single field _id. +

    documentKey

    documentKey: {
        _id: InferIdType<TSchema>;
        [shardKey: string]: any;
    }

    For unsharded collections this contains a single field _id. For sharded collections, this will contain all the components of the shard key

    -

    fullDocument

    fullDocument: TSchema

    The fullDocument of a replace event represents the document after the insert of the replacement document

    -

    OptionalfullDocumentBeforeChange

    fullDocumentBeforeChange?: TSchema

    Contains the pre-image of the modified or deleted document if the +

    fullDocument

    fullDocument: TSchema

    The fullDocument of a replace event represents the document after the insert of the replacement document

    +

    OptionalfullDocumentBeforeChange

    fullDocumentBeforeChange?: TSchema

    Contains the pre-image of the modified or deleted document if the pre-image is available for the change event and either 'required' or 'whenAvailable' was specified for the 'fullDocumentBeforeChange' option when creating the change stream. If 'whenAvailable' was specified but the pre-image is unavailable, this will be explicitly set to null.

    -

    Optionallsid

    lsid?: ServerSessionId

    The identifier for the session associated with the transaction. +

    Optionallsid

    lsid?: ServerSessionId

    The identifier for the session associated with the transaction. Only present if the operation is part of a multi-document transaction.

    -

    ns

    ns: ChangeStreamNameSpace

    Namespace the replace event occurred on

    -

    operationType

    operationType: "replace"

    Describes the type of operation represented in this change notification

    -

    OptionalsplitEvent

    splitEvent?: ChangeStreamSplitEvent

    When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent +

    ns

    ns: ChangeStreamNameSpace

    Namespace the replace event occurred on

    +

    operationType

    operationType: "replace"

    Describes the type of operation represented in this change notification

    +

    OptionalsplitEvent

    splitEvent?: ChangeStreamSplitEvent

    When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent stage, events larger than 16MB will be split into multiple events and contain the following information about which fragment the current event is.

    -

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. +

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamReshardCollectionDocument.html b/docs/Next/interfaces/ChangeStreamReshardCollectionDocument.html index 2fb66d3550b..fba005fe458 100644 --- a/docs/Next/interfaces/ChangeStreamReshardCollectionDocument.html +++ b/docs/Next/interfaces/ChangeStreamReshardCollectionDocument.html @@ -1,5 +1,5 @@ ChangeStreamReshardCollectionDocument | mongodb

    Interface ChangeStreamReshardCollectionDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/reshardCollection/#mongodb-data-reshardCollection

    -
    interface ChangeStreamReshardCollectionDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        operationDescription?: Document;
        operationType: "reshardCollection";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id +
    interface ChangeStreamReshardCollectionDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        operationDescription?: Document;
        operationType: "reshardCollection";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID lsid? @@ -9,27 +9,27 @@ txnNumber?

    Properties

    _id

    _id: unknown

    The id functions as an opaque token for use when resuming an interrupted change stream.

    -

    OptionalclusterTime

    clusterTime?: Timestamp

    The timestamp from the oplog entry associated with the event. +

    OptionalclusterTime

    clusterTime?: Timestamp

    The timestamp from the oplog entry associated with the event. For events that happened as part of a multi-document transaction, the associated change stream notifications will have the same clusterTime value, namely the time when the transaction was committed. On a sharded cluster, events that occur on different shards can have the same clusterTime but be associated with different transactions or even not be associated with any transaction. To identify events for a single transaction, you can use the combination of lsid and txnNumber in the change stream event document.

    -

    collectionUUID

    collectionUUID: Binary

    The UUID (Binary subtype 4) of the collection that the operation was performed on.

    +

    collectionUUID

    collectionUUID: Binary

    The UUID (Binary subtype 4) of the collection that the operation was performed on.

    Only present when the showExpandedEvents flag is enabled.

    NOTE: collectionUUID will be converted to a NodeJS Buffer if the promoteBuffers flag is enabled.

    Since Server Version

    6.1.0

    -

    Optionallsid

    lsid?: ServerSessionId

    The identifier for the session associated with the transaction. +

    Optionallsid

    lsid?: ServerSessionId

    The identifier for the session associated with the transaction. Only present if the operation is part of a multi-document transaction.

    -

    OptionaloperationDescription

    operationDescription?: Document

    An description of the operation.

    +

    OptionaloperationDescription

    operationDescription?: Document

    An description of the operation.

    Only present when the showExpandedEvents flag is enabled.

    Since Server Version

    6.1.0

    -

    operationType

    operationType: "reshardCollection"

    Describes the type of operation represented in this change notification

    -

    OptionalsplitEvent

    splitEvent?: ChangeStreamSplitEvent

    When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent +

    operationType

    operationType: "reshardCollection"

    Describes the type of operation represented in this change notification

    +

    OptionalsplitEvent

    splitEvent?: ChangeStreamSplitEvent

    When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent stage, events larger than 16MB will be split into multiple events and contain the following information about which fragment the current event is.

    -

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. +

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamShardCollectionDocument.html b/docs/Next/interfaces/ChangeStreamShardCollectionDocument.html index a635b56c078..8ae6d74631a 100644 --- a/docs/Next/interfaces/ChangeStreamShardCollectionDocument.html +++ b/docs/Next/interfaces/ChangeStreamShardCollectionDocument.html @@ -1,5 +1,5 @@ ChangeStreamShardCollectionDocument | mongodb

    Interface ChangeStreamShardCollectionDocument

    See

    https://www.mongodb.com/docs/manual/reference/change-events/shardCollection/#mongodb-data-shardCollection

    -
    interface ChangeStreamShardCollectionDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        operationDescription?: Document;
        operationType: "shardCollection";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id +
    interface ChangeStreamShardCollectionDocument {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        lsid?: ServerSessionId;
        operationDescription?: Document;
        operationType: "shardCollection";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
    }

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID lsid? @@ -9,27 +9,27 @@ txnNumber?

    Properties

    _id

    _id: unknown

    The id functions as an opaque token for use when resuming an interrupted change stream.

    -

    OptionalclusterTime

    clusterTime?: Timestamp

    The timestamp from the oplog entry associated with the event. +

    OptionalclusterTime

    clusterTime?: Timestamp

    The timestamp from the oplog entry associated with the event. For events that happened as part of a multi-document transaction, the associated change stream notifications will have the same clusterTime value, namely the time when the transaction was committed. On a sharded cluster, events that occur on different shards can have the same clusterTime but be associated with different transactions or even not be associated with any transaction. To identify events for a single transaction, you can use the combination of lsid and txnNumber in the change stream event document.

    -

    collectionUUID

    collectionUUID: Binary

    The UUID (Binary subtype 4) of the collection that the operation was performed on.

    +

    collectionUUID

    collectionUUID: Binary

    The UUID (Binary subtype 4) of the collection that the operation was performed on.

    Only present when the showExpandedEvents flag is enabled.

    NOTE: collectionUUID will be converted to a NodeJS Buffer if the promoteBuffers flag is enabled.

    Since Server Version

    6.1.0

    -

    Optionallsid

    lsid?: ServerSessionId

    The identifier for the session associated with the transaction. +

    Optionallsid

    lsid?: ServerSessionId

    The identifier for the session associated with the transaction. Only present if the operation is part of a multi-document transaction.

    -

    OptionaloperationDescription

    operationDescription?: Document

    An description of the operation.

    +

    OptionaloperationDescription

    operationDescription?: Document

    An description of the operation.

    Only present when the showExpandedEvents flag is enabled.

    Since Server Version

    6.1.0

    -

    operationType

    operationType: "shardCollection"

    Describes the type of operation represented in this change notification

    -

    OptionalsplitEvent

    splitEvent?: ChangeStreamSplitEvent

    When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent +

    operationType

    operationType: "shardCollection"

    Describes the type of operation represented in this change notification

    +

    OptionalsplitEvent

    splitEvent?: ChangeStreamSplitEvent

    When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent stage, events larger than 16MB will be split into multiple events and contain the following information about which fragment the current event is.

    -

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. +

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamSplitEvent.html b/docs/Next/interfaces/ChangeStreamSplitEvent.html index 0a05c6725a8..7343a61ef77 100644 --- a/docs/Next/interfaces/ChangeStreamSplitEvent.html +++ b/docs/Next/interfaces/ChangeStreamSplitEvent.html @@ -1,5 +1,5 @@ -ChangeStreamSplitEvent | mongodb

    Interface ChangeStreamSplitEvent

    interface ChangeStreamSplitEvent {
        fragment: number;
        of: number;
    }

    Properties

    fragment +ChangeStreamSplitEvent | mongodb

    Interface ChangeStreamSplitEvent

    interface ChangeStreamSplitEvent {
        fragment: number;
        of: number;
    }

    Properties

    fragment of

    Properties

    fragment

    fragment: number

    Which fragment of the change this is.

    -

    of

    of: number

    The total number of fragments.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    of

    of: number

    The total number of fragments.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ChangeStreamUpdateDocument.html b/docs/Next/interfaces/ChangeStreamUpdateDocument.html index 2f2e9b71170..1205a5a8abe 100644 --- a/docs/Next/interfaces/ChangeStreamUpdateDocument.html +++ b/docs/Next/interfaces/ChangeStreamUpdateDocument.html @@ -1,5 +1,5 @@ ChangeStreamUpdateDocument | mongodb

    Interface ChangeStreamUpdateDocument<TSchema>

    See

    https://www.mongodb.com/docs/manual/reference/change-events/#update-event

    -
    interface ChangeStreamUpdateDocument<TSchema> {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        documentKey: {
            _id: InferIdType<TSchema>;
            [shardKey: string]: any;
        };
        fullDocument?: TSchema;
        fullDocumentBeforeChange?: TSchema;
        lsid?: ServerSessionId;
        ns: ChangeStreamNameSpace;
        operationType: "update";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
        updateDescription: UpdateDescription<TSchema>;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    _id +
    interface ChangeStreamUpdateDocument<TSchema> {
        _id: unknown;
        clusterTime?: Timestamp;
        collectionUUID: Binary;
        documentKey: {
            _id: InferIdType<TSchema>;
            [shardKey: string]: any;
        };
        fullDocument?: TSchema;
        fullDocumentBeforeChange?: TSchema;
        lsid?: ServerSessionId;
        ns: ChangeStreamNameSpace;
        operationType: "update";
        splitEvent?: ChangeStreamSplitEvent;
        txnNumber?: number;
        updateDescription: UpdateDescription<TSchema>;
    }

    Type Parameters

    Hierarchy (view full)

    Properties

    _id clusterTime? collectionUUID documentKey @@ -13,37 +13,37 @@ updateDescription

    Properties

    _id

    _id: unknown

    The id functions as an opaque token for use when resuming an interrupted change stream.

    -

    OptionalclusterTime

    clusterTime?: Timestamp

    The timestamp from the oplog entry associated with the event. +

    OptionalclusterTime

    clusterTime?: Timestamp

    The timestamp from the oplog entry associated with the event. For events that happened as part of a multi-document transaction, the associated change stream notifications will have the same clusterTime value, namely the time when the transaction was committed. On a sharded cluster, events that occur on different shards can have the same clusterTime but be associated with different transactions or even not be associated with any transaction. To identify events for a single transaction, you can use the combination of lsid and txnNumber in the change stream event document.

    -

    collectionUUID

    collectionUUID: Binary

    The UUID (Binary subtype 4) of the collection that the operation was performed on.

    +

    collectionUUID

    collectionUUID: Binary

    The UUID (Binary subtype 4) of the collection that the operation was performed on.

    Only present when the showExpandedEvents flag is enabled.

    NOTE: collectionUUID will be converted to a NodeJS Buffer if the promoteBuffers flag is enabled.

    Since Server Version

    6.1.0

    -

    documentKey

    documentKey: {
        _id: InferIdType<TSchema>;
        [shardKey: string]: any;
    }

    For unsharded collections this contains a single field _id. +

    documentKey

    documentKey: {
        _id: InferIdType<TSchema>;
        [shardKey: string]: any;
    }

    For unsharded collections this contains a single field _id. For sharded collections, this will contain all the components of the shard key

    -

    OptionalfullDocument

    fullDocument?: TSchema

    This is only set if fullDocument is set to 'updateLookup' +

    OptionalfullDocument

    fullDocument?: TSchema

    This is only set if fullDocument is set to 'updateLookup' Contains the point-in-time post-image of the modified document if the post-image is available and either 'required' or 'whenAvailable' was specified for the 'fullDocument' option when creating the change stream.

    -

    OptionalfullDocumentBeforeChange

    fullDocumentBeforeChange?: TSchema

    Contains the pre-image of the modified or deleted document if the +

    OptionalfullDocumentBeforeChange

    fullDocumentBeforeChange?: TSchema

    Contains the pre-image of the modified or deleted document if the pre-image is available for the change event and either 'required' or 'whenAvailable' was specified for the 'fullDocumentBeforeChange' option when creating the change stream. If 'whenAvailable' was specified but the pre-image is unavailable, this will be explicitly set to null.

    -

    Optionallsid

    lsid?: ServerSessionId

    The identifier for the session associated with the transaction. +

    Optionallsid

    lsid?: ServerSessionId

    The identifier for the session associated with the transaction. Only present if the operation is part of a multi-document transaction.

    -

    ns

    ns: ChangeStreamNameSpace

    Namespace the update event occurred on

    -

    operationType

    operationType: "update"

    Describes the type of operation represented in this change notification

    -

    OptionalsplitEvent

    splitEvent?: ChangeStreamSplitEvent

    When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent +

    ns

    ns: ChangeStreamNameSpace

    Namespace the update event occurred on

    +

    operationType

    operationType: "update"

    Describes the type of operation represented in this change notification

    +

    OptionalsplitEvent

    splitEvent?: ChangeStreamSplitEvent

    When the change stream's backing aggregation pipeline contains the $changeStreamSplitLargeEvent stage, events larger than 16MB will be split into multiple events and contain the following information about which fragment the current event is.

    -

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. +

    OptionaltxnNumber

    txnNumber?: number

    The transaction number. Only present if the operation is part of a multi-document transaction.

    NOTE: txnNumber can be a Long if promoteLongs is set to false

    -

    updateDescription

    updateDescription: UpdateDescription<TSchema>

    Contains a description of updated and removed fields in this operation

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    updateDescription

    updateDescription: UpdateDescription<TSchema>

    Contains a description of updated and removed fields in this operation

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/CloseOptions.html b/docs/Next/interfaces/CloseOptions.html index ef2d22c9f3e..18b456b8406 100644 --- a/docs/Next/interfaces/CloseOptions.html +++ b/docs/Next/interfaces/CloseOptions.html @@ -1,4 +1,4 @@ CloseOptions | mongodb

    Interface CloseOptions

    Deprecated

    This interface is deprecated and will be removed in a future release as it is not used in the driver

    -
    interface CloseOptions {
        force?: boolean;
    }

    Properties

    force? -

    Properties

    Optionalforce

    force?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +
    interface CloseOptions {
        force?: boolean;
    }

    Properties

    force? +

    Properties

    Optionalforce

    force?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ConnectOptions.html b/docs/Next/interfaces/ConnectOptions.html index 5b0333f5d4c..e6eee52846a 100644 --- a/docs/Next/interfaces/ConnectOptions.html +++ b/docs/Next/interfaces/ConnectOptions.html @@ -1,2 +1,2 @@ -ConnectOptions | mongodb

    Interface ConnectOptions

    interface ConnectOptions {
        readPreference?: ReadPreference;
    }

    Properties

    readPreference? -

    Properties

    OptionalreadPreference

    readPreference?: ReadPreference

    Settings

    Member Visibility

    On This Page

    Properties
    +ConnectOptions | mongodb

    Interface ConnectOptions

    interface ConnectOptions {
        readPreference?: ReadPreference;
    }

    Properties

    readPreference? +

    Properties

    OptionalreadPreference

    readPreference?: ReadPreference

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ConnectionPoolOptions.html b/docs/Next/interfaces/ConnectionPoolOptions.html index 8cf9958d468..b2a6028fb44 100644 --- a/docs/Next/interfaces/ConnectionPoolOptions.html +++ b/docs/Next/interfaces/ConnectionPoolOptions.html @@ -1,4 +1,4 @@ -ConnectionPoolOptions | mongodb

    Interface ConnectionPoolOptions

    interface ConnectionPoolOptions {
        allowPartialTrustChain?: boolean;
        ALPNProtocols?: Uint8Array | string[] | Uint8Array[];
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
        ca?: string | Buffer | (string | Buffer)[];
        cancellationToken?: CancellationToken;
        cert?: string | Buffer | (string | Buffer)[];
        checkServerIdentity?: ((hostname: string, cert: PeerCertificate) => Error | undefined);
        ciphers?: string;
        compressors?: (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        connectTimeoutMS?: number;
        credentials?: MongoCredentials;
        crl?: string | Buffer | (string | Buffer)[];
        ecdhCurve?: string;
        family?: number;
        hints?: number;
        hostAddress: HostAddress;
        key?: string | Buffer | (string | Buffer | KeyObject)[];
        loadBalanced: boolean;
        localAddress?: string;
        localPort?: number;
        logicalSessionTimeoutMinutes?: number;
        lookup?: LookupFunction;
        maxConnecting: number;
        maxIdleTimeMS: number;
        maxPoolSize: number;
        metadata: ClientMetadata;
        minDHSize?: number;
        minPoolSize: number;
        monitorCommands: boolean;
        noDelay?: boolean;
        passphrase?: string;
        pfx?: string | Buffer | (string | Buffer | PxfObject)[];
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
        rejectUnauthorized?: boolean;
        secureContext?: SecureContext;
        secureProtocol?: string;
        serverApi?: ServerApi;
        servername?: string;
        session?: Buffer;
        socketTimeoutMS?: number;
        tls: boolean;
        waitQueueTimeoutMS: number;
    }

    Hierarchy

    Properties

    allowPartialTrustChain? +ConnectionPoolOptions | mongodb

    Interface ConnectionPoolOptions

    interface ConnectionPoolOptions {
        allowPartialTrustChain?: boolean;
        ALPNProtocols?: Uint8Array | string[] | Uint8Array[];
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
        ca?: string | Buffer | (string | Buffer)[];
        cancellationToken?: CancellationToken;
        cert?: string | Buffer | (string | Buffer)[];
        checkServerIdentity?: ((hostname: string, cert: PeerCertificate) => Error | undefined);
        ciphers?: string;
        compressors?: (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        connectTimeoutMS?: number;
        credentials?: MongoCredentials;
        crl?: string | Buffer | (string | Buffer)[];
        ecdhCurve?: string;
        family?: number;
        hints?: number;
        hostAddress: HostAddress;
        key?: string | Buffer | (string | Buffer | KeyObject)[];
        loadBalanced: boolean;
        localAddress?: string;
        localPort?: number;
        logicalSessionTimeoutMinutes?: number;
        lookup?: LookupFunction;
        maxConnecting: number;
        maxIdleTimeMS: number;
        maxPoolSize: number;
        metadata: ClientMetadata;
        minDHSize?: number;
        minPoolSize: number;
        monitorCommands: boolean;
        noDelay?: boolean;
        passphrase?: string;
        pfx?: string | Buffer | (string | Buffer | PxfObject)[];
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
        rejectUnauthorized?: boolean;
        secureContext?: SecureContext;
        secureProtocol?: string;
        serverApi?: ServerApi;
        servername?: string;
        session?: Buffer;
        socketTimeoutMS?: number;
        tls: boolean;
        waitQueueTimeoutMS: number;
    }

    Hierarchy

    Properties

    allowPartialTrustChain? ALPNProtocols? autoSelectFamily? autoSelectFamilyAttemptTimeout? @@ -100,11 +100,11 @@ object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

    loadBalanced

    loadBalanced: boolean

    If we are in load balancer mode.

    -

    OptionallocalAddress

    localAddress?: string

    OptionallocalPort

    localPort?: number

    OptionallogicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    Optionallookup

    lookup?: LookupFunction

    maxConnecting

    maxConnecting: number

    The maximum number of connections that may be in the process of being established concurrently by the connection pool.

    -

    maxIdleTimeMS

    maxIdleTimeMS: number

    The maximum amount of time a connection should remain idle in the connection pool before being marked idle.

    -

    maxPoolSize

    maxPoolSize: number

    The maximum number of connections that may be associated with a pool at a given time. This includes in use and available connections.

    -

    metadata

    metadata: ClientMetadata

    OptionalminDHSize

    minDHSize?: number

    minPoolSize

    minPoolSize: number

    The minimum number of connections that MUST exist at any moment in a single connection pool.

    -

    monitorCommands

    monitorCommands: boolean

    OptionalnoDelay

    noDelay?: boolean

    Optionalpassphrase

    passphrase?: string

    Shared passphrase used for a single private key and/or a PFX.

    +

    OptionallocalAddress

    localAddress?: string

    OptionallocalPort

    localPort?: number

    OptionallogicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    Optionallookup

    lookup?: LookupFunction

    maxConnecting

    maxConnecting: number

    The maximum number of connections that may be in the process of being established concurrently by the connection pool.

    +

    maxIdleTimeMS

    maxIdleTimeMS: number

    The maximum amount of time a connection should remain idle in the connection pool before being marked idle.

    +

    maxPoolSize

    maxPoolSize: number

    The maximum number of connections that may be associated with a pool at a given time. This includes in use and available connections.

    +

    metadata

    metadata: ClientMetadata

    OptionalminDHSize

    minDHSize?: number

    minPoolSize

    minPoolSize: number

    The minimum number of connections that MUST exist at any moment in a single connection pool.

    +

    monitorCommands

    monitorCommands: boolean

    OptionalnoDelay

    noDelay?: boolean

    Optionalpassphrase

    passphrase?: string

    Shared passphrase used for a single private key and/or a PFX.

    Optionalpfx

    pfx?: string | Buffer | (string | Buffer | PxfObject)[]

    PFX or PKCS12 encoded private key and certificate chain. pfx is an alternative to providing key and cert individually. PFX is usually encrypted, if it is, passphrase will be used to decrypt it. Multiple @@ -131,4 +131,4 @@ interoperability. Default: none, see minVersion.

    OptionalserverApi

    serverApi?: ServerApi

    Optionalservername

    servername?: string

    Optionalsession

    session?: Buffer

    An optional Buffer instance containing a TLS session.

    OptionalsocketTimeoutMS

    socketTimeoutMS?: number

    tls

    tls: boolean

    waitQueueTimeoutMS

    waitQueueTimeoutMS: number

    The maximum amount of time operation execution should wait for a connection to become available. The default is 0 which means there is no limit.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/DeleteManyModel.html b/docs/Next/interfaces/DeleteManyModel.html index 25b29c2b2af..354fe62bdbe 100644 --- a/docs/Next/interfaces/DeleteManyModel.html +++ b/docs/Next/interfaces/DeleteManyModel.html @@ -1,7 +1,7 @@ -DeleteManyModel | mongodb

    Interface DeleteManyModel<TSchema>

    interface DeleteManyModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
    }

    Type Parameters

    Properties

    collation? +DeleteManyModel | mongodb

    Interface DeleteManyModel<TSchema>

    interface DeleteManyModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
    }

    Type Parameters

    Properties

    collation? filter hint?

    Properties

    Optionalcollation

    collation?: CollationOptions

    Specifies a collation.

    -

    filter

    filter: Filter<TSchema>

    The filter to limit the deleted documents.

    -

    Optionalhint

    hint?: Hint

    The index to use. If specified, then the query system will only consider plans using the hinted index.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    filter

    filter: Filter<TSchema>

    The filter to limit the deleted documents.

    +

    Optionalhint

    hint?: Hint

    The index to use. If specified, then the query system will only consider plans using the hinted index.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/DeleteOneModel.html b/docs/Next/interfaces/DeleteOneModel.html index a51f24688e9..421b16692f6 100644 --- a/docs/Next/interfaces/DeleteOneModel.html +++ b/docs/Next/interfaces/DeleteOneModel.html @@ -1,7 +1,7 @@ -DeleteOneModel | mongodb

    Interface DeleteOneModel<TSchema>

    interface DeleteOneModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
    }

    Type Parameters

    Properties

    collation? +DeleteOneModel | mongodb

    Interface DeleteOneModel<TSchema>

    interface DeleteOneModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
    }

    Type Parameters

    Properties

    collation? filter hint?

    Properties

    Optionalcollation

    collation?: CollationOptions

    Specifies a collation.

    -

    filter

    filter: Filter<TSchema>

    The filter to limit the deleted documents.

    -

    Optionalhint

    hint?: Hint

    The index to use. If specified, then the query system will only consider plans using the hinted index.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    filter

    filter: Filter<TSchema>

    The filter to limit the deleted documents.

    +

    Optionalhint

    hint?: Hint

    The index to use. If specified, then the query system will only consider plans using the hinted index.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/EndSessionOptions.html b/docs/Next/interfaces/EndSessionOptions.html index fc00b05088a..abb46d2c3f2 100644 --- a/docs/Next/interfaces/EndSessionOptions.html +++ b/docs/Next/interfaces/EndSessionOptions.html @@ -1,5 +1,5 @@ -EndSessionOptions | mongodb

    Interface EndSessionOptions

    interface EndSessionOptions {
        force?: boolean;
        forceClear?: boolean;
        timeoutMS?: number;
    }

    Properties

    force? +EndSessionOptions | mongodb

    Interface EndSessionOptions

    interface EndSessionOptions {
        force?: boolean;
        forceClear?: boolean;
        timeoutMS?: number;
    }

    Properties

    force? forceClear? timeoutMS? -

    Properties

    Optionalforce

    force?: boolean

    OptionalforceClear

    forceClear?: boolean

    OptionaltimeoutMS

    timeoutMS?: number

    Specifies the time an operation will run until it throws a timeout error

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalforce

    force?: boolean

    OptionalforceClear

    forceClear?: boolean

    OptionaltimeoutMS

    timeoutMS?: number

    Specifies the time an operation will run until it throws a timeout error

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ErrorDescription.html b/docs/Next/interfaces/ErrorDescription.html index dac57c05541..795d8632b4c 100644 --- a/docs/Next/interfaces/ErrorDescription.html +++ b/docs/Next/interfaces/ErrorDescription.html @@ -1,6 +1,6 @@ -ErrorDescription | mongodb

    Interface ErrorDescription

    interface ErrorDescription {
        $err?: string;
        errInfo?: Document;
        errmsg?: string;
        errorLabels?: string[];
        message?: string;
    }

    Hierarchy (view full)

    Properties

    $err? +ErrorDescription | mongodb

    Interface ErrorDescription

    interface ErrorDescription {
        $err?: string;
        errInfo?: Document;
        errmsg?: string;
        errorLabels?: string[];
        message?: string;
    }

    Hierarchy (view full)

    Properties

    $err? errInfo? errmsg? errorLabels? message? -

    Properties

    Optional$err

    $err?: string

    OptionalerrInfo

    errInfo?: Document

    Optionalerrmsg

    errmsg?: string

    OptionalerrorLabels

    errorLabels?: string[]

    Optionalmessage

    message?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optional$err

    $err?: string

    OptionalerrInfo

    errInfo?: Document

    Optionalerrmsg

    errmsg?: string

    OptionalerrorLabels

    errorLabels?: string[]

    Optionalmessage

    message?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/InsertOneModel.html b/docs/Next/interfaces/InsertOneModel.html index f96323d902a..b47cca175f5 100644 --- a/docs/Next/interfaces/InsertOneModel.html +++ b/docs/Next/interfaces/InsertOneModel.html @@ -1,3 +1,3 @@ -InsertOneModel | mongodb

    Interface InsertOneModel<TSchema>

    interface InsertOneModel<TSchema> {
        document: OptionalId<TSchema>;
    }

    Type Parameters

    Properties

    document +InsertOneModel | mongodb

    Interface InsertOneModel<TSchema>

    interface InsertOneModel<TSchema> {
        document: OptionalId<TSchema>;
    }

    Type Parameters

    Properties

    document

    Properties

    document

    document: OptionalId<TSchema>

    The document to insert.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/MongoNetworkErrorOptions.html b/docs/Next/interfaces/MongoNetworkErrorOptions.html index 7c9532b3d9f..ff6a5b33b20 100644 --- a/docs/Next/interfaces/MongoNetworkErrorOptions.html +++ b/docs/Next/interfaces/MongoNetworkErrorOptions.html @@ -1,4 +1,4 @@ -MongoNetworkErrorOptions | mongodb

    Interface MongoNetworkErrorOptions

    interface MongoNetworkErrorOptions {
        beforeHandshake?: boolean;
        cause?: Error;
    }

    Properties

    beforeHandshake? +MongoNetworkErrorOptions | mongodb

    Interface MongoNetworkErrorOptions

    interface MongoNetworkErrorOptions {
        beforeHandshake?: boolean;
        cause?: Error;
    }

    Properties

    beforeHandshake? cause?

    Properties

    OptionalbeforeHandshake

    beforeHandshake?: boolean

    Indicates the timeout happened before a connection handshake completed

    -

    Optionalcause

    cause?: Error

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionalcause

    cause?: Error

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/MongoOptions.html b/docs/Next/interfaces/MongoOptions.html index f134ae78897..4b2e0dc1536 100644 --- a/docs/Next/interfaces/MongoOptions.html +++ b/docs/Next/interfaces/MongoOptions.html @@ -11,7 +11,7 @@
  • DNS SRV records and TXT records

    • Not all options may be present after client construction as some are obtained from asynchronous operations.

    -
    interface MongoOptions {
        allowPartialTrustChain?: boolean;
        ALPNProtocols?: Uint8Array | string[] | Uint8Array[];
        appName?: string;
        autoEncryption: AutoEncryptionOptions;
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
        ca?: string | Buffer | (string | Buffer)[];
        cert?: string | Buffer | (string | Buffer)[];
        checkServerIdentity?: ((hostname: string, cert: PeerCertificate) => Error | undefined);
        ciphers?: string;
        compressors: (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        connectTimeoutMS: number;
        credentials?: MongoCredentials;
        crl?: string | Buffer | (string | Buffer)[];
        dbName: string;
        directConnection: boolean;
        driverInfo: DriverInfo;
        ecdhCurve?: string;
        family?: number;
        forceServerObjectId: boolean;
        heartbeatFrequencyMS: number;
        hints?: number;
        hosts: HostAddress[];
        key?: string | Buffer | (string | Buffer | KeyObject)[];
        loadBalanced: boolean;
        localAddress?: string;
        localPort?: number;
        localThresholdMS: number;
        lookup?: LookupFunction;
        maxConnecting: number;
        maxIdleTimeMS: number;
        maxPoolSize: number;
        metadata: ClientMetadata;
        minDHSize?: number;
        minHeartbeatFrequencyMS: number;
        minPoolSize: number;
        monitorCommands: boolean;
        noDelay: boolean;
        passphrase?: string;
        pfx?: string | Buffer | (string | Buffer | PxfObject)[];
        pkFactory: PkFactory;
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
        raw: boolean;
        readConcern: ReadConcern;
        readPreference: ReadPreference;
        rejectUnauthorized?: boolean;
        replicaSet: string;
        retryReads: boolean;
        retryWrites: boolean;
        secureContext?: SecureContext;
        secureProtocol?: string;
        serverApi: ServerApi;
        serverMonitoringMode: ServerMonitoringMode;
        servername?: string;
        serverSelectionTimeoutMS: number;
        session?: Buffer;
        socketTimeoutMS: number;
        srvHost?: string;
        srvMaxHosts: number;
        srvServiceName: string;
        timeoutMS?: number;
        tls: boolean;
        tlsAllowInvalidCertificates: boolean;
        tlsAllowInvalidHostnames: boolean;
        tlsCAFile?: string;
        tlsCertificateKeyFile?: string;
        tlsCRLFile?: string;
        tlsInsecure: boolean;
        waitQueueTimeoutMS: number;
        writeConcern: WriteConcern;
        zlibCompressionLevel:
            | 0
            | 1
            | 2
            | 3
            | 4
            | 5
            | 6
            | 7
            | 8
            | 9;
    }

    Hierarchy (view full)

    • Required<Pick<MongoClientOptions,
          | "autoEncryption"
          | "connectTimeoutMS"
          | "directConnection"
          | "driverInfo"
          | "forceServerObjectId"
          | "minHeartbeatFrequencyMS"
          | "heartbeatFrequencyMS"
          | "localThresholdMS"
          | "maxConnecting"
          | "maxIdleTimeMS"
          | "maxPoolSize"
          | "minPoolSize"
          | "monitorCommands"
          | "noDelay"
          | "pkFactory"
          | "raw"
          | "replicaSet"
          | "retryReads"
          | "retryWrites"
          | "serverSelectionTimeoutMS"
          | "socketTimeoutMS"
          | "srvMaxHosts"
          | "srvServiceName"
          | "tlsAllowInvalidCertificates"
          | "tlsAllowInvalidHostnames"
          | "tlsInsecure"
          | "waitQueueTimeoutMS"
          | "zlibCompressionLevel">>
    • SupportedNodeConnectionOptions
      • MongoOptions

    Properties

    allowPartialTrustChain? +
    interface MongoOptions {
        allowPartialTrustChain?: boolean;
        ALPNProtocols?: Uint8Array | string[] | Uint8Array[];
        appName?: string;
        autoEncryption: AutoEncryptionOptions;
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
        ca?: string | Buffer | (string | Buffer)[];
        cert?: string | Buffer | (string | Buffer)[];
        checkServerIdentity?: ((hostname: string, cert: PeerCertificate) => Error | undefined);
        ciphers?: string;
        compressors: (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        connectTimeoutMS: number;
        credentials?: MongoCredentials;
        crl?: string | Buffer | (string | Buffer)[];
        dbName: string;
        directConnection: boolean;
        driverInfo: DriverInfo;
        ecdhCurve?: string;
        family?: number;
        forceServerObjectId: boolean;
        heartbeatFrequencyMS: number;
        hints?: number;
        hosts: HostAddress[];
        key?: string | Buffer | (string | Buffer | KeyObject)[];
        loadBalanced: boolean;
        localAddress?: string;
        localPort?: number;
        localThresholdMS: number;
        lookup?: LookupFunction;
        maxConnecting: number;
        maxIdleTimeMS: number;
        maxPoolSize: number;
        metadata: ClientMetadata;
        minDHSize?: number;
        minHeartbeatFrequencyMS: number;
        minPoolSize: number;
        monitorCommands: boolean;
        noDelay: boolean;
        passphrase?: string;
        pfx?: string | Buffer | (string | Buffer | PxfObject)[];
        pkFactory: PkFactory;
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
        raw: boolean;
        readConcern: ReadConcern;
        readPreference: ReadPreference;
        rejectUnauthorized?: boolean;
        replicaSet: string;
        retryReads: boolean;
        retryWrites: boolean;
        secureContext?: SecureContext;
        secureProtocol?: string;
        serverApi: ServerApi;
        serverMonitoringMode: ServerMonitoringMode;
        servername?: string;
        serverSelectionTimeoutMS: number;
        session?: Buffer;
        socketTimeoutMS: number;
        srvHost?: string;
        srvMaxHosts: number;
        srvServiceName: string;
        timeoutMS?: number;
        tls: boolean;
        tlsAllowInvalidCertificates: boolean;
        tlsAllowInvalidHostnames: boolean;
        tlsCAFile?: string;
        tlsCertificateKeyFile?: string;
        tlsCRLFile?: string;
        tlsInsecure: boolean;
        waitQueueTimeoutMS: number;
        writeConcern: WriteConcern;
        zlibCompressionLevel:
            | 0
            | 1
            | 2
            | 3
            | 4
            | 5
            | 6
            | 7
            | 8
            | 9;
    }

    Hierarchy (view full)

    • Required<Pick<MongoClientOptions,
          | "autoEncryption"
          | "connectTimeoutMS"
          | "directConnection"
          | "driverInfo"
          | "forceServerObjectId"
          | "minHeartbeatFrequencyMS"
          | "heartbeatFrequencyMS"
          | "localThresholdMS"
          | "maxConnecting"
          | "maxIdleTimeMS"
          | "maxPoolSize"
          | "minPoolSize"
          | "monitorCommands"
          | "noDelay"
          | "pkFactory"
          | "raw"
          | "replicaSet"
          | "retryReads"
          | "retryWrites"
          | "serverSelectionTimeoutMS"
          | "socketTimeoutMS"
          | "srvMaxHosts"
          | "srvServiceName"
          | "tlsAllowInvalidCertificates"
          | "tlsAllowInvalidHostnames"
          | "tlsInsecure"
          | "waitQueueTimeoutMS"
          | "zlibCompressionLevel">>
    • SupportedNodeConnectionOptions
      • MongoOptions

    Properties

    allowPartialTrustChain? ALPNProtocols? appName? autoEncryption @@ -90,7 +90,7 @@

    Since

    v22.9.0, v20.18.0

    OptionalALPNProtocols

    ALPNProtocols?: Uint8Array | string[] | Uint8Array[]

    An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

    -

    OptionalappName

    appName?: string

    autoEncryption

    autoEncryption: AutoEncryptionOptions

    Optionally enable in-use auto encryption

    +

    OptionalappName

    appName?: string

    autoEncryption

    autoEncryption: AutoEncryptionOptions

    Optionally enable in-use auto encryption

    Remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    @@ -134,10 +134,10 @@ information, see modifying the default cipher suite. Permitted ciphers can be obtained via tls.getCiphers(). Cipher names must be uppercased in order for OpenSSL to accept them.

    -

    compressors

    compressors: (
        | "none"
        | "snappy"
        | "zlib"
        | "zstd")[]

    connectTimeoutMS

    connectTimeoutMS: number

    The time in milliseconds to attempt a connection before timing out.

    -

    Optionalcredentials

    credentials?: MongoCredentials

    Optionalcrl

    crl?: string | Buffer | (string | Buffer)[]

    PEM formatted CRLs (Certificate Revocation Lists).

    -

    dbName

    dbName: string

    directConnection

    directConnection: boolean

    Allow a driver to force a Single topology type with a connection string containing one host

    -

    driverInfo

    driverInfo: DriverInfo

    Allows a wrapping driver to amend the client metadata generated by the driver to include information about the wrapping driver

    +

    compressors

    compressors: (
        | "none"
        | "snappy"
        | "zlib"
        | "zstd")[]

    connectTimeoutMS

    connectTimeoutMS: number

    The time in milliseconds to attempt a connection before timing out.

    +

    Optionalcredentials

    credentials?: MongoCredentials

    Optionalcrl

    crl?: string | Buffer | (string | Buffer)[]

    PEM formatted CRLs (Certificate Revocation Lists).

    +

    dbName

    dbName: string

    directConnection

    directConnection: boolean

    Allow a driver to force a Single topology type with a connection string containing one host

    +

    driverInfo

    driverInfo: DriverInfo

    Allows a wrapping driver to amend the client metadata generated by the driver to include information about the wrapping driver

    OptionalecdhCurve

    ecdhCurve?: string

    A string describing a named curve or a colon separated list of curve NIDs or names, for example P-521:P-384:P-256, to use for ECDH key agreement. Set to auto to select the curve automatically. Use @@ -147,7 +147,7 @@ tls.DEFAULT_ECDH_CURVE.

    Optionalfamily

    family?: number

    forceServerObjectId

    forceServerObjectId: boolean

    Force server to assign _id values instead of driver

    heartbeatFrequencyMS

    heartbeatFrequencyMS: number

    heartbeatFrequencyMS controls when the driver checks the state of the MongoDB deployment. Specify the interval (in milliseconds) between checks, counted from the end of the previous check until the beginning of the next one.

    -

    Optionalhints

    hints?: number

    hosts

    hosts: HostAddress[]

    Optionalkey

    key?: string | Buffer | (string | Buffer | KeyObject)[]

    Private keys in PEM format. PEM allows the option of private keys +

    Optionalhints

    hints?: number

    hosts

    hosts: HostAddress[]

    Optionalkey

    key?: string | Buffer | (string | Buffer | KeyObject)[]

    Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with options.passphrase. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or buffers, @@ -155,11 +155,11 @@ passphrase: ]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

    -

    loadBalanced

    loadBalanced: boolean

    OptionallocalAddress

    localAddress?: string

    OptionallocalPort

    localPort?: number

    localThresholdMS

    localThresholdMS: number

    The size (in milliseconds) of the latency window for selecting among multiple suitable MongoDB instances.

    +

    loadBalanced

    loadBalanced: boolean

    OptionallocalAddress

    localAddress?: string

    OptionallocalPort

    localPort?: number

    localThresholdMS

    localThresholdMS: number

    The size (in milliseconds) of the latency window for selecting among multiple suitable MongoDB instances.

    Optionallookup

    lookup?: LookupFunction

    maxConnecting

    maxConnecting: number

    The maximum number of connections that may be in the process of being established concurrently by the connection pool.

    maxIdleTimeMS

    maxIdleTimeMS: number

    The maximum number of milliseconds that a connection can remain idle in the pool before being removed and closed.

    maxPoolSize

    maxPoolSize: number

    The maximum number of connections in the connection pool.

    -

    metadata

    metadata: ClientMetadata

    OptionalminDHSize

    minDHSize?: number

    minHeartbeatFrequencyMS

    minHeartbeatFrequencyMS: number

    Sets the minimum heartbeat frequency. In the event that the driver has to frequently re-check a server's availability, it will wait at least this long since the previous check to avoid wasted effort.

    +

    metadata

    metadata: ClientMetadata

    OptionalminDHSize

    minDHSize?: number

    minHeartbeatFrequencyMS

    minHeartbeatFrequencyMS: number

    Sets the minimum heartbeat frequency. In the event that the driver has to frequently re-check a server's availability, it will wait at least this long since the previous check to avoid wasted effort.

    minPoolSize

    minPoolSize: number

    The minimum number of connections in the connection pool.

    monitorCommands

    monitorCommands: boolean

    Enable command monitoring for this client

    noDelay

    noDelay: boolean

    TCP Connection no delay

    @@ -173,7 +173,7 @@ object.passphrase is optional. Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

    pkFactory

    pkFactory: PkFactory

    A primary key factory function for generation of custom _id keys

    -

    OptionalproxyHost

    proxyHost?: string

    OptionalproxyPassword

    proxyPassword?: string

    OptionalproxyPort

    proxyPort?: number

    OptionalproxyUsername

    proxyUsername?: string

    raw

    raw: boolean

    Enabling the raw option will return a Node.js Buffer +

    OptionalproxyHost

    proxyHost?: string

    OptionalproxyPassword

    proxyPassword?: string

    OptionalproxyPort

    proxyPort?: number

    OptionalproxyUsername

    proxyUsername?: string

    raw

    raw: boolean

    Enabling the raw option will return a Node.js Buffer which is allocated using allocUnsafe API. See this section from the Node.js Docs here for more detail about what "unsafe" refers to in this context. @@ -184,7 +184,7 @@

    Remarks

    Please note there is a known limitation where this option cannot be used at the MongoClient level (see NODE-3946). It does correctly work at Db, Collection, and per operation the same as other BSON options work.

    -

    readConcern

    readConcern: ReadConcern

    readPreference

    readPreference: ReadPreference

    OptionalrejectUnauthorized

    rejectUnauthorized?: boolean

    If true the server will reject any connection which is not +

    readConcern

    readConcern: ReadConcern

    readPreference

    readPreference: ReadPreference

    OptionalrejectUnauthorized

    rejectUnauthorized?: boolean

    If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true.

    Default

    true
@@ -203,14 +203,14 @@ 
    Remarks
-

    serverApi

    serverApi: ServerApi

    serverMonitoringMode

    serverMonitoringMode: ServerMonitoringMode

    Optionalservername

    servername?: string

    serverSelectionTimeoutMS

    serverSelectionTimeoutMS: number

    Specifies how long (in milliseconds) to block for server selection before throwing an exception.

    +

    serverApi

    serverApi: ServerApi

    serverMonitoringMode

    serverMonitoringMode: ServerMonitoringMode

    Optionalservername

    servername?: string

    serverSelectionTimeoutMS

    serverSelectionTimeoutMS: number

    Specifies how long (in milliseconds) to block for server selection before throwing an exception.

    Optionalsession

    session?: Buffer

    An optional Buffer instance containing a TLS session.

    socketTimeoutMS

    socketTimeoutMS: number

    The time in milliseconds to attempt a send or receive on a socket before the attempt times out.

    -

    OptionalsrvHost

    srvHost?: string

    srvMaxHosts

    srvMaxHosts: number

    The maximum number of hosts to connect to when using an srv connection string, a setting of 0 means unlimited hosts

    +

    OptionalsrvHost

    srvHost?: string

    srvMaxHosts

    srvMaxHosts: number

    The maximum number of hosts to connect to when using an srv connection string, a setting of 0 means unlimited hosts

    srvServiceName

    srvServiceName: string

    Modifies the srv URI to look like:

    _{srvServiceName}._tcp.{hostname}.{domainname}

    Querying this DNS URI is expected to respond with SRV records

    -

    OptionaltimeoutMS

    timeoutMS?: number

    tls

    tls: boolean

    NOTE ABOUT TLS Options

    If tls is provided as an option, it is equivalent to setting the ssl option.

    +

    OptionaltimeoutMS

    timeoutMS?: number

    tls

    tls: boolean

    NOTE ABOUT TLS Options

    If tls is provided as an option, it is equivalent to setting the ssl option.

    NodeJS native TLS options are passed through to the socket and retain their original types.

    Additional options:

    @@ -273,9 +273,9 @@

    Remarksca, cert, crl and key fields are populated, they will not be read again on subsequent calls to MongoClient.connect. As a result, until the first call to MongoClient.connect, the ca, cert, crl and key fields will be undefined.

    -

    tlsAllowInvalidCertificates

    tlsAllowInvalidCertificates: boolean

    Bypasses validation of the certificates presented by the mongod/mongos instance

    +

    tlsAllowInvalidCertificates

    tlsAllowInvalidCertificates: boolean

    Bypasses validation of the certificates presented by the mongod/mongos instance

    tlsAllowInvalidHostnames

    tlsAllowInvalidHostnames: boolean

    Disables hostname validation of the certificate presented by the mongod/mongos instance.

    -

    OptionaltlsCAFile

    tlsCAFile?: string

    OptionaltlsCertificateKeyFile

    tlsCertificateKeyFile?: string

    OptionaltlsCRLFile

    tlsCRLFile?: string

    tlsInsecure

    tlsInsecure: boolean

    Disables various certificate validations.

    +

    OptionaltlsCAFile

    tlsCAFile?: string

    OptionaltlsCertificateKeyFile

    tlsCertificateKeyFile?: string

    OptionaltlsCRLFile

    tlsCRLFile?: string

    tlsInsecure

    tlsInsecure: boolean

    Disables various certificate validations.

    waitQueueTimeoutMS

    waitQueueTimeoutMS: number

    The maximum time in milliseconds that a thread can wait for a connection to become available.

    -

    writeConcern

    writeConcern: WriteConcern

    zlibCompressionLevel

    zlibCompressionLevel:
        | 0
        | 1
        | 2
        | 3
        | 4
        | 5
        | 6
        | 7
        | 8
        | 9

    An integer that specifies the compression level if using zlib for network compression.

    +

    writeConcern

    writeConcern: WriteConcern

    zlibCompressionLevel

    zlibCompressionLevel:
        | 0
        | 1
        | 2
        | 3
        | 4
        | 5
        | 6
        | 7
        | 8
        | 9

    An integer that specifies the compression level if using zlib for network compression.

    Settings

    Member Visibility

    On This Page

    Properties
    allowPartialTrustChainALPNProtocolsappNameautoEncryptionautoSelectFamilyautoSelectFamilyAttemptTimeoutcacertcheckServerIdentitycipherscompressorsconnectTimeoutMScredentialscrldbNamedirectConnectiondriverInfoecdhCurvefamilyforceServerObjectIdheartbeatFrequencyMShintshostskeyloadBalancedlocalAddresslocalPortlocalThresholdMSlookupmaxConnectingmaxIdleTimeMSmaxPoolSizemetadataminDHSizeminHeartbeatFrequencyMSminPoolSizemonitorCommandsnoDelaypassphrasepfxpkFactoryproxyHostproxyPasswordproxyPortproxyUsernamerawreadConcernreadPreferencerejectUnauthorizedreplicaSetretryReadsretryWritessecureContextsecureProtocolserverApiserverMonitoringModeservernameserverSelectionTimeoutMSsessionsocketTimeoutMSsrvHostsrvMaxHostssrvServiceNametimeoutMStlstlsAllowInvalidCertificatestlsAllowInvalidHostnamestlsCAFiletlsCertificateKeyFiletlsCRLFiletlsInsecurewaitQueueTimeoutMSwriteConcernzlibCompressionLevel
    diff --git a/docs/Next/interfaces/MonitorOptions.html b/docs/Next/interfaces/MonitorOptions.html index d89f64abbdd..799be2d1d96 100644 --- a/docs/Next/interfaces/MonitorOptions.html +++ b/docs/Next/interfaces/MonitorOptions.html @@ -1,4 +1,4 @@ -MonitorOptions | mongodb

    Interface MonitorOptions

    interface MonitorOptions {
        allowPartialTrustChain?: boolean;
        ALPNProtocols?: Uint8Array | string[] | Uint8Array[];
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
        ca?: string | Buffer | (string | Buffer)[];
        cancellationToken?: CancellationToken;
        cert?: string | Buffer | (string | Buffer)[];
        checkServerIdentity?: ((hostname: string, cert: PeerCertificate) => Error | undefined);
        ciphers?: string;
        compressors?: (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        connectTimeoutMS: number;
        credentials?: MongoCredentials;
        crl?: string | Buffer | (string | Buffer)[];
        ecdhCurve?: string;
        family?: number;
        heartbeatFrequencyMS: number;
        hints?: number;
        key?: string | Buffer | (string | Buffer | KeyObject)[];
        loadBalanced: boolean;
        localAddress?: string;
        localPort?: number;
        logicalSessionTimeoutMinutes?: number;
        lookup?: LookupFunction;
        metadata: ClientMetadata;
        minDHSize?: number;
        minHeartbeatFrequencyMS: number;
        monitorCommands: boolean;
        noDelay?: boolean;
        passphrase?: string;
        pfx?: string | Buffer | (string | Buffer | PxfObject)[];
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
        rejectUnauthorized?: boolean;
        secureContext?: SecureContext;
        secureProtocol?: string;
        serverApi?: ServerApi;
        serverMonitoringMode: ServerMonitoringMode;
        servername?: string;
        session?: Buffer;
        socketTimeoutMS?: number;
        tls: boolean;
    }

    Hierarchy

    Properties

    allowPartialTrustChain? +MonitorOptions | mongodb

    Interface MonitorOptions

    interface MonitorOptions {
        allowPartialTrustChain?: boolean;
        ALPNProtocols?: Uint8Array | string[] | Uint8Array[];
        autoSelectFamily?: boolean;
        autoSelectFamilyAttemptTimeout?: number;
        ca?: string | Buffer | (string | Buffer)[];
        cancellationToken?: CancellationToken;
        cert?: string | Buffer | (string | Buffer)[];
        checkServerIdentity?: ((hostname: string, cert: PeerCertificate) => Error | undefined);
        ciphers?: string;
        compressors?: (
            | "none"
            | "snappy"
            | "zlib"
            | "zstd")[];
        connectTimeoutMS: number;
        credentials?: MongoCredentials;
        crl?: string | Buffer | (string | Buffer)[];
        ecdhCurve?: string;
        family?: number;
        heartbeatFrequencyMS: number;
        hints?: number;
        key?: string | Buffer | (string | Buffer | KeyObject)[];
        loadBalanced: boolean;
        localAddress?: string;
        localPort?: number;
        logicalSessionTimeoutMinutes?: number;
        lookup?: LookupFunction;
        metadata: ClientMetadata;
        minDHSize?: number;
        minHeartbeatFrequencyMS: number;
        monitorCommands: boolean;
        noDelay?: boolean;
        passphrase?: string;
        pfx?: string | Buffer | (string | Buffer | PxfObject)[];
        proxyHost?: string;
        proxyPassword?: string;
        proxyPort?: number;
        proxyUsername?: string;
        rejectUnauthorized?: boolean;
        secureContext?: SecureContext;
        secureProtocol?: string;
        serverApi?: ServerApi;
        serverMonitoringMode: ServerMonitoringMode;
        servername?: string;
        session?: Buffer;
        socketTimeoutMS?: number;
        tls: boolean;
    }

    Hierarchy

    Properties

    allowPartialTrustChain? ALPNProtocols? autoSelectFamily? autoSelectFamilyAttemptTimeout? @@ -80,7 +80,7 @@ information, see modifying the default cipher suite. Permitted ciphers can be obtained via tls.getCiphers(). Cipher names must be uppercased in order for OpenSSL to accept them.

    -

    Optionalcompressors

    compressors?: (
        | "none"
        | "snappy"
        | "zlib"
        | "zstd")[]

    connectTimeoutMS

    connectTimeoutMS: number

    Optionalcredentials

    credentials?: MongoCredentials

    Optionalcrl

    crl?: string | Buffer | (string | Buffer)[]

    PEM formatted CRLs (Certificate Revocation Lists).

    +

    Optionalcompressors

    compressors?: (
        | "none"
        | "snappy"
        | "zlib"
        | "zstd")[]

    connectTimeoutMS

    connectTimeoutMS: number

    Optionalcredentials

    credentials?: MongoCredentials

    Optionalcrl

    crl?: string | Buffer | (string | Buffer)[]

    PEM formatted CRLs (Certificate Revocation Lists).

    OptionalecdhCurve

    ecdhCurve?: string

    A string describing a named curve or a colon separated list of curve NIDs or names, for example P-521:P-384:P-256, to use for ECDH key agreement. Set to auto to select the curve automatically. Use @@ -88,7 +88,7 @@ recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. Default: tls.DEFAULT_ECDH_CURVE.

    -

    Optionalfamily

    family?: number

    heartbeatFrequencyMS

    heartbeatFrequencyMS: number

    Optionalhints

    hints?: number

    Optionalkey

    key?: string | Buffer | (string | Buffer | KeyObject)[]

    Private keys in PEM format. PEM allows the option of private keys +

    Optionalfamily

    family?: number

    heartbeatFrequencyMS

    heartbeatFrequencyMS: number

    Optionalhints

    hints?: number

    Optionalkey

    key?: string | Buffer | (string | Buffer | KeyObject)[]

    Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with options.passphrase. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or buffers, @@ -96,7 +96,7 @@ passphrase: ]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

    -

    loadBalanced

    loadBalanced: boolean

    OptionallocalAddress

    localAddress?: string

    OptionallocalPort

    localPort?: number

    OptionallogicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    Optionallookup

    lookup?: LookupFunction

    metadata

    metadata: ClientMetadata

    OptionalminDHSize

    minDHSize?: number

    minHeartbeatFrequencyMS

    minHeartbeatFrequencyMS: number

    monitorCommands

    monitorCommands: boolean

    OptionalnoDelay

    noDelay?: boolean

    Optionalpassphrase

    passphrase?: string

    Shared passphrase used for a single private key and/or a PFX.

    +

    loadBalanced

    loadBalanced: boolean

    OptionallocalAddress

    localAddress?: string

    OptionallocalPort

    localPort?: number

    OptionallogicalSessionTimeoutMinutes

    logicalSessionTimeoutMinutes?: number

    Optionallookup

    lookup?: LookupFunction

    metadata

    metadata: ClientMetadata

    OptionalminDHSize

    minDHSize?: number

    minHeartbeatFrequencyMS

    minHeartbeatFrequencyMS: number

    monitorCommands

    monitorCommands: boolean

    OptionalnoDelay

    noDelay?: boolean

    Optionalpassphrase

    passphrase?: string

    Shared passphrase used for a single private key and/or a PFX.

    Optionalpfx

    pfx?: string | Buffer | (string | Buffer | PxfObject)[]

    PFX or PKCS12 encoded private key and certificate chain. pfx is an alternative to providing key and cert individually. PFX is usually encrypted, if it is, passphrase will be used to decrypt it. Multiple @@ -121,5 +121,5 @@ any TLS protocol version up to TLSv1.3. It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.

    -

    OptionalserverApi

    serverApi?: ServerApi

    serverMonitoringMode

    serverMonitoringMode: ServerMonitoringMode

    Optionalservername

    servername?: string

    Optionalsession

    session?: Buffer

    An optional Buffer instance containing a TLS session.

    +

    OptionalserverApi

    serverApi?: ServerApi

    serverMonitoringMode

    serverMonitoringMode: ServerMonitoringMode

    Optionalservername

    servername?: string

    Optionalsession

    session?: Buffer

    An optional Buffer instance containing a TLS session.

    OptionalsocketTimeoutMS

    socketTimeoutMS?: number

    tls

    tls: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ReplaceOneModel.html b/docs/Next/interfaces/ReplaceOneModel.html index ede10020f72..589541e06d6 100644 --- a/docs/Next/interfaces/ReplaceOneModel.html +++ b/docs/Next/interfaces/ReplaceOneModel.html @@ -1,11 +1,11 @@ -ReplaceOneModel | mongodb

    Interface ReplaceOneModel<TSchema>

    interface ReplaceOneModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        replacement: WithoutId<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    Properties

    collation? +ReplaceOneModel | mongodb

    Interface ReplaceOneModel<TSchema>

    interface ReplaceOneModel<TSchema> {
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        replacement: WithoutId<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    Properties

    collation? filter hint? replacement upsert?

    Properties

    Optionalcollation

    collation?: CollationOptions

    Specifies a collation.

    -

    filter

    filter: Filter<TSchema>

    The filter to limit the replaced document.

    -

    Optionalhint

    hint?: Hint

    The index to use. If specified, then the query system will only consider plans using the hinted index.

    -

    replacement

    replacement: WithoutId<TSchema>

    The document with which to replace the matched document.

    -

    Optionalupsert

    upsert?: boolean

    When true, creates a new document if no document matches the query.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    filter

    filter: Filter<TSchema>

    The filter to limit the replaced document.

    +

    Optionalhint

    hint?: Hint

    The index to use. If specified, then the query system will only consider plans using the hinted index.

    +

    replacement

    replacement: WithoutId<TSchema>

    The document with which to replace the matched document.

    +

    Optionalupsert

    upsert?: boolean

    When true, creates a new document if no document matches the query.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/ResumeOptions.html b/docs/Next/interfaces/ResumeOptions.html index 25c26a0cd34..9a637f86e69 100644 --- a/docs/Next/interfaces/ResumeOptions.html +++ b/docs/Next/interfaces/ResumeOptions.html @@ -1,5 +1,5 @@ ResumeOptions | mongodb

    Interface ResumeOptions

    Deprecated

    Please use the ChangeStreamCursorOptions type instead.

    -
    interface ResumeOptions {
        batchSize?: number;
        collation?: CollationOptions;
        fullDocument?: string;
        maxAwaitTimeMS?: number;
        readPreference?: ReadPreference;
        resumeAfter?: unknown;
        startAfter?: unknown;
        startAtOperationTime?: Timestamp;
    }

    Properties

    batchSize? +
    interface ResumeOptions {
        batchSize?: number;
        collation?: CollationOptions;
        fullDocument?: string;
        maxAwaitTimeMS?: number;
        readPreference?: ReadPreference;
        resumeAfter?: unknown;
        startAfter?: unknown;
        startAtOperationTime?: Timestamp;
    }

    Properties

    batchSize? collation? fullDocument? maxAwaitTimeMS? @@ -7,4 +7,4 @@ resumeAfter? startAfter? startAtOperationTime? -

    Properties

    OptionalbatchSize

    batchSize?: number

    Optionalcollation

    collation?: CollationOptions

    OptionalfullDocument

    fullDocument?: string

    OptionalmaxAwaitTimeMS

    maxAwaitTimeMS?: number

    OptionalreadPreference

    readPreference?: ReadPreference

    OptionalresumeAfter

    resumeAfter?: unknown

    OptionalstartAfter

    startAfter?: unknown

    OptionalstartAtOperationTime

    startAtOperationTime?: Timestamp

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalbatchSize

    batchSize?: number

    Optionalcollation

    collation?: CollationOptions

    OptionalfullDocument

    fullDocument?: string

    OptionalmaxAwaitTimeMS

    maxAwaitTimeMS?: number

    OptionalreadPreference

    readPreference?: ReadPreference

    OptionalresumeAfter

    resumeAfter?: unknown

    OptionalstartAfter

    startAfter?: unknown

    OptionalstartAtOperationTime

    startAtOperationTime?: Timestamp

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/SelectServerOptions.html b/docs/Next/interfaces/SelectServerOptions.html index f37b04544fd..9c1d46ae651 100644 --- a/docs/Next/interfaces/SelectServerOptions.html +++ b/docs/Next/interfaces/SelectServerOptions.html @@ -1,7 +1,7 @@ -SelectServerOptions | mongodb

    Interface SelectServerOptions

    interface SelectServerOptions {
        operationName: string;
        previousServer?: ServerDescription;
        readPreference?: ReadPreferenceLike;
        serverSelectionTimeoutMS?: number;
        session?: ClientSession;
    }

    Properties

    operationName +SelectServerOptions | mongodb

    Interface SelectServerOptions

    interface SelectServerOptions {
        operationName: string;
        previousServer?: ServerDescription;
        readPreference?: ReadPreferenceLike;
        serverSelectionTimeoutMS?: number;
        session?: ClientSession;
    }

    Properties

    operationName previousServer? readPreference? serverSelectionTimeoutMS? session? -

    Properties

    operationName

    operationName: string

    OptionalpreviousServer

    previousServer?: ServerDescription

    OptionalreadPreference

    readPreference?: ReadPreferenceLike

    OptionalserverSelectionTimeoutMS

    serverSelectionTimeoutMS?: number

    How long to block for server selection before throwing an error

    -

    Optionalsession

    session?: ClientSession

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    operationName

    operationName: string

    OptionalpreviousServer

    previousServer?: ServerDescription

    OptionalreadPreference

    readPreference?: ReadPreferenceLike

    OptionalserverSelectionTimeoutMS

    serverSelectionTimeoutMS?: number

    How long to block for server selection before throwing an error

    +

    Optionalsession

    session?: ClientSession

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/UpdateDescription.html b/docs/Next/interfaces/UpdateDescription.html index e3b89f9b680..98d18cd8f6f 100644 --- a/docs/Next/interfaces/UpdateDescription.html +++ b/docs/Next/interfaces/UpdateDescription.html @@ -1,4 +1,4 @@ -UpdateDescription | mongodb

    Interface UpdateDescription<TSchema>

    interface UpdateDescription<TSchema> {
        disambiguatedPaths?: Document;
        removedFields?: string[];
        truncatedArrays?: {
            field: string;
            newSize: number;
        }[];
        updatedFields?: Partial<TSchema>;
    }

    Type Parameters

    Properties

    disambiguatedPaths? +UpdateDescription | mongodb

    Interface UpdateDescription<TSchema>

    interface UpdateDescription<TSchema> {
        disambiguatedPaths?: Document;
        removedFields?: string[];
        truncatedArrays?: {
            field: string;
            newSize: number;
        }[];
        updatedFields?: Partial<TSchema>;
    }

    Type Parameters

    Properties

    disambiguatedPaths? removedFields? truncatedArrays? updatedFields? @@ -12,8 +12,8 @@

    This field is only present when there are ambiguous paths that are updated as a part of the update event and showExpandedEvents is enabled for the change stream.

    Since Server Version

    6.1.0

    -

    OptionalremovedFields

    removedFields?: string[]

    An array of field names that were removed from the document.

    -

    OptionaltruncatedArrays

    truncatedArrays?: {
        field: string;
        newSize: number;
    }[]

    An array of documents which record array truncations performed with pipeline-based updates using one or more of the following stages:

    +

    OptionalremovedFields

    removedFields?: string[]

    An array of field names that were removed from the document.

    +

    OptionaltruncatedArrays

    truncatedArrays?: {
        field: string;
        newSize: number;
    }[]

    An array of documents which record array truncations performed with pipeline-based updates using one or more of the following stages:

    • $addFields
    • $set
      • @@ -22,6 +22,6 @@

    Type declaration

    • field: string

      The name of the truncated field.

    • newSize: number

      The number of elements in the truncated array.

      -

    OptionalupdatedFields

    updatedFields?: Partial<TSchema>

    A document containing key:value pairs of names of the fields that were +

    OptionalupdatedFields

    updatedFields?: Partial<TSchema>

    A document containing key:value pairs of names of the fields that were changed, and the new value for those fields.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/UpdateManyModel.html b/docs/Next/interfaces/UpdateManyModel.html index ae2c0d0dafd..b9268951e7f 100644 --- a/docs/Next/interfaces/UpdateManyModel.html +++ b/docs/Next/interfaces/UpdateManyModel.html @@ -1,15 +1,15 @@ -UpdateManyModel | mongodb

    Interface UpdateManyModel<TSchema>

    interface UpdateManyModel<TSchema> {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        update: Document[] | UpdateFilter<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    Properties

    arrayFilters? +UpdateManyModel | mongodb

    Interface UpdateManyModel<TSchema>

    interface UpdateManyModel<TSchema> {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        update: Document[] | UpdateFilter<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    Properties

    arrayFilters? collation? filter hint? update upsert?

    Properties

    OptionalarrayFilters

    arrayFilters?: Document[]

    A set of filters specifying to which array elements an update should apply.

    -

    Optionalcollation

    collation?: CollationOptions

    Specifies a collation.

    -

    filter

    filter: Filter<TSchema>

    The filter to limit the updated documents.

    -

    Optionalhint

    hint?: Hint

    The index to use. If specified, then the query system will only consider plans using the hinted index.

    -

    update

    update: Document[] | UpdateFilter<TSchema>

    The modifications to apply. The value can be either: +

    Optionalcollation

    collation?: CollationOptions

    Specifies a collation.

    +

    filter

    filter: Filter<TSchema>

    The filter to limit the updated documents.

    +

    Optionalhint

    hint?: Hint

    The index to use. If specified, then the query system will only consider plans using the hinted index.

    +

    update

    update: Document[] | UpdateFilter<TSchema>

    The modifications to apply. The value can be either: UpdateFilter - A document that contains update operator expressions, Document[] - an aggregation pipeline.

    -

    Optionalupsert

    upsert?: boolean

    When true, creates a new document if no document matches the query.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionalupsert

    upsert?: boolean

    When true, creates a new document if no document matches the query.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/UpdateOneModel.html b/docs/Next/interfaces/UpdateOneModel.html index c874af29824..22d79908d78 100644 --- a/docs/Next/interfaces/UpdateOneModel.html +++ b/docs/Next/interfaces/UpdateOneModel.html @@ -1,15 +1,15 @@ -UpdateOneModel | mongodb

    Interface UpdateOneModel<TSchema>

    interface UpdateOneModel<TSchema> {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        update: Document[] | UpdateFilter<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    Properties

    arrayFilters? +UpdateOneModel | mongodb

    Interface UpdateOneModel<TSchema>

    interface UpdateOneModel<TSchema> {
        arrayFilters?: Document[];
        collation?: CollationOptions;
        filter: Filter<TSchema>;
        hint?: Hint;
        update: Document[] | UpdateFilter<TSchema>;
        upsert?: boolean;
    }

    Type Parameters

    Properties

    arrayFilters? collation? filter hint? update upsert?

    Properties

    OptionalarrayFilters

    arrayFilters?: Document[]

    A set of filters specifying to which array elements an update should apply.

    -

    Optionalcollation

    collation?: CollationOptions

    Specifies a collation.

    -

    filter

    filter: Filter<TSchema>

    The filter to limit the updated documents.

    -

    Optionalhint

    hint?: Hint

    The index to use. If specified, then the query system will only consider plans using the hinted index.

    -

    update

    update: Document[] | UpdateFilter<TSchema>

    The modifications to apply. The value can be either: +

    Optionalcollation

    collation?: CollationOptions

    Specifies a collation.

    +

    filter

    filter: Filter<TSchema>

    The filter to limit the updated documents.

    +

    Optionalhint

    hint?: Hint

    The index to use. If specified, then the query system will only consider plans using the hinted index.

    +

    update

    update: Document[] | UpdateFilter<TSchema>

    The modifications to apply. The value can be either: UpdateFilter - A document that contains update operator expressions, Document[] - an aggregation pipeline.

    -

    Optionalupsert

    upsert?: boolean

    When true, creates a new document if no document matches the query.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Optionalupsert

    upsert?: boolean

    When true, creates a new document if no document matches the query.

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/WriteConcernErrorData.html b/docs/Next/interfaces/WriteConcernErrorData.html index 5b17c7e0404..ef67da161d0 100644 --- a/docs/Next/interfaces/WriteConcernErrorData.html +++ b/docs/Next/interfaces/WriteConcernErrorData.html @@ -1,4 +1,4 @@ -WriteConcernErrorData | mongodb

    Interface WriteConcernErrorData

    interface WriteConcernErrorData {
        code: number;
        errInfo?: Document;
        errmsg: string;
    }

    Properties

    code +WriteConcernErrorData | mongodb

    Interface WriteConcernErrorData

    interface WriteConcernErrorData {
        code: number;
        errInfo?: Document;
        errmsg: string;
    }

    Properties

    code errInfo? errmsg -

    Properties

    code

    code: number

    OptionalerrInfo

    errInfo?: Document

    errmsg

    errmsg: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    code

    code: number

    OptionalerrInfo

    errInfo?: Document

    errmsg

    errmsg: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/interfaces/WriteConcernErrorResult.html b/docs/Next/interfaces/WriteConcernErrorResult.html index 8e45d2ad0e9..81a01a0a0e5 100644 --- a/docs/Next/interfaces/WriteConcernErrorResult.html +++ b/docs/Next/interfaces/WriteConcernErrorResult.html @@ -1,6 +1,6 @@ WriteConcernErrorResult | mongodb

    Interface WriteConcernErrorResult

    The type of the result property of MongoWriteConcernError

    -
    interface WriteConcernErrorResult {
        code?: number;
        errorLabels?: string[];
        ok: number;
        writeConcernError: {
            code: number;
            codeName?: string;
            errInfo?: Document;
            errmsg: string;
        };
        [x: string | number]: unknown;
    }

    Indexable

    • [x: string | number]: unknown

    Properties

    code? +
    interface WriteConcernErrorResult {
        code?: number;
        errorLabels?: string[];
        ok: number;
        writeConcernError: {
            code: number;
            codeName?: string;
            errInfo?: Document;
            errmsg: string;
        };
        [x: string | number]: unknown;
    }

    Indexable

    • [x: string | number]: unknown

    Properties

    code? errorLabels? ok writeConcernError -

    Properties

    Optionalcode

    code?: number

    OptionalerrorLabels

    errorLabels?: string[]

    ok

    ok: number

    writeConcernError

    writeConcernError: {
        code: number;
        codeName?: string;
        errInfo?: Document;
        errmsg: string;
    }

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalcode

    code?: number

    OptionalerrorLabels

    errorLabels?: string[]

    ok

    ok: number

    writeConcernError

    writeConcernError: {
        code: number;
        codeName?: string;
        errInfo?: Document;
        errmsg: string;
    }

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/Next/modules.html b/docs/Next/modules.html index bff91c79213..9f4dc829f84 100644 --- a/docs/Next/modules.html +++ b/docs/Next/modules.html @@ -30,6 +30,7 @@ MongoServerClosedError MongoServerError MongoServerSelectionError +MongoStalePrimaryError MongoSystemError MongoTailableCursorError MongoTopologyClosedError diff --git a/docs/Next/types/AnyBulkWriteOperation.html b/docs/Next/types/AnyBulkWriteOperation.html index 8a43a9fb5ee..8070c9156cf 100644 --- a/docs/Next/types/AnyBulkWriteOperation.html +++ b/docs/Next/types/AnyBulkWriteOperation.html @@ -1 +1 @@ -AnyBulkWriteOperation | mongodb

    Type Alias AnyBulkWriteOperation<TSchema>

    AnyBulkWriteOperation<TSchema>:
        | {
            insertOne: InsertOneModel<TSchema>;
        }
        | {
            replaceOne: ReplaceOneModel<TSchema>;
        }
        | {
            updateOne: UpdateOneModel<TSchema>;
        }
        | {
            updateMany: UpdateManyModel<TSchema>;
        }
        | {
            deleteOne: DeleteOneModel<TSchema>;
        }
        | {
            deleteMany: DeleteManyModel<TSchema>;
        }

    Type Parameters

    Settings

    Member Visibility
    +AnyBulkWriteOperation | mongodb

    Type Alias AnyBulkWriteOperation<TSchema>

    AnyBulkWriteOperation<TSchema>:
        | {
            insertOne: InsertOneModel<TSchema>;
        }
        | {
            replaceOne: ReplaceOneModel<TSchema>;
        }
        | {
            updateOne: UpdateOneModel<TSchema>;
        }
        | {
            updateMany: UpdateManyModel<TSchema>;
        }
        | {
            deleteOne: DeleteOneModel<TSchema>;
        }
        | {
            deleteMany: DeleteManyModel<TSchema>;
        }

    Type Parameters

    Settings

    Member Visibility
    diff --git a/docs/Next/types/BatchType.html b/docs/Next/types/BatchType.html index fffc2e92011..56a547f7933 100644 --- a/docs/Next/types/BatchType.html +++ b/docs/Next/types/BatchType.html @@ -1 +1 @@ -BatchType | mongodb

    Type Alias BatchType

    BatchType: typeof BatchType[keyof typeof BatchType]

    Settings

    Member Visibility
    +BatchType | mongodb

    Type Alias BatchType

    BatchType: typeof BatchType[keyof typeof BatchType]

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ChangeStreamDocument.html b/docs/Next/types/ChangeStreamDocument.html index 235303ea941..105a29ee832 100644 --- a/docs/Next/types/ChangeStreamDocument.html +++ b/docs/Next/types/ChangeStreamDocument.html @@ -1 +1 @@ -ChangeStreamDocument | mongodb

    Type Alias ChangeStreamDocument<TSchema>

    ChangeStreamDocument<TSchema>:
        | ChangeStreamInsertDocument<TSchema>
        | ChangeStreamUpdateDocument<TSchema>
        | ChangeStreamReplaceDocument<TSchema>
        | ChangeStreamDeleteDocument<TSchema>
        | ChangeStreamDropDocument
        | ChangeStreamRenameDocument
        | ChangeStreamDropDatabaseDocument
        | ChangeStreamInvalidateDocument
        | ChangeStreamCreateIndexDocument
        | ChangeStreamCreateDocument
        | ChangeStreamCollModDocument
        | ChangeStreamDropIndexDocument
        | ChangeStreamShardCollectionDocument
        | ChangeStreamReshardCollectionDocument
        | ChangeStreamRefineCollectionShardKeyDocument

    Type Parameters

    Settings

    Member Visibility
    +ChangeStreamDocument | mongodb

    Type Alias ChangeStreamDocument<TSchema>

    ChangeStreamDocument<TSchema>:
        | ChangeStreamInsertDocument<TSchema>
        | ChangeStreamUpdateDocument<TSchema>
        | ChangeStreamReplaceDocument<TSchema>
        | ChangeStreamDeleteDocument<TSchema>
        | ChangeStreamDropDocument
        | ChangeStreamRenameDocument
        | ChangeStreamDropDatabaseDocument
        | ChangeStreamInvalidateDocument
        | ChangeStreamCreateIndexDocument
        | ChangeStreamCreateDocument
        | ChangeStreamCollModDocument
        | ChangeStreamDropIndexDocument
        | ChangeStreamShardCollectionDocument
        | ChangeStreamReshardCollectionDocument
        | ChangeStreamRefineCollectionShardKeyDocument

    Type Parameters

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ChangeStreamEvents.html b/docs/Next/types/ChangeStreamEvents.html index 1c71d36a803..1a0fef70807 100644 --- a/docs/Next/types/ChangeStreamEvents.html +++ b/docs/Next/types/ChangeStreamEvents.html @@ -1,4 +1,4 @@ -ChangeStreamEvents | mongodb

    Type Alias ChangeStreamEvents<TSchema, TChange>

    ChangeStreamEvents<TSchema, TChange>: {
        change(change: TChange): void;
        close(): void;
        end(): void;
        error(error: Error): void;
        init(response: any): void;
        more(response?: any): void;
        response(): void;
        resumeTokenChanged(token: unknown): void;
    }

    Type Parameters

    Type declaration

    • change:function
    • close:function
      • close(): void

      • Returns void

        Remarks

        Note that the close event is currently emitted whenever the internal ChangeStreamCursor +ChangeStreamEvents | mongodb

        Type Alias ChangeStreamEvents<TSchema, TChange>

        ChangeStreamEvents<TSchema, TChange>: {
            change(change: TChange): void;
            close(): void;
            end(): void;
            error(error: Error): void;
            init(response: any): void;
            more(response?: any): void;
            response(): void;
            resumeTokenChanged(token: unknown): void;
        }

        Type Parameters

        Type declaration

        • change:function
        • close:function
          • close(): void

          • Returns void

            Remarks

            Note that the close event is currently emitted whenever the internal ChangeStreamCursor instance is closed, which can occur multiple times for a given ChangeStream instance.

            TODO(NODE-6434): address this issue in NODE-6434

            -
        • end:function
        • error:function
        • init:function
        • more:function
        • response:function
        • resumeTokenChanged:function

        Settings

        Member Visibility
        +
    • end:function
    • error:function
    • init:function
    • more:function
    • response:function
    • resumeTokenChanged:function

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ConnectionPoolEvents.html b/docs/Next/types/ConnectionPoolEvents.html index 361dea56016..d135d0e03fc 100644 --- a/docs/Next/types/ConnectionPoolEvents.html +++ b/docs/Next/types/ConnectionPoolEvents.html @@ -1 +1 @@ -ConnectionPoolEvents | mongodb

    Type Alias ConnectionPoolEvents

    ConnectionPoolEvents: {
        connectionCheckedIn(event: ConnectionCheckedInEvent): void;
        connectionCheckedOut(event: ConnectionCheckedOutEvent): void;
        connectionCheckOutFailed(event: ConnectionCheckOutFailedEvent): void;
        connectionCheckOutStarted(event: ConnectionCheckOutStartedEvent): void;
        connectionClosed(event: ConnectionClosedEvent): void;
        connectionCreated(event: ConnectionCreatedEvent): void;
        connectionPoolCleared(event: ConnectionPoolClearedEvent): void;
        connectionPoolClosed(event: ConnectionPoolClosedEvent): void;
        connectionPoolCreated(event: ConnectionPoolCreatedEvent): void;
        connectionPoolReady(event: ConnectionPoolReadyEvent): void;
        connectionReady(event: ConnectionReadyEvent): void;
    } & Omit<ConnectionEvents, "close" | "message">

    Settings

    Member Visibility
    +ConnectionPoolEvents | mongodb

    Type Alias ConnectionPoolEvents

    ConnectionPoolEvents: {
        connectionCheckedIn(event: ConnectionCheckedInEvent): void;
        connectionCheckedOut(event: ConnectionCheckedOutEvent): void;
        connectionCheckOutFailed(event: ConnectionCheckOutFailedEvent): void;
        connectionCheckOutStarted(event: ConnectionCheckOutStartedEvent): void;
        connectionClosed(event: ConnectionClosedEvent): void;
        connectionCreated(event: ConnectionCreatedEvent): void;
        connectionPoolCleared(event: ConnectionPoolClearedEvent): void;
        connectionPoolClosed(event: ConnectionPoolClosedEvent): void;
        connectionPoolCreated(event: ConnectionPoolCreatedEvent): void;
        connectionPoolReady(event: ConnectionPoolReadyEvent): void;
        connectionReady(event: ConnectionReadyEvent): void;
    } & Omit<ConnectionEvents, "close" | "message">

    Settings

    Member Visibility
    diff --git a/docs/Next/types/MongoErrorLabel.html b/docs/Next/types/MongoErrorLabel.html index 8ee6d0cafbf..f48e387b2c2 100644 --- a/docs/Next/types/MongoErrorLabel.html +++ b/docs/Next/types/MongoErrorLabel.html @@ -1 +1 @@ -MongoErrorLabel | mongodb

    Type Alias MongoErrorLabel

    MongoErrorLabel: typeof MongoErrorLabel[keyof typeof MongoErrorLabel]

    Settings

    Member Visibility
    +MongoErrorLabel | mongodb

    Type Alias MongoErrorLabel

    MongoErrorLabel: typeof MongoErrorLabel[keyof typeof MongoErrorLabel]

    Settings

    Member Visibility
    diff --git a/docs/Next/types/MonitorEvents.html b/docs/Next/types/MonitorEvents.html index d17e3a07e67..11ec47c1772 100644 --- a/docs/Next/types/MonitorEvents.html +++ b/docs/Next/types/MonitorEvents.html @@ -1 +1 @@ -MonitorEvents | mongodb

    Type Alias MonitorEvents

    MonitorEvents: {
        close(): void;
        resetConnectionPool(): void;
        resetServer(error?: MongoError): void;
        serverHeartbeatFailed(event: ServerHeartbeatFailedEvent): void;
        serverHeartbeatStarted(event: ServerHeartbeatStartedEvent): void;
        serverHeartbeatSucceeded(event: ServerHeartbeatSucceededEvent): void;
    } & EventEmitterWithState

    Settings

    Member Visibility
    +MonitorEvents | mongodb

    Type Alias MonitorEvents

    MonitorEvents: {
        close(): void;
        resetConnectionPool(): void;
        resetServer(error?: MongoError): void;
        serverHeartbeatFailed(event: ServerHeartbeatFailedEvent): void;
        serverHeartbeatStarted(event: ServerHeartbeatStartedEvent): void;
        serverHeartbeatSucceeded(event: ServerHeartbeatSucceededEvent): void;
    } & EventEmitterWithState

    Settings

    Member Visibility
    diff --git a/docs/Next/types/OperationTime.html b/docs/Next/types/OperationTime.html index 20dbb4bda89..a58b7b66b5f 100644 --- a/docs/Next/types/OperationTime.html +++ b/docs/Next/types/OperationTime.html @@ -1,3 +1,3 @@ OperationTime | mongodb

    Type Alias OperationTime

    OperationTime: Timestamp

    Represents a specific point in time on a server. Can be retrieved by using db.command()

    See

    https://www.mongodb.com/docs/manual/reference/method/db.runCommand/#response

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ResumeToken.html b/docs/Next/types/ResumeToken.html index 63821bccc07..3b1ebd8ee4e 100644 --- a/docs/Next/types/ResumeToken.html +++ b/docs/Next/types/ResumeToken.html @@ -1,3 +1,3 @@ ResumeToken | mongodb

    Type Alias ResumeToken

    ResumeToken: unknown

    Represents the logical starting point for a new ChangeStream or resuming a ChangeStream on the server.

    See

    https://www.mongodb.com/docs/manual/changeStreams/#std-label-change-stream-resume

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ServerEvents.html b/docs/Next/types/ServerEvents.html index fdb5194d612..f51b84eb60b 100644 --- a/docs/Next/types/ServerEvents.html +++ b/docs/Next/types/ServerEvents.html @@ -1 +1 @@ -ServerEvents | mongodb

    Type Alias ServerEvents

    ServerEvents: {
        closed(): void;
        descriptionReceived(description: ServerDescription): void;
        ended(): void;
        serverHeartbeatFailed(event: ServerHeartbeatFailedEvent): void;
        serverHeartbeatStarted(event: ServerHeartbeatStartedEvent): void;
        serverHeartbeatSucceeded(event: ServerHeartbeatSucceededEvent): void;
    } & ConnectionPoolEvents & EventEmitterWithState

    Settings

    Member Visibility
    +ServerEvents | mongodb

    Type Alias ServerEvents

    ServerEvents: {
        closed(): void;
        descriptionReceived(description: ServerDescription): void;
        ended(): void;
        serverHeartbeatFailed(event: ServerHeartbeatFailedEvent): void;
        serverHeartbeatStarted(event: ServerHeartbeatStartedEvent): void;
        serverHeartbeatSucceeded(event: ServerHeartbeatSucceededEvent): void;
    } & ConnectionPoolEvents & EventEmitterWithState

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ServerMonitoringMode.html b/docs/Next/types/ServerMonitoringMode.html index ea515e624e5..711ab733890 100644 --- a/docs/Next/types/ServerMonitoringMode.html +++ b/docs/Next/types/ServerMonitoringMode.html @@ -1 +1 @@ -ServerMonitoringMode | mongodb

    Type Alias ServerMonitoringMode

    ServerMonitoringMode: typeof ServerMonitoringMode[keyof typeof ServerMonitoringMode]

    Settings

    Member Visibility
    +ServerMonitoringMode | mongodb

    Type Alias ServerMonitoringMode

    ServerMonitoringMode: typeof ServerMonitoringMode[keyof typeof ServerMonitoringMode]

    Settings

    Member Visibility
    diff --git a/docs/Next/types/ServerSessionId.html b/docs/Next/types/ServerSessionId.html index c51d9c84ec7..ebab5d7d453 100644 --- a/docs/Next/types/ServerSessionId.html +++ b/docs/Next/types/ServerSessionId.html @@ -1 +1 @@ -ServerSessionId | mongodb

    Type Alias ServerSessionId

    ServerSessionId: {
        id: Binary;
    }

    Settings

    Member Visibility
    +ServerSessionId | mongodb

    Type Alias ServerSessionId

    ServerSessionId: {
        id: Binary;
    }

    Settings

    Member Visibility
    diff --git a/docs/Next/types/TopologyEvents.html b/docs/Next/types/TopologyEvents.html index 0ac8600835a..a25a438f4cc 100644 --- a/docs/Next/types/TopologyEvents.html +++ b/docs/Next/types/TopologyEvents.html @@ -1 +1 @@ -TopologyEvents | mongodb

    Type Alias TopologyEvents

    TopologyEvents: {
        close(): void;
        error(error: Error): void;
        serverClosed(event: ServerClosedEvent): void;
        serverDescriptionChanged(event: ServerDescriptionChangedEvent): void;
        serverOpening(event: ServerOpeningEvent): void;
        timeout(): void;
        topologyClosed(event: TopologyClosedEvent): void;
        topologyDescriptionChanged(event: TopologyDescriptionChangedEvent): void;
        topologyOpening(event: TopologyOpeningEvent): void;
    } & Omit<ServerEvents, "connect"> & ConnectionPoolEvents & ConnectionEvents & EventEmitterWithState

    Settings

    Member Visibility
    +TopologyEvents | mongodb

    Type Alias TopologyEvents

    TopologyEvents: {
        close(): void;
        error(error: Error): void;
        serverClosed(event: ServerClosedEvent): void;
        serverDescriptionChanged(event: ServerDescriptionChangedEvent): void;
        serverOpening(event: ServerOpeningEvent): void;
        timeout(): void;
        topologyClosed(event: TopologyClosedEvent): void;
        topologyDescriptionChanged(event: TopologyDescriptionChangedEvent): void;
        topologyOpening(event: TopologyOpeningEvent): void;
    } & Omit<ServerEvents, "connect"> & ConnectionPoolEvents & ConnectionEvents & EventEmitterWithState

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/BatchType-1.html b/docs/Next/variables/BatchType-1.html index 013e3a9af69..1ef3a4e7b56 100644 --- a/docs/Next/variables/BatchType-1.html +++ b/docs/Next/variables/BatchType-1.html @@ -1 +1 @@ -BatchType | mongodb

    Variable BatchTypeConst

    BatchType: Readonly<{
        DELETE: 3;
        INSERT: 1;
        UPDATE: 2;
    }> = ...

    Settings

    Member Visibility
    +BatchType | mongodb

    Variable BatchTypeConst

    BatchType: Readonly<{
        DELETE: 3;
        INSERT: 1;
        UPDATE: 2;
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/MongoErrorLabel-1.html b/docs/Next/variables/MongoErrorLabel-1.html index bde7f85cb7a..032e97330c0 100644 --- a/docs/Next/variables/MongoErrorLabel-1.html +++ b/docs/Next/variables/MongoErrorLabel-1.html @@ -1 +1 @@ -MongoErrorLabel | mongodb

    Variable MongoErrorLabelConst

    MongoErrorLabel: Readonly<{
        HandshakeError: "HandshakeError";
        InterruptInUseConnections: "InterruptInUseConnections";
        NoWritesPerformed: "NoWritesPerformed";
        PoolRequstedRetry: "PoolRequstedRetry";
        ResetPool: "ResetPool";
        ResumableChangeStreamError: "ResumableChangeStreamError";
        RetryableWriteError: "RetryableWriteError";
        TransientTransactionError: "TransientTransactionError";
        UnknownTransactionCommitResult: "UnknownTransactionCommitResult";
    }> = ...

    Settings

    Member Visibility
    +MongoErrorLabel | mongodb

    Variable MongoErrorLabelConst

    MongoErrorLabel: Readonly<{
        HandshakeError: "HandshakeError";
        InterruptInUseConnections: "InterruptInUseConnections";
        NoWritesPerformed: "NoWritesPerformed";
        PoolRequstedRetry: "PoolRequstedRetry";
        ResetPool: "ResetPool";
        ResumableChangeStreamError: "ResumableChangeStreamError";
        RetryableWriteError: "RetryableWriteError";
        TransientTransactionError: "TransientTransactionError";
        UnknownTransactionCommitResult: "UnknownTransactionCommitResult";
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/Next/variables/ServerMonitoringMode-1.html b/docs/Next/variables/ServerMonitoringMode-1.html index 768074f8352..6e38e482bba 100644 --- a/docs/Next/variables/ServerMonitoringMode-1.html +++ b/docs/Next/variables/ServerMonitoringMode-1.html @@ -1 +1 @@ -ServerMonitoringMode | mongodb

    Variable ServerMonitoringModeConst

    ServerMonitoringMode: Readonly<{
        auto: "auto";
        poll: "poll";
        stream: "stream";
    }> = ...

    Settings

    Member Visibility
    +ServerMonitoringMode | mongodb

    Variable ServerMonitoringModeConst

    ServerMonitoringMode: Readonly<{
        auto: "auto";
        poll: "poll";
        stream: "stream";
    }> = ...

    Settings

    Member Visibility
    diff --git a/docs/categories/index.xml b/docs/categories/index.xml index e8d6887ccb7..6f8338feed7 100644 --- a/docs/categories/index.xml +++ b/docs/categories/index.xml @@ -4,8 +4,7 @@ Categories on MongoDB Node.js Driver /node-mongodb-native/categories/ Recent content in Categories on MongoDB Node.js Driver - Hugo - en-us - + Hugo -- gohugo.io + en-us diff --git a/docs/index.html b/docs/index.html index 67d3d025578..3ce6b446274 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,23 +1,23 @@ - + - + MongoDB Node.js Driver - - - - - - + + + + + + @@ -27,8 +27,8 @@
    @@ -947,13 +947,13 @@

    Releases

    - - - - - - - + + + + + + +