MongoDbProgress interface

Base class for MongoDB migration outputs

Properties

bytesCopied

The number of document bytes copied during the Copying stage

documentsCopied

The number of documents copied during the Copying stage

elapsedTime

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

errors

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

eventsPending

The number of oplog events awaiting replay

eventsReplayed

The number of oplog events replayed so far

lastEventTime

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

lastReplayTime

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

name

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.

qualifiedName

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

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

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

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

Property Details

bytesCopied

The number of document bytes copied during the Copying stage

bytesCopied: number

Property Value

number

documentsCopied

The number of documents copied during the Copying stage

documentsCopied: number

Property Value

number

elapsedTime

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

elapsedTime: string

Property Value

string

errors

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

errors: {[propertyName: string]: MongoDbError}

Property Value

{[propertyName: string]: MongoDbError}

eventsPending

The number of oplog events awaiting replay

eventsPending: number

Property Value

number

eventsReplayed

The number of oplog events replayed so far

eventsReplayed: number

Property Value

number

lastEventTime

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

lastEventTime?: Date

Property Value

Date

lastReplayTime

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

lastReplayTime?: Date

Property Value

Date

name

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.

name?: string

Property Value

string

qualifiedName

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.

qualifiedName?: string

Property Value

string

resultType

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

resultType: ResultType

Property Value

state

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

state: MongoDbMigrationState

Property Value

totalBytes

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

totalBytes: number

Property Value

number

totalDocuments

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

totalDocuments: number

Property Value

number