Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MongoDbCollectionProgress

Package version

Describes the progress of a collection

Hierarchy

Index

Properties

bytesCopied

bytesCopied: number

The number of document bytes copied during the Copying stage

documentsCopied

documentsCopied: number

The number of documents copied during the Copying stage

elapsedTime

elapsedTime: string

The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format)

errors

errors: object

The errors and warnings that have occurred for the current object. The keys are the error codes.

Type declaration

eventsPending

eventsPending: number

The number of oplog events awaiting replay

eventsReplayed

eventsReplayed: number

The number of oplog events replayed so far

Optional lastEventTime

lastEventTime: Date

The timestamp of the last oplog event received, or null if no oplog event has been received yet

Optional lastReplayTime

lastReplayTime: Date

The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet

Optional name

name: undefined | string

The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null.

Optional qualifiedName

qualifiedName: undefined | string

The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null.

resultType

resultType: ResultType

The type of progress object. Possible values include: 'Migration', 'Database', 'Collection'

state

Possible values include: 'NotStarted', 'ValidatingInput', 'Initializing', 'Restarting', 'Copying', 'InitialReplay', 'Replaying', 'Finalizing', 'Complete', 'Canceled', 'Failed'

totalBytes

totalBytes: number

The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown

totalDocuments

totalDocuments: number

The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown

Generated using TypeDoc