Share via


MongoDbCollectionInfo Class

Definition

Describes a supported collection within a MongoDB database

public class MongoDbCollectionInfo : Microsoft.Azure.Management.DataMigration.Models.MongoDbObjectInfo
type MongoDbCollectionInfo = class
    inherit MongoDbObjectInfo
Public Class MongoDbCollectionInfo
Inherits MongoDbObjectInfo
Inheritance
MongoDbCollectionInfo

Constructors

MongoDbCollectionInfo()

Initializes a new instance of the MongoDbCollectionInfo class.

MongoDbCollectionInfo(Int64, Int64, Int64, String, String, String, Boolean, Boolean, Boolean, Boolean, MongoDbShardKeyInfo, String)

Initializes a new instance of the MongoDbCollectionInfo class.

Properties

AverageDocumentSize

Gets or sets the average document size, or -1 if the average size is unknown

(Inherited from MongoDbObjectInfo)
DatabaseName

Gets or sets the name of the database containing the collection

DataSize

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

(Inherited from MongoDbObjectInfo)
DocumentCount

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

(Inherited from MongoDbObjectInfo)
IsCapped

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

IsSystemCollection

Gets or sets whether the collection is system collection

IsView

Gets or sets whether the collection is a view of another collection

Name

Gets or sets the unqualified name of the database or collection

(Inherited from MongoDbObjectInfo)
QualifiedName

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

(Inherited from MongoDbObjectInfo)
ShardKey

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

SupportsSharding

Gets or sets whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary.

ViewOf

Gets or sets the name of the collection that this is a view of, if IsView is true

Methods

Validate()

Validate the object.

Applies to