MongoDbCollectionInfo interface
Описание поддерживаемой коллекции в базе данных MongoDB
- Extends
Свойства
database |
Имя базы данных, содержащей коллекцию. |
is |
Является ли коллекция ограниченной коллекцией (т. е. имеет ли она фиксированный размер и действует ли она как циклический буфер) |
is |
Является ли коллекция системной коллекцией |
is |
Указывает, является ли коллекция представлением другой коллекции |
shard |
Ключ сегмента в коллекции или значение NULL, если коллекция не сегментирована. |
supports |
Включена ли в базе данных сегментирование. Обратите внимание, что задача миграции при необходимости включает сегментирование на целевом объекте. |
view |
Имя коллекции, которая является представлением, если IsView имеет значение true. |
Унаследованные свойства
average |
Средний размер документа или -1, если средний размер неизвестен |
data |
Предполагаемый общий размер данных в байтах или -1, если размер неизвестен. |
document |
Предполагаемое общее количество документов или -1, если число документов неизвестно |
name | Неквалифицированное имя базы данных или коллекции |
qualified |
Полное имя базы данных или коллекции. Для коллекции это имя, полное базы данных. |
Сведения о свойстве
databaseName
Имя базы данных, содержащей коллекцию.
databaseName: string
Значение свойства
string
isCapped
Является ли коллекция ограниченной коллекцией (т. е. имеет ли она фиксированный размер и действует ли она как циклический буфер)
isCapped: boolean
Значение свойства
boolean
isSystemCollection
Является ли коллекция системной коллекцией
isSystemCollection: boolean
Значение свойства
boolean
isView
Указывает, является ли коллекция представлением другой коллекции
isView: boolean
Значение свойства
boolean
shardKey
Ключ сегмента в коллекции или значение NULL, если коллекция не сегментирована.
shardKey?: MongoDbShardKeyInfo
Значение свойства
supportsSharding
Включена ли в базе данных сегментирование. Обратите внимание, что задача миграции при необходимости включает сегментирование на целевом объекте.
supportsSharding: boolean
Значение свойства
boolean
viewOf
Имя коллекции, которая является представлением, если IsView имеет значение true.
viewOf?: string
Значение свойства
string
Сведения об унаследованном свойстве
averageDocumentSize
Средний размер документа или -1, если средний размер неизвестен
averageDocumentSize: number
Значение свойства
number
Наследуется отMongoDbObjectInfo.averageDocumentSize
dataSize
Предполагаемый общий размер данных в байтах или -1, если размер неизвестен.
dataSize: number
Значение свойства
number
Наследуется отMongoDbObjectInfo.dataSize
documentCount
Предполагаемое общее количество документов или -1, если число документов неизвестно
documentCount: number
Значение свойства
number
Наследуется отMongoDbObjectInfo.documentCount
name
Неквалифицированное имя базы данных или коллекции
name: string
Значение свойства
string
Наследуетсяот MongoDbObjectInfo.name
qualifiedName
Полное имя базы данных или коллекции. Для коллекции это имя, полное базы данных.
qualifiedName: string
Значение свойства
string
Наследуется отMongoDbObjectInfo.qualifiedName