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:141
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:202
Returns BSONSerializeOptions

databaseName

get databaseName(): string

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

namespace

get namespace(): string

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

options

get options(): undefined | DbOptions

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

readConcern

get readConcern(): undefined | ReadConcern

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

readPreference

get readPreference(): ReadPreference

- Defined in src/db.ts:194
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:182
Check if a secondary can be used (because the read preference is not set to primary)

Returns boolean

writeConcern

get writeConcern(): undefined | WriteConcern

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

Methods

addUser

addUser(username: string, passwordOrOptions?: string | AddUserOptions, options?: AddUserOptions): Promise<Document>

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

deprecated
Use the createUser command in db.command() instead.

see
https://www.mongodb.com/docs/manual/reference/command/createUser/

Parameters
- username: string
  
  The username for the new user
- Optional passwordOrOptions: string | AddUserOptions
  
  An optional password for the new user, or the options for the command
- Optional options: AddUserOptions
  
  Optional settings for the command
Returns Promise<Document>

admin

admin(): Admin

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

Returns Admin

aggregate

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

- Defined in src/db.ts:268
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:291
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(options?: ListCollectionsOptions): Promise<Collection<Document>[]>

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

Parameters
- Optional options: ListCollectionsOptions
  
  Optional settings for the command
Returns Promise<Collection<Document>[]>

command

command(command: Document, options?: RunCommandOptions): Promise<Document>

- Defined in src/db.ts:257
Execute a command
remarks
This command does not inherit options from the MongoClient.

The driver will ensure the following fields are attached to the command sent to the server:
- lsid - sourced from an implicit session or options.session
- $readPreference - defaults to primary or can be configured by options.readPreference
- $db - sourced from the name of this database
If the client has a serverApi setting:
- apiVersion
- apiStrict
- apiDeprecationErrors
When in a transaction:
- readConcern - sourced from readConcern set on the TransactionOptions
- writeConcern - sourced from writeConcern set on the TransactionOptions
Attaching any of the above fields to the command will have no effect as the driver will overwrite the value.
Parameters
- command: Document
  
  The command to run
- Optional options: RunCommandOptions
  
  Optional settings for the command
Returns Promise<Document>

createCollection

createCollection<TSchema>(name: string, options?: CreateCollectionOptions): Promise<Collection<TSchema>>

- Defined in src/db.ts:222
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>>

createIndex

createIndex(name: string, indexSpec: IndexSpecification, options?: CreateIndexesOptions): Promise<string>

- Defined in src/db.ts:407
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
- Optional options: CreateIndexesOptions
  
  Optional settings for the command
Returns Promise<string>

dropCollection

dropCollection(name: string, options?: DropCollectionOptions): Promise<boolean>

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

Parameters
- name: string
  
  Name of collection to drop
- Optional options: DropCollectionOptions
  
  Optional settings for the command
Returns Promise<boolean>

dropDatabase

dropDatabase(options?: CommandOperationOptions): Promise<boolean>

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

Parameters
- Optional options: CommandOperationOptions
  
  Optional settings for the command
Returns Promise<boolean>

indexInformation

indexInformation(name: string, options?: IndexInformationOptions): Promise<Document>

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

Parameters
- name: string
  
  The name of the collection.
- Optional options: IndexInformationOptions
  
  Optional settings for the command
Returns Promise<Document>

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:316
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:320
Parameters
- filter: Document
- options: ListCollectionsOptions & { nameOnly: false }
Returns ListCollectionsCursor<CollectionInfo>
- Defined in src/db.ts:324
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(options?: CommandOperationOptions): Promise<string>

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

Parameters
- Optional options: CommandOperationOptions
  
  Optional settings for the command
Returns Promise<string>

removeUser

removeUser(username: string, options?: CommandOperationOptions): Promise<boolean>

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

Parameters
- username: string
  
  The username to remove
- Optional options: CommandOperationOptions
  
  Optional settings for the command
Returns Promise<boolean>

renameCollection

renameCollection<TSchema>(fromCollection: string, toCollection: string, options?: RenameOptions): Promise<Collection<TSchema>>

- Defined in src/db.ts:347
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
- Optional options: RenameOptions
  
  Optional settings for the command
Returns Promise<Collection<TSchema>>

runCursorCommand

runCursorCommand(command: Document, options?: RunCursorCommandOptions): RunCommandCursor

- Defined in src/db.ts:536
A low level cursor API providing basic driver functionality:
- ClientSession management
- ReadPreference for server selection
- Running getMores automatically when a local batch is exhausted
Parameters
- command: Document
  
  The command that will start a cursor on the server.
- Optional options: RunCursorCommandOptions
  
  Configurations for running the command, bson options will apply to getMores
Returns RunCommandCursor

setProfilingLevel

setProfilingLevel(level: ProfilingLevel, options?: CommandOperationOptions): Promise<ProfilingLevel>

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

Parameters
- level: ProfilingLevel
  
  The new profiling level (off, slow_only, all).
- Optional options: CommandOperationOptions
  
  Optional settings for the command
Returns Promise<ProfilingLevel>

stats

stats(options?: DbStatsOptions): Promise<Document>

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

Parameters
- Optional options: DbStatsOptions
  
  Optional settings for the command
Returns Promise<Document>

watch

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

- Defined in src/db.ts:514
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 use cases:
- 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

namespace

Returns string

options

Returns undefined | DbOptions

readConcern

Returns undefined | ReadConcern

readPreference

Returns ReadPreference

secondaryOk

Returns boolean

writeConcern

Returns undefined | WriteConcern

Methods

addUser

Parameters

username: string

Optional passwordOrOptions: string | AddUserOptions

Optional options: AddUserOptions

Returns Promise<Document>

admin

Returns Admin

aggregate

Type parameters

T: Document = Document

Parameters

pipeline: Document[] = []

Optional options: AggregateOptions

Returns AggregationCursor<T>

collection

Type parameters

TSchema: Document = Document

Parameters

name: string

options: CollectionOptions = {}

Returns Collection<TSchema>

collections

Parameters

Optional options: ListCollectionsOptions

Returns Promise<Collection<Document>[]>

command

Parameters

command: Document

Optional options: RunCommandOptions

Returns Promise<Document>

createCollection

Type parameters

TSchema: Document = Document

Parameters

name: string

Optional options: CreateCollectionOptions

Returns Promise<Collection<TSchema>>

createIndex

Parameters

name: string

indexSpec: IndexSpecification