Type alias DatabaseDescription

DatabaseDescription: {
    id: string;
    isSystem: boolean;
    name: string;
    path: string;
    replicationFactor?: "satellite" | number;
    sharding?: "" | "flexible" | "single";
    writeConcern?: number;
}

Object describing a database.

See Database#get.

Type declaration

  • id: string

    Unique identifier of the database.

  • isSystem: boolean

    Whether the database is the system database.

  • name: string

    Name of the database.

  • path: string

    File system path of the database.

  • Optional replicationFactor?: "satellite" | number

    (Cluster only.) Default replication factor for new collections in this database.

  • Optional sharding?: "" | "flexible" | "single"

    (Cluster only.) The sharding method to use for new collections in the database.

  • Optional writeConcern?: number

    (Cluster only.) Default write concern for new collections created in this database.

Settings

Theme