Db | mongodb

The Db class is a class that represents a MongoDB Database.

example

import { MongoClient } from 'mongodb';

interface Pet {
  name: string;
  kind: 'dog' | 'cat' | 'fish';
}

const client = new MongoClient('mongodb://localhost:27017');
const db = client.db();

// Create a collection that validates our union
await db.createCollection<Pet>('pets', {
  validator: { $expr: { $in: ['$kind', ['dog', 'cat', 'fish']] } }
})

Hierarchy

Constructors

constructor

new Db(client: MongoClient, databaseName: string, options?: DbOptions): Db

- Defined in src/db.ts:148
Creates a new Db instance

Parameters
- client: MongoClient
  
  The MongoClient for the database.
- databaseName: string
  
  The name of the database this instance represents.
- Optional options: DbOptions
  
  Optional settings for Db construction
Returns Db

Properties

Static SYSTEM_COMMAND_COLLECTION

SYSTEM_COMMAND_COLLECTION: string = CONSTANTS.SYSTEM_COMMAND_COLLECTION

Static SYSTEM_INDEX_COLLECTION

SYSTEM_INDEX_COLLECTION: string = CONSTANTS.SYSTEM_INDEX_COLLECTION

Static SYSTEM_JS_COLLECTION

SYSTEM_JS_COLLECTION: string = CONSTANTS.SYSTEM_JS_COLLECTION

Static SYSTEM_NAMESPACE_COLLECTION

SYSTEM_NAMESPACE_COLLECTION: string = CONSTANTS.SYSTEM_NAMESPACE_COLLECTION

Static SYSTEM_PROFILE_COLLECTION

SYSTEM_PROFILE_COLLECTION: string = CONSTANTS.SYSTEM_PROFILE_COLLECTION

Static SYSTEM_USER_COLLECTION

SYSTEM_USER_COLLECTION: string = CONSTANTS.SYSTEM_USER_COLLECTION

Accessors

bsonOptions

get bsonOptions(): BSONSerializeOptions

- Defined in src/db.ts:219
Returns BSONSerializeOptions

databaseName

get databaseName(): string

- Defined in src/db.ts:179
Returns string

logger

get logger(): Logger

- Defined in src/db.ts:782
Returns Logger

namespace

get namespace(): string

- Defined in src/db.ts:228
Returns string

options

get options(): undefined | DbOptions

- Defined in src/db.ts:184
Returns undefined | DbOptions

readConcern

get readConcern(): undefined | ReadConcern

- Defined in src/db.ts:203
Returns undefined | ReadConcern

readPreference

get readPreference(): ReadPreference

- Defined in src/db.ts:211
The current readPreference of the Db. If not explicitly defined for this Db, will be inherited from the parent MongoClient

Returns ReadPreference

secondaryOk

get secondaryOk(): boolean

- Defined in src/db.ts:199
Check if a secondary can be used (because the read preference is not set to primary)

Returns boolean

slaveOk

get slaveOk(): boolean

- Defined in src/db.ts:192
slaveOk specified

deprecated
Use secondaryOk instead

Returns boolean

writeConcern

get writeConcern(): undefined | WriteConcern

- Defined in src/db.ts:224
Returns undefined | WriteConcern

Methods

addUser

addUser(username: string): Promise<Document>
addUser(username: string, callback: Callback<Document>): void
addUser(username: string, password: string): Promise<Document>
addUser(username: string, password: string, callback: Callback<Document>): void
addUser(username: string, options: AddUserOptions): Promise<Document>
addUser(username: string, options: AddUserOptions, callback: Callback<Document>): void
addUser(username: string, password: string, options: AddUserOptions): Promise<Document>
addUser(username: string, password: string, options: AddUserOptions, callback: Callback<Document>): void

- Defined in src/db.ts:582
Add a user to the database

Parameters
- username: string
  
  The username for the new user
