MongoDbDatabaseInfo interface
Describes a database within a MongoDB data source
- Extends
Properties
| collections | A list of supported collections in a MongoDB database |
| supports |
Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. |
Inherited Properties
| average |
The average document size, or -1 if the average size is unknown |
| data |
The estimated total data size, in bytes, or -1 if the size is unknown. |
| document |
The estimated total number of documents, or -1 if the document count is unknown |
| name | The unqualified name of the database or collection |
| qualified |
The qualified name of the database or collection. For a collection, this is the database-qualified name. |
Property Details
collections
A list of supported collections in a MongoDB database
collections: MongoDbCollectionInfo[]Property Value
supportsSharding
Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary.
supportsSharding: booleanProperty Value
boolean
Inherited Property Details
averageDocumentSize
The average document size, or -1 if the average size is unknown
averageDocumentSize: numberProperty Value
number
Inherited From MongoDbObjectInfo.averageDocumentSize
dataSize
The estimated total data size, in bytes, or -1 if the size is unknown.
dataSize: numberProperty Value
number
Inherited From MongoDbObjectInfo.dataSize
documentCount
The estimated total number of documents, or -1 if the document count is unknown
documentCount: numberProperty Value
number
Inherited From MongoDbObjectInfo.documentCount
name
The unqualified name of the database or collection
name: stringProperty Value
string
Inherited From MongoDbObjectInfo.name
qualifiedName
The qualified name of the database or collection. For a collection, this is the database-qualified name.
qualifiedName: stringProperty Value
string
Inherited From MongoDbObjectInfo.qualifiedName