Class DatabaseInformation

Schema for information about a database.

Constructors

constructor

Properties

cluster committedUpdateSeq? compactRunning compactedSeq? dbName diskFormatVersion docCount docDelCount engine? partitionedIndexes? props sizes updateSeq uuid?

Methods

deserialize serialize

Constructors

constructor

Properties

cluster

cluster: DatabaseInformationCluster

Schema for database cluster information.

Optional committedUpdateSeq

committedUpdateSeq?: string

An opaque string that describes the committed state of the database.

compactRunning

compactRunning: boolean

True if the database compaction routine is operating on this database.

Optional compactedSeq

compactedSeq?: string

An opaque string that describes the compaction state of the database.

dbName

dbName: string

The name of the database.

diskFormatVersion

diskFormatVersion: number

The version of the physical format used for the data when it is stored on disk.

docCount

docCount: number

A count of the documents in the specified database.

docDelCount

docDelCount: number

Number of deleted documents.

Optional engine

engine?: string

The engine used for the database.

Optional partitionedIndexes

partitionedIndexes?: PartitionedIndexesInformation

Information about database's partitioned indexes.

props

props: DatabaseInformationProps

Schema for database properties.

sizes

sizes: ContentInformationSizes

Schema for size information of content.

updateSeq

updateSeq: string

An opaque string that describes the state of the database. Do not rely on this string for counting the number of updates.

Optional uuid

uuid?: string

The UUID of the database.

Methods

Static deserialize

Static serialize

Settings

Member Visibility

Theme

On This Page

constructorclustercommittedUpdateSeqcompactRunningcompactedSeqdbNamediskFormatVersiondocCountdocDelCountenginepartitionedIndexespropssizesupdateSequuiddeserializeserialize