Returns Promise<Document>
- Defined in src/db.ts:584
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- username: string
- callback: Callback<Document>
Returns void
- Defined in src/db.ts:585
Parameters
- username: string
- password: string
Returns Promise<Document>
- Defined in src/db.ts:587
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- username: string
- password: string
- callback: Callback<Document>
Returns void
- Defined in src/db.ts:588
Parameters
- username: string
- options: AddUserOptions
Returns Promise<Document>
- Defined in src/db.ts:590
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- username: string
- options: AddUserOptions
- callback: Callback<Document>
Returns void
- Defined in src/db.ts:591
Parameters
- username: string
- password: string
- options: AddUserOptions
Returns Promise<Document>
- Defined in src/db.ts:593
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- username: string
- password: string
- options: AddUserOptions
- callback: Callback<Document>
Returns void

admin

admin(): Admin

- Defined in src/db.ts:329
Return the Admin db instance

Returns Admin

aggregate

aggregate<T>(pipeline?: Document[], options?: AggregateOptions): AggregationCursor<T>

- Defined in src/db.ts:306
Execute an aggregation framework pipeline against the database, needs MongoDB >= 3.6

Type parameters
- T: Document = Document
Parameters
- pipeline: Document[] = []
  
  An array of aggregation stages to be executed
- Optional options: AggregateOptions
  
  Optional settings for the command
Returns AggregationCursor<T>

collection

collection<TSchema>(name: string, options?: CollectionOptions): Collection<TSchema>

- Defined in src/db.ts:339
Returns a reference to a MongoDB Collection. If it does not exist it will be created implicitly.

Type parameters
- TSchema: Document = Document
Parameters
- name: string
  
  the collection name we wish to access.
- options: CollectionOptions = {}
Returns Collection<TSchema>
return the new Collection instance

collections

collections(): Promise<Collection<Document>[]>
collections(callback: Callback<Collection<Document>[]>): void
collections(options: ListCollectionsOptions): Promise<Collection<Document>[]>
collections(options: ListCollectionsOptions, callback: Callback<Collection<Document>[]>): void

- Defined in src/db.ts:517
Fetch all collections for the current db.

Returns Promise<Collection<Document>[]>
- Defined in src/db.ts:519
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- callback: Callback<Collection<Document>[]>
Returns void
- Defined in src/db.ts:520
Parameters
- options: ListCollectionsOptions
Returns Promise<Collection<Document>[]>
- Defined in src/db.ts:522
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- options: ListCollectionsOptions
- callback: Callback<Collection<Document>[]>
Returns void

command

command(command: Document): Promise<Document>
command(command: Document, callback: Callback<Document>): void
command(command: Document, options: CommandOperationOptions): Promise<Document>
command(command: Document, options: CommandOperationOptions, callback: Callback<Document>): void

- Defined in src/db.ts:279
Execute a command

remarks
This command does not inherit options from the MongoClient.

Parameters
- command: Document
  
  The command to run
Returns Promise<Document>
- Defined in src/db.ts:281
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- command: Document
- callback: Callback<Document>
Returns void
- Defined in src/db.ts:282
Parameters
- command: Document
- options: CommandOperationOptions
Returns Promise<Document>
- Defined in src/db.ts:284
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- command: Document
- options: CommandOperationOptions
- callback: Callback<Document>
Returns void

createCollection

createCollection<TSchema>(name: string, options?: CreateCollectionOptions): Promise<Collection<TSchema>>
createCollection<TSchema>(name: string, callback: Callback<Collection<TSchema>>): void
createCollection<TSchema>(name: string, options: undefined | CreateCollectionOptions, callback: Callback<Collection<TSchema>>): void

- Defined in src/db.ts:240
Create a new collection on a server with the specified options. Use this to create capped collections. More information about command options available at https://www.mongodb.com/docs/manual/reference/command/create/

Type parameters
- TSchema: Document = Document
Parameters
- name: string
  
  The name of the collection to create
- Optional options: CreateCollectionOptions
  
  Optional settings for the command
