Db | mongodb

example

const { MongoClient } = require('mongodb');
// Connection url
const url = 'mongodb://localhost:27017';
// Database Name
const dbName = 'test';
// Connect using MongoClient
MongoClient.connect(url, function(err, client) {
  // Select the database by name
  const testDb = client.db(dbName);
  client.close();
});

Hierarchy

Constructors

constructor

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

- Defined in src/db.ts:145
Parameters
- client: MongoClient
- databaseName: string
- Optional options: DbOptions
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:216
Returns BSONSerializeOptions

databaseName

get databaseName(): string

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

logger

get logger(): Logger

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

namespace

get namespace(): string

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

options

get options(): undefined | DbOptions

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

readConcern

get readConcern(): undefined | ReadConcern

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

readPreference

get readPreference(): ReadPreference

- Defined in src/db.ts:208
Returns ReadPreference

secondaryOk

get secondaryOk(): boolean

- Defined in src/db.ts:196
Returns boolean

slaveOk

get slaveOk(): boolean

- Defined in src/db.ts:189
deprecated
Use secondaryOk instead
Returns boolean

writeConcern

get writeConcern(): undefined | WriteConcern

- Defined in src/db.ts:221
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:563
Parameters
- username: string
Returns Promise<Document>
- Defined in src/db.ts:564
Parameters
- username: string
- callback: Callback<Document>
Returns void
- Defined in src/db.ts:565
Parameters
- username: string
- password: string
Returns Promise<Document>
- Defined in src/db.ts:566
Parameters
- username: string
- password: string
- callback: Callback<Document>
Returns void
- Defined in src/db.ts:567
Parameters
- username: string
- options: AddUserOptions
Returns Promise<Document>
- Defined in src/db.ts:568
Parameters
- username: string
- options: AddUserOptions
- callback: Callback<Document>
Returns void
- Defined in src/db.ts:569
Parameters
- username: string
- password: string
- options: AddUserOptions
Returns Promise<Document>
- Defined in src/db.ts:570
Parameters
- username: string
- password: string
- options: AddUserOptions
- callback: Callback<Document>
Returns void

admin

admin(): Admin

- Defined in src/db.ts:322
Returns Admin

aggregate

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

- Defined in src/db.ts:299
Type parameters
- T: Document = Document
Parameters
- pipeline: Document[] = []
- Optional options: AggregateOptions
Returns AggregationCursor<T>

collection

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

- Defined in src/db.ts:332
Type parameters
- TSchema: Document = Document
Parameters
- name: string
- 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:502
Returns Promise<Collection<Document>[]>
- Defined in src/db.ts:503
Parameters
- callback: Callback<Collection<Document>[]>
Returns void
- Defined in src/db.ts:504
Parameters
- options: ListCollectionsOptions
Returns Promise<Collection<Document>[]>
- Defined in src/db.ts:505
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:274
remarks
This command does not inherit options from the MongoClient.
Parameters
- command: Document
Returns Promise<Document>
- Defined in src/db.ts:275
Parameters
- command: Document
- callback: Callback<Document>
Returns void
- Defined in src/db.ts:276
Parameters
- command: Document
- options: CommandOperationOptions
Returns Promise<Document>
- Defined in src/db.ts:277
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:237
Type parameters
- TSchema: Document = Document
Parameters
- name: string
- Optional options: CreateCollectionOptions
Returns Promise<Collection<TSchema>>
- Defined in src/db.ts:241
Type parameters
- TSchema: Document = Document
Parameters
- name: string
- callback: Callback<Collection<TSchema>>
Returns void
- Defined in src/db.ts:245
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:527
Parameters
- name: string
- indexSpec: IndexSpecification
Returns Promise<string>
- Defined in src/db.ts:528
Parameters
- name: string
- indexSpec: IndexSpecification
- Optional callback: Callback<string>
Returns void
- Defined in src/db.ts:529
Parameters
- name: string
- indexSpec: IndexSpecification
- options: CreateIndexesOptions
Returns Promise<string>
- Defined in src/db.ts:534
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:455
Parameters
- name: string
Returns Promise<boolean>
- Defined in src/db.ts:456
Parameters
- name: string
- callback: Callback<boolean>
Returns void
- Defined in src/db.ts:457
Parameters
- name: string
- options: DropCollectionOptions
Returns Promise<boolean>
- Defined in src/db.ts:458
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:479
Returns Promise<boolean>
- Defined in src/db.ts:480
Parameters
- callback: Callback<boolean>
Returns void
- Defined in src/db.ts:481
Parameters
- options: CommandOperationOptions
Returns Promise<boolean>
- Defined in src/db.ts:482
Parameters
- options: CommandOperationOptions
- callback: Callback<boolean>
Returns void

