Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MongoClient

The MongoClient class is a class that allows for making Connections to MongoDB.MongoClient类是一个允许连接MongoDB的类。

remarks

The programmatically provided options take precedent over the URI options.以编程方式提供的选项优先于URI选项。

example
// Connect using a MongoClient instance
const MongoClient = require('mongodb').MongoClient;
const test = require('assert');
// Connection url
const url = 'mongodb://localhost:27017';
// Database Name
const dbName = 'test';
// Connect using MongoClient
const mongoClient = new MongoClient(url);
mongoClient.connect(function(err, client) {
  const db = client.db(dbName);
  client.close();
});
example
// Connect using the MongoClient.connect static method
const MongoClient = require('mongodb').MongoClient;
const test = require('assert');
// Connection url
const url = 'mongodb://localhost:27017';
// Database Name
const dbName = 'test';
// Connect using MongoClient
MongoClient.connect(url, function(err, client) {
  const db = client.db(dbName);
  client.close();
});

Hierarchy层级

Index索引

Constructors构造函数

constructor

Properties属性

[kOptions]

[kOptions]: MongoOptions

The consolidate, parsed, transformed and merged options.合并、解析、转换和合并选项。

internal

s

internal

Optional topology

topology: Topology
internal

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.设置或获取所有发射器的默认captureRejection值。

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. 此符号应用于安装仅用于监控'error'事件的侦听器。Listeners installed using this symbol are called before the regular 'error' listeners are called.在调用常规'error'侦听器之前,将调用使用此符号安装的侦听器。

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.使用此符号安装侦听器不会在发出'error'事件后更改行为,因此如果未安装常规的'error'侦听器,进程仍将崩溃。

Accessors访问器

autoEncrypter

bsonOptions

logger

monitorCommands

  • get monitorCommands(): boolean
  • set monitorCommands(value: boolean): void
  • Intended for APM use only仅供APM使用

    internal

    Returns返回boolean

  • Intended for APM use only仅供APM使用

    Parameters参数

    • value: boolean

    Returns返回void

options

readConcern

readPreference

serverApi

  • get serverApi(): Readonly<undefined | ServerApi>

writeConcern

Methods方法

addListener

  • Type parameters类型参数

    • EventKey: "close" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"

    Parameters参数

    Returns返回MongoClient

  • Parameters参数

    Returns返回MongoClient

  • Parameters参数

    Returns返回MongoClient

close

  • close(): Promise<void>
  • close(callback: Callback<void>): void
  • close(force: boolean): Promise<void>
  • close(force: boolean, callback: Callback<void>): void

connect

db

  • Create a new Db instance sharing the current socket connections.创建共享当前套接字连接的新Db实例。

    Parameters参数

    • Optional dbName: string

      The name of the database we want to use. 我们要使用的数据库的名称。If not provided, use database name from connection string.如果未提供,请使用连接字符串中的数据库名称。

    • Optional options: DbOptions

      Optional settings for Db constructionDb构造的可选设置

    Returns返回Db

emit

  • emit<EventKey>(event: symbol | EventKey, ...args: Parameters<MongoClientEvents[EventKey]>): boolean
  • Type parameters类型参数

    • EventKey: "close" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"

    Parameters参数

    Returns返回boolean

eventNames

  • eventNames(): string[]

getLogger

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount<EventKey>(type: string | symbol | EventKey): number
  • Type parameters类型参数

    • EventKey: "close" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"

    Parameters参数

    • type: string | symbol | EventKey

    Returns返回number

listeners

  • listeners<EventKey>(event: string | symbol | EventKey): MongoClientEvents[EventKey][]
  • Type parameters类型参数

    • EventKey: "close" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"

    Parameters参数

    • event: string | symbol | EventKey

    Returns返回MongoClientEvents[EventKey][]

off

  • Type parameters类型参数

    • EventKey: "close" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"

    Parameters参数

    Returns返回MongoClient

  • Parameters参数

    Returns返回MongoClient

  • Parameters参数

    Returns返回MongoClient

on

  • Type parameters类型参数

    • EventKey: "close" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"

    Parameters参数

    Returns返回MongoClient

  • Parameters参数

    Returns返回MongoClient

  • Parameters参数

    Returns返回MongoClient

once

  • Type parameters类型参数

    • EventKey: "close" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"

    Parameters参数

    Returns返回MongoClient

  • Parameters参数

    Returns返回MongoClient

  • Parameters参数

    Returns返回MongoClient

prependListener

prependOnceListener

rawListeners

  • rawListeners<EventKey>(event: string | symbol | EventKey): MongoClientEvents[EventKey][]
  • Type parameters类型参数

    • EventKey: "close" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"

    Parameters参数

    • event: string | symbol | EventKey

    Returns返回MongoClientEvents[EventKey][]

removeAllListeners

  • removeAllListeners<EventKey>(event?: string | symbol | EventKey): MongoClient
  • Type parameters类型参数

    • EventKey: "close" | "commandStarted" | "commandSucceeded" | "commandFailed" | "serverHeartbeatStarted" | "serverHeartbeatSucceeded" | "serverHeartbeatFailed" | "connectionPoolCreated" | "connectionPoolClosed" | "connectionPoolCleared" | "connectionCreated" | "connectionReady" | "connectionClosed" | "connectionCheckOutStarted" | "connectionCheckOutFailed" | "connectionCheckedOut" | "connectionCheckedIn" | "serverOpening" | "serverClosed" | "serverDescriptionChanged" | "topologyOpening" | "topologyClosed" | "topologyDescriptionChanged" | "error" | "timeout" | "open"

    Parameters参数

    • Optional event: string | symbol | EventKey

    Returns返回MongoClient

removeListener

setMaxListeners

startSession

watch

  • Create a new Change Stream, watching for new changes (insertions, updates, replacements, deletions, and invalidations) in this cluster. Will ignore all changes to system collections, as well as the local, admin, and config databases.

    Type parameters类型参数

    Parameters参数

    Returns返回ChangeStream<TSchema>

withSession

  • Runs a given operation with an implicitly created session. 使用隐式创建的会话运行给定操作。The lifetime of the session will be handled without the need for user interaction.会话的生存期将在不需要用户交互的情况下处理。

    NOTE: presently the operation MUST return a Promise (either explicit or implicitly as an async function)注意:当前操作必须返回承诺(作为异步函数显式或隐式)

    Parameters参数

    • callback: WithSessionCallback

      An callback to execute with an implicitly created session使用隐式创建的会话执行的回调

    Returns返回Promise<void>

  • Parameters参数

    Returns返回Promise<void>

Static connect

Static getEventListener

  • getEventListener(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]
  • Returns a list listener for a specific emitter event name.返回特定发射器事件名称的列表侦听器。

    Parameters参数

    • emitter: DOMEventTarget | EventEmitter
    • name: string | symbol

    Returns返回Function[]

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters参数

    • emitter: EventEmitter
    • event: string | symbol

    Returns返回number

Static on

  • on(emitter: EventEmitter, event: string, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>
  • Parameters参数

    • emitter: EventEmitter
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns返回AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol, options?: StaticEventEmitterOptions): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string, options?: StaticEventEmitterOptions): Promise<any[]>
  • Parameters参数

    • emitter: NodeEventTarget
    • event: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns返回Promise<any[]>

  • Parameters参数

    • emitter: DOMEventTarget
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns返回Promise<any[]>

Generated using TypeDoc