MongoDbCollectionProgress interface
Describes the progress of a collection
- Extends
Inherited Properties
| bytes |
The number of document bytes copied during the Copying stage |
| documents |
The number of documents copied during the Copying stage |
| elapsed |
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. |
| events |
The number of oplog events awaiting replay |
| events |
The number of oplog events replayed so far |
| last |
The timestamp of the last oplog event received, or null if no oplog event has been received yet |
| last |
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. |
| qualified |
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. |
| result |
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' |
| total |
The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown |
| total |
The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown |
Inherited Property Details
bytesCopied
The number of document bytes copied during the Copying stage
bytesCopied: numberProperty Value
number
Inherited From MongoDbProgress.bytesCopied
documentsCopied
The number of documents copied during the Copying stage
documentsCopied: numberProperty Value
number
Inherited From MongoDbProgress.documentsCopied
elapsedTime
The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format)
elapsedTime: stringProperty 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: numberProperty Value
number
Inherited From MongoDbProgress.eventsPending
eventsReplayed
The number of oplog events replayed so far
eventsReplayed: numberProperty 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?: DateProperty 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?: DateProperty 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?: stringProperty 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?: stringProperty Value
string
Inherited From MongoDbProgress.qualifiedName
resultType
The type of progress object. Possible values include: 'Migration', 'Database', 'Collection'
resultType: ResultTypeProperty Value
Inherited From MongoDbProgress.resultType
state
Possible values include: 'NotStarted', 'ValidatingInput', 'Initializing', 'Restarting', 'Copying', 'InitialReplay', 'Replaying', 'Finalizing', 'Complete', 'Canceled', 'Failed'
state: MongoDbMigrationStateProperty Value
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: numberProperty 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: numberProperty Value
number
Inherited From MongoDbProgress.totalDocuments