getLogger

getLogger(): Logger

- Defined in src/db.ts:747
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:688
Parameters
- name: string
Returns Promise<Document>
- Defined in src/db.ts:689
Parameters
- name: string
- callback: Callback<Document>
Returns void
- Defined in src/db.ts:690
Parameters
- name: string
- options: IndexInformationOptions
Returns Promise<Document>
- Defined in src/db.ts:691
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:371
Parameters
- filter: Document
- options: ListCollectionsOptions & { nameOnly: true }
Returns ListCollectionsCursor<Pick<CollectionInfo, "type" | "name">>
- Defined in src/db.ts:375
Parameters
- filter: Document
- options: ListCollectionsOptions & { nameOnly: false }
Returns ListCollectionsCursor<CollectionInfo>
- Defined in src/db.ts:379
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:664
Returns Promise<string>
- Defined in src/db.ts:665
Parameters
- callback: Callback<string>
Returns void
- Defined in src/db.ts:666
Parameters
- options: CommandOperationOptions
Returns Promise<string>
- Defined in src/db.ts:667
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:608
Parameters
- username: string
Returns Promise<boolean>
- Defined in src/db.ts:609
Parameters
- username: string
- callback: Callback<boolean>
Returns void
- Defined in src/db.ts:610
Parameters
- username: string
- options: CommandOperationOptions
Returns Promise<boolean>
- Defined in src/db.ts:611
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:403
remarks
This operation does not inherit options from the MongoClient.
Type parameters
- TSchema: Document = Document
Parameters
- fromCollection: string
- toCollection: string
Returns Promise<Collection<TSchema>>
- Defined in src/db.ts:407
Type parameters
- TSchema: Document = Document
Parameters
- fromCollection: string
- toCollection: string
- callback: Callback<Collection<TSchema>>
Returns void
- Defined in src/db.ts:412
Type parameters
- TSchema: Document = Document
Parameters
- fromCollection: string
- toCollection: string
- options: RenameOptions
Returns Promise<Collection<TSchema>>
- Defined in src/db.ts:417
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:633
Parameters
- level: ProfilingLevel
Returns Promise<ProfilingLevel>
- Defined in src/db.ts:634
Parameters
- level: ProfilingLevel
- callback: Callback<ProfilingLevel>
Returns void
- Defined in src/db.ts:635
Parameters
- level: ProfilingLevel
- options: CommandOperationOptions
Returns Promise<ProfilingLevel>
- Defined in src/db.ts:639
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:349
Returns Promise<Document>
- Defined in src/db.ts:350
Parameters
- callback: Callback<Document>
Returns void
- Defined in src/db.ts:351
Parameters
- options: DbStatsOptions
Returns Promise<Document>
- Defined in src/db.ts:352
Parameters
- options: DbStatsOptions
- callback: Callback<Document>
Returns void

unref

unref(): void

- Defined in src/db.ts:714
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:733
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
- TChange: Document = ChangeStreamDocument<TSchema>
Parameters
- pipeline: Document[] = []
- options: ChangeStreamOptions = {}
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