MongoDbCollectionInfoResponse

data class MongoDbCollectionInfoResponse(val averageDocumentSize: Double, val dataSize: Double, val databaseName: String, val documentCount: Double, val isCapped: Boolean, val isSystemCollection: Boolean, val isView: Boolean, val name: String, val qualifiedName: String, val shardKey: MongoDbShardKeyInfoResponse? = null, val supportsSharding: Boolean, val viewOf: String? = null)

Describes a supported collection within a MongoDB database

Constructors

Link copied to clipboard
constructor(averageDocumentSize: Double, dataSize: Double, databaseName: String, documentCount: Double, isCapped: Boolean, isSystemCollection: Boolean, isView: Boolean, name: String, qualifiedName: String, shardKey: MongoDbShardKeyInfoResponse? = null, supportsSharding: Boolean, viewOf: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

The name of the database containing the collection

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Whether the collection is system collection

Link copied to clipboard

Whether the collection is a view of another collection

Link copied to clipboard

The unqualified name of the database or collection

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val viewOf: String? = null

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