Returns Promise<Collection<TSchema>>
- Defined in src/db.ts:245
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Type parameters
- TSchema: Document = Document
Parameters
- name: string
- callback: Callback<Collection<TSchema>>
Returns void
- Defined in src/db.ts:250
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Type parameters
- TSchema: Document = Document
Parameters
- name: string
- options: undefined | CreateCollectionOptions
- callback: Callback<Collection<TSchema>>
Returns void

createIndex

createIndex(name: string, indexSpec: IndexSpecification): Promise<string>
createIndex(name: string, indexSpec: IndexSpecification, callback: Callback<string>): void
createIndex(name: string, indexSpec: IndexSpecification, options: CreateIndexesOptions): Promise<string>
createIndex(name: string, indexSpec: IndexSpecification, options: CreateIndexesOptions, callback: Callback<string>): void

- Defined in src/db.ts:544
Creates an index on the db and collection.

Parameters
- name: string
  
  Name of the collection to create the index on.
- indexSpec: IndexSpecification
  
  Specify the field to index, or an index specification
Returns Promise<string>
- Defined in src/db.ts:546
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- name: string
- indexSpec: IndexSpecification
- callback: Callback<string>
Returns void
- Defined in src/db.ts:547
Parameters
- name: string
- indexSpec: IndexSpecification
- options: CreateIndexesOptions
Returns Promise<string>
- Defined in src/db.ts:553
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- name: string
- indexSpec: IndexSpecification
- options: CreateIndexesOptions
- callback: Callback<string>
Returns void

dropCollection

dropCollection(name: string): Promise<boolean>
dropCollection(name: string, callback: Callback<boolean>): void
dropCollection(name: string, options: DropCollectionOptions): Promise<boolean>
dropCollection(name: string, options: DropCollectionOptions, callback: Callback<boolean>): void

- Defined in src/db.ts:466
Drop a collection from the database, removing it permanently. New accesses will create a new collection.

Parameters
- name: string
  
  Name of collection to drop
Returns Promise<boolean>
- Defined in src/db.ts:468
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- name: string
- callback: Callback<boolean>
Returns void
- Defined in src/db.ts:469
Parameters
- name: string
- options: DropCollectionOptions
Returns Promise<boolean>
- Defined in src/db.ts:471
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- name: string
- options: DropCollectionOptions
- callback: Callback<boolean>
Returns void

dropDatabase

dropDatabase(): Promise<boolean>
dropDatabase(callback: Callback<boolean>): void
dropDatabase(options: CommandOperationOptions): Promise<boolean>
dropDatabase(options: CommandOperationOptions, callback: Callback<boolean>): void

- Defined in src/db.ts:492
Drop a database, removing it permanently from the server.

Returns Promise<boolean>
- Defined in src/db.ts:494
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- callback: Callback<boolean>
Returns void
- Defined in src/db.ts:495
Parameters
- options: CommandOperationOptions
Returns Promise<boolean>
- Defined in src/db.ts:497
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- options: CommandOperationOptions
- callback: Callback<boolean>
Returns void

getLogger

getLogger(): Logger

- Defined in src/db.ts:778
Return the db logger

Returns Logger

indexInformation

indexInformation(name: string): Promise<Document>
indexInformation(name: string, callback: Callback<Document>): void
indexInformation(name: string, options: IndexInformationOptions): Promise<Document>
indexInformation(name: string, options: IndexInformationOptions, callback: Callback<Document>): void

- Defined in src/db.ts:717
Retrieves this collections index info.

Parameters
- name: string
  
  The name of the collection.
Returns Promise<Document>
- Defined in src/db.ts:719
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- name: string
- callback: Callback<Document>
Returns void
- Defined in src/db.ts:720
Parameters
- name: string
- options: IndexInformationOptions
Returns Promise<Document>
- Defined in src/db.ts:722
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- name: string
- options: IndexInformationOptions
- callback: Callback<Document>
Returns void

listCollections

listCollections(filter: Document, options: ListCollectionsOptions & { nameOnly: true }): ListCollectionsCursor<Pick<CollectionInfo, "type" | "name">>
listCollections(filter: Document, options: ListCollectionsOptions & { nameOnly: false }): ListCollectionsCursor<CollectionInfo>
listCollections<T>(filter?: Document, options?: ListCollectionsOptions): ListCollectionsCursor<T>

