Share via

MongoDbCollectionInfo interface

Package:
@azure/arm-datamigration

Describes a supported collection within a MongoDB database

Extends
MongoDbObjectInfo

Properties

databaseName

The name of the database containing the collection
isCapped

Whether the collection is a capped collection (i.e. whether it has a fixed size and acts like a circular buffer)
isSystemCollection

Whether the collection is system collection
isView

Whether the collection is a view of another collection
shardKey

The shard key on the collection, or null if the collection is not sharded
supportsSharding

Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary.
viewOf

The name of the collection that this is a view of, if IsView is true

Inherited Properties

averageDocumentSize

The average document size, or -1 if the average size is unknown
dataSize

The estimated total data size, in bytes, or -1 if the size is unknown.
documentCount

The estimated total number of documents, or -1 if the document count is unknown
name

The unqualified name of the database or collection
qualifiedName

The qualified name of the database or collection. For a collection, this is the database-qualified name.

Property Details

databaseName

The name of the database containing the collection

databaseName: string

Property Value

string

isCapped

Whether the collection is a capped collection (i.e. whether it has a fixed size and acts like a circular buffer)

isCapped: boolean

Property Value

boolean

isSystemCollection

Whether the collection is system collection

isSystemCollection: boolean

Property Value

boolean

isView

Whether the collection is a view of another collection

isView: boolean

Property Value

boolean

shardKey

The shard key on the collection, or null if the collection is not sharded

shardKey?: MongoDbShardKeyInfo

Property Value

MongoDbShardKeyInfo

supportsSharding

Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary.

supportsSharding: boolean

Property Value

boolean

viewOf

The name of the collection that this is a view of, if IsView is true

viewOf?: string

Property Value

string

Inherited Property Details

averageDocumentSize

The average document size, or -1 if the average size is unknown

averageDocumentSize: number

Property Value

number

Inherited From MongoDbObjectInfo.averageDocumentSize

dataSize

The estimated total data size, in bytes, or -1 if the size is unknown.

dataSize: number

Property Value

number

Inherited From MongoDbObjectInfo.dataSize

documentCount

The estimated total number of documents, or -1 if the document count is unknown

documentCount: number

Property Value

number

Inherited From MongoDbObjectInfo.documentCount

name

The unqualified name of the database or collection

name: string

Property 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: string

Property Value

string

Inherited From MongoDbObjectInfo.qualifiedName