Interface DatabaseInformation

Schema for information about a database.

interface DatabaseInformation {
    cluster: DatabaseInformationCluster;
    committed_update_seq?: string;
    compact_running: boolean;
    compacted_seq?: string;
    db_name: string;
    disk_format_version: number;
    doc_count: number;
    doc_del_count: number;
    engine?: string;
    partitioned_indexes?: PartitionedIndexesInformation;
    props: DatabaseInformationProps;
    sizes: ContentInformationSizes;
    update_seq: string;
    uuid?: string;
}

Properties

cluster committed_update_seq? compact_running compacted_seq? db_name disk_format_version doc_count doc_del_count engine? partitioned_indexes? props sizes update_seq uuid?

Properties

cluster

cluster: DatabaseInformationCluster

Schema for database cluster information.

Optional committed_update_seq

committed_update_seq?: string

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

compact_running

compact_running: boolean

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

Optional compacted_seq

compacted_seq?: string

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

db_name

db_name: string

The name of the database.

disk_format_version

disk_format_version: number

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

doc_count

doc_count: number

A count of the documents in the specified database.

doc_del_count

doc_del_count: number

Number of deleted documents.

Optional engine

engine?: string

The engine used for the database.

Optional partitioned_indexes

partitioned_indexes?: PartitionedIndexesInformation

Information about database's partitioned indexes.

props

props: DatabaseInformationProps

Schema for database properties.

sizes

sizes: ContentInformationSizes

Schema for size information of content.

update_seq

update_seq: 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.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc