Share via

MongoDbMigrationProgress interface

  • Reference
Package:
@azure/arm-datamigration

Describes the progress of the overall migration

Extends
MongoDbProgress

Properties

databases

The progress of the databases in the migration. The keys are the names of the databases

Inherited 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

databases

The progress of the databases in the migration. The keys are the names of the databases

databases?: {[propertyName: string]: MongoDbDatabaseProgress}

Property Value

{[propertyName: string]: MongoDbDatabaseProgress}

Inherited Property Details

bytesCopied

The number of document bytes copied during the Copying stage

bytesCopied: number

Property Value

number

Inherited From MongoDbProgress.bytesCopied

documentsCopied

The number of documents copied during the Copying stage

documentsCopied: number

Property Value

number

Inherited From MongoDbProgress.documentsCopied

elapsedTime

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

elapsedTime: string

Property Value

string

Inherited From MongoDbProgress.elapsedTime

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}

Inherited From MongoDbProgress.errors

eventsPending

The number of oplog events awaiting replay

eventsPending: number

Property Value

number

Inherited From MongoDbProgress.eventsPending

eventsReplayed

The number of oplog events replayed so far

eventsReplayed: number

Property Value

number

Inherited From MongoDbProgress.eventsReplayed

lastEventTime

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

lastEventTime?: Date

Property Value

Date

Inherited From MongoDbProgress.lastEventTime

lastReplayTime

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

lastReplayTime?: Date

Property Value

Date

Inherited From MongoDbProgress.lastReplayTime

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

Inherited From MongoDbProgress.name

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

Inherited From MongoDbProgress.qualifiedName

resultType

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

resultType: ResultType

Property Value

ResultType

Inherited From MongoDbProgress.resultType

state

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

state: MongoDbMigrationState

Property Value

MongoDbMigrationState

Inherited From MongoDbProgress.state

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

Inherited From MongoDbProgress.totalBytes

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

Inherited From MongoDbProgress.totalDocuments