Share via


MongoDBCollectionInfo Class

Definition

Describes a supported collection within a MongoDB database.

public class MongoDBCollectionInfo : Azure.ResourceManager.DataMigration.Models.MongoDBObjectInfo
type MongoDBCollectionInfo = class
    inherit MongoDBObjectInfo
Public Class MongoDBCollectionInfo
Inherits MongoDBObjectInfo
Inheritance
MongoDBCollectionInfo

Properties

AverageDocumentSize

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

(Inherited from MongoDBObjectInfo)
DatabaseName

The name of the database containing the collection.

DataSize

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

(Inherited from MongoDBObjectInfo)
DocumentCount

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

(Inherited from MongoDBObjectInfo)
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.

Name

The unqualified name of the database or collection.

(Inherited from MongoDBObjectInfo)
QualifiedName

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

(Inherited from MongoDBObjectInfo)
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.

Applies to