- Defined in src/db.ts:380
List all collections of this database with optional filter

Parameters
- filter: Document
  
  Query to filter collections by
- options: ListCollectionsOptions & { nameOnly: true }
  
  Optional settings for the command
Returns ListCollectionsCursor<Pick<CollectionInfo, "type" | "name">>
- Defined in src/db.ts:384
Parameters
- filter: Document
- options: ListCollectionsOptions & { nameOnly: false }
Returns ListCollectionsCursor<CollectionInfo>
- Defined in src/db.ts:388
Type parameters
- T: CollectionInfo | Pick<CollectionInfo, "type" | "name"> = CollectionInfo | Pick<CollectionInfo, "type" | "name">
Parameters
- Optional filter: Document
- Optional options: ListCollectionsOptions
Returns ListCollectionsCursor<T>

profilingLevel

profilingLevel(): Promise<string>
profilingLevel(callback: Callback<string>): void
profilingLevel(options: CommandOperationOptions): Promise<string>
profilingLevel(options: CommandOperationOptions, callback: Callback<string>): void

- Defined in src/db.ts:691
Retrieve the current profiling Level for MongoDB

Returns Promise<string>
- Defined in src/db.ts:693
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- callback: Callback<string>
Returns void
- Defined in src/db.ts:694
Parameters
- options: CommandOperationOptions
Returns Promise<string>
- Defined in src/db.ts:696
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- options: CommandOperationOptions
- callback: Callback<string>
Returns void

removeUser

removeUser(username: string): Promise<boolean>
removeUser(username: string, callback: Callback<boolean>): void
removeUser(username: string, options: CommandOperationOptions): Promise<boolean>
removeUser(username: string, options: CommandOperationOptions, callback: Callback<boolean>): void

- Defined in src/db.ts:631
Remove a user from a database

Parameters
- username: string
  
  The username to remove
Returns Promise<boolean>
- Defined in src/db.ts:633
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- username: string
- callback: Callback<boolean>
Returns void
- Defined in src/db.ts:634
Parameters
- username: string
- options: CommandOperationOptions
Returns Promise<boolean>
- Defined in src/db.ts:636
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- username: string
- options: CommandOperationOptions
- callback: Callback<boolean>
Returns void

renameCollection

renameCollection<TSchema>(fromCollection: string, toCollection: string): Promise<Collection<TSchema>>
renameCollection<TSchema>(fromCollection: string, toCollection: string, callback: Callback<Collection<TSchema>>): void
renameCollection<TSchema>(fromCollection: string, toCollection: string, options: RenameOptions): Promise<Collection<TSchema>>
renameCollection<TSchema>(fromCollection: string, toCollection: string, options: RenameOptions, callback: Callback<Collection<TSchema>>): void

- Defined in src/db.ts:412
Rename a collection.

remarks
This operation does not inherit options from the MongoClient.

Type parameters
- TSchema: Document = Document
Parameters
- fromCollection: string
  
  Name of current collection to rename
- toCollection: string
  
  New name of of the collection
Returns Promise<Collection<TSchema>>
- Defined in src/db.ts:417
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Type parameters
- TSchema: Document = Document
Parameters
- fromCollection: string
- toCollection: string
- callback: Callback<Collection<TSchema>>
Returns void
- Defined in src/db.ts:422
Type parameters
- TSchema: Document = Document
Parameters
- fromCollection: string
- toCollection: string
- options: RenameOptions
Returns Promise<Collection<TSchema>>
- Defined in src/db.ts:428
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Type parameters
- TSchema: Document = Document
Parameters
- fromCollection: string
- toCollection: string
- options: RenameOptions
- callback: Callback<Collection<TSchema>>
Returns void

setProfilingLevel

