ArmDataMigrationModelFactory.MongoDBCollectionInfo Method

Reference

Definition

Namespace:: Azure.ResourceManager.DataMigration.Models

Assembly:: Azure.ResourceManager.DataMigration.dll

Package:: Azure.ResourceManager.DataMigration v1.0.0-beta.4

Source:: ArmDataMigrationModelFactory.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Initializes a new instance of MongoDBCollectionInfo.

public static Azure.ResourceManager.DataMigration.Models.MongoDBCollectionInfo MongoDBCollectionInfo (long averageDocumentSize = 0, long dataSize = 0, long documentCount = 0, string name = default, string qualifiedName = default, string databaseName = default, bool isCapped = false, bool isSystemCollection = false, bool isView = false, Azure.ResourceManager.DataMigration.Models.MongoDBShardKeyInfo shardKey = default, bool supportsSharding = false, string viewOf = default);

static member MongoDBCollectionInfo : int64 * int64 * int64 * string * string * string * bool * bool * bool * Azure.ResourceManager.DataMigration.Models.MongoDBShardKeyInfo * bool * string -> Azure.ResourceManager.DataMigration.Models.MongoDBCollectionInfo

Public Shared Function MongoDBCollectionInfo (Optional averageDocumentSize As Long = 0, Optional dataSize As Long = 0, Optional documentCount As Long = 0, Optional name As String = Nothing, Optional qualifiedName As String = Nothing, Optional databaseName As String = Nothing, Optional isCapped As Boolean = false, Optional isSystemCollection As Boolean = false, Optional isView As Boolean = false, Optional shardKey As MongoDBShardKeyInfo = Nothing, Optional supportsSharding As Boolean = false, Optional viewOf As String = Nothing) As MongoDBCollectionInfo

Parameters

averageDocumentSize: Int64

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

dataSize: Int64

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

documentCount: Int64

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

name: String

The unqualified name of the database or collection.

qualifiedName: String

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

databaseName: String

The name of the database containing the collection.

isCapped: Boolean

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

isSystemCollection: Boolean

Whether the collection is system collection.

isView: Boolean

Whether the collection is a view of another collection.

shardKey: MongoDBShardKeyInfo

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

supportsSharding: Boolean

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

viewOf: String

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

Returns

MongoDBCollectionInfo

A new MongoDBCollectionInfo instance for mocking.

Exceptions

ArgumentNullException

name or qualifiedName is null.

Applies to

Share via