Share via


DataMigrationMongoDBCollectionInfo Class

Definition

Describes a supported collection within a MongoDB database.

public class DataMigrationMongoDBCollectionInfo : Azure.ResourceManager.DataMigration.Models.DataMigrationMongoDBObjectInfo, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.DataMigration.Models.DataMigrationMongoDBCollectionInfo>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.DataMigration.Models.DataMigrationMongoDBCollectionInfo>
type DataMigrationMongoDBCollectionInfo = class
    inherit DataMigrationMongoDBObjectInfo
    interface IJsonModel<DataMigrationMongoDBCollectionInfo>
    interface IPersistableModel<DataMigrationMongoDBCollectionInfo>
Public Class DataMigrationMongoDBCollectionInfo
Inherits DataMigrationMongoDBObjectInfo
Implements IJsonModel(Of DataMigrationMongoDBCollectionInfo), IPersistableModel(Of DataMigrationMongoDBCollectionInfo)
Inheritance
DataMigrationMongoDBCollectionInfo
Implements

Properties

AverageDocumentSize

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

(Inherited from DataMigrationMongoDBObjectInfo)
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 DataMigrationMongoDBObjectInfo)
DocumentCount

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

(Inherited from DataMigrationMongoDBObjectInfo)
IsCapped

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

IsShardingSupported

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

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 DataMigrationMongoDBObjectInfo)
QualifiedName

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

(Inherited from DataMigrationMongoDBObjectInfo)
ShardKey

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

ViewOf

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

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<DataMigrationMongoDBCollectionInfo>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<DataMigrationMongoDBCollectionInfo>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<DataMigrationMongoDBObjectInfo>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from DataMigrationMongoDBObjectInfo)
IJsonModel<DataMigrationMongoDBObjectInfo>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from DataMigrationMongoDBObjectInfo)
IPersistableModel<DataMigrationMongoDBCollectionInfo>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<DataMigrationMongoDBCollectionInfo>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<DataMigrationMongoDBCollectionInfo>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<DataMigrationMongoDBObjectInfo>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from DataMigrationMongoDBObjectInfo)
IPersistableModel<DataMigrationMongoDBObjectInfo>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from DataMigrationMongoDBObjectInfo)
IPersistableModel<DataMigrationMongoDBObjectInfo>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from DataMigrationMongoDBObjectInfo)

Applies to