setProfilingLevel(level: ProfilingLevel): Promise<ProfilingLevel>
setProfilingLevel(level: ProfilingLevel, callback: Callback<ProfilingLevel>): void
setProfilingLevel(level: ProfilingLevel, options: CommandOperationOptions): Promise<ProfilingLevel>
setProfilingLevel(level: ProfilingLevel, options: CommandOperationOptions, callback: Callback<ProfilingLevel>): void

- Defined in src/db.ts:658
Set the current profiling level of MongoDB

Parameters
- level: ProfilingLevel
  
  The new profiling level (off, slow_only, all).
Returns Promise<ProfilingLevel>
- Defined in src/db.ts:660
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- level: ProfilingLevel
- callback: Callback<ProfilingLevel>
Returns void
- Defined in src/db.ts:661
Parameters
- level: ProfilingLevel
- options: CommandOperationOptions
Returns Promise<ProfilingLevel>
- Defined in src/db.ts:666
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- level: ProfilingLevel
- options: CommandOperationOptions
- callback: Callback<ProfilingLevel>
Returns void

stats

stats(): Promise<Document>
stats(callback: Callback<Document>): void
stats(options: DbStatsOptions): Promise<Document>
stats(options: DbStatsOptions, callback: Callback<Document>): void

- Defined in src/db.ts:356
Get all the db statistics.

Returns Promise<Document>
- Defined in src/db.ts:358
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- callback: Callback<Document>
Returns void
- Defined in src/db.ts:359
Parameters
- options: DbStatsOptions
Returns Promise<Document>
- Defined in src/db.ts:361
deprecated
Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

Parameters
- options: DbStatsOptions
- callback: Callback<Document>
Returns void

unref

unref(): void

- Defined in src/db.ts:745
Unref all sockets

deprecated
This function is deprecated and will be removed in the next major version.

Returns void

watch

watch<TSchema, TChange>(pipeline?: Document[], options?: ChangeStreamOptions): ChangeStream<TSchema, TChange>

- Defined in src/db.ts:764
Create a new Change Stream, watching for new changes (insertions, updates, replacements, deletions, and invalidations) in this database. Will ignore all changes to system collections.
remarks
watch() accepts two generic arguments for distinct usecases:
- The first is to provide the schema that may be defined for all the collections within this database
- The second is to override the shape of the change stream document entirely, if it is not provided the type will default to ChangeStreamDocument of the first argument
Type parameters
- TSchema: Document = Document
  
  Type of the data being detected by the change stream
- TChange: Document = ChangeStreamDocument<TSchema>
  
  Type of the whole change stream document emitted
Parameters
- pipeline: Document[] = []
  
  An array of aggregation pipeline stages through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents.
- options: ChangeStreamOptions = {}
  
  Optional settings for the command
Returns ChangeStream<TSchema, TChange>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

client: MongoClient

databaseName: string

Optional options: DbOptions

Returns Db

Properties

Static SYSTEM_COMMAND_COLLECTION

Static SYSTEM_INDEX_COLLECTION

Static SYSTEM_JS_COLLECTION

Static SYSTEM_NAMESPACE_COLLECTION

Static SYSTEM_PROFILE_COLLECTION

Static SYSTEM_USER_COLLECTION

Accessors

bsonOptions

Returns BSONSerializeOptions

databaseName

Returns string

logger

Returns Logger

namespace

Returns string

options

Returns undefined | DbOptions

readConcern

Returns undefined | ReadConcern

readPreference

Returns ReadPreference

secondaryOk

Returns boolean

slaveOk

Returns boolean

writeConcern

Returns undefined | WriteConcern

Methods

addUser

Parameters

username: string

Returns Promise<Document>

Parameters

username: string

callback: Callback<Document>

Returns void

Parameters

username: string

password: string

Returns Promise<Document>

Parameters

username: string

password: string

callback: Callback<Document>

Returns void

Parameters

username: string

options: AddUserOptions

Returns Promise<Document>

Parameters

username: string

options: AddUserOptions

callback: Callback<Document>

Returns void

Parameters

username: string

password: string

options: AddUserOptions

Returns Promise<Document>

Parameters

username: string

password: string

options: AddUserOptions

callback: Callback<Document>

Returns void

admin