@ibm-cloud/cloudant - v0.12.5
    Preparing search index...

    Class DatabaseInformation

    Schema for information about a database.

    Index

    Constructors

    constructor

    Properties

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

    Methods

    deserialize serialize

    Constructors

    Properties

    cluster: CloudantV1.DatabaseInformationCluster

    Schema for database cluster information.

    committedUpdateSeq?: string

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

    compactedSeq?: string

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

    compactRunning: boolean

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

    dbName: string

    Schema for a database name.

    diskFormatVersion: number

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

    docCount: number

    A count of the documents in the specified database.

    docDelCount: number

    Number of deleted documents.

    engine?: string

    The engine used for the database.

    instanceStartTime: string

    An opaque string to detect whether a database has been recreated. The field name is for compatibility with old replicator versions. Do not use the value to infer timing infromation. Typically only used by replicators.

    partitionedIndexes?: CloudantV1.PartitionedIndexesInformation

    Information about database's partitioned indexes.

    props: CloudantV1.DatabaseInformationProps

    Schema for database properties.

    sizes: CloudantV1.ContentInformationSizes

    Schema for size information of content.

    updateSeq: string

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

    uuid?: string

    The UUID of the database.

    Methods

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods