Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Db

The Db class is a class that represents a MongoDB Database.Db类是表示MongoDB数据库的类。

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继承层级

  • Db

Index索引

Constructors构造函数

  • Creates a new Db instance创建新的Db实例

    Parameters参数

    • client: MongoClient

      The MongoClient for the database.数据库的MongoClient。

    • databaseName: string

      The name of the database this instance represents.此实例表示的数据库的名称。

    • Optional options: DbOptions

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

    Returns 返回 Db

Properties属性

SYSTEM_COMMAND_COLLECTION: string = CONSTANTS.SYSTEM_COMMAND_COLLECTION
SYSTEM_INDEX_COLLECTION: string = CONSTANTS.SYSTEM_INDEX_COLLECTION
SYSTEM_JS_COLLECTION: string = CONSTANTS.SYSTEM_JS_COLLECTION
SYSTEM_NAMESPACE_COLLECTION: string = CONSTANTS.SYSTEM_NAMESPACE_COLLECTION
SYSTEM_PROFILE_COLLECTION: string = CONSTANTS.SYSTEM_PROFILE_COLLECTION
SYSTEM_USER_COLLECTION: string = CONSTANTS.SYSTEM_USER_COLLECTION

Accessors访问器

  • get databaseName(): string
  • get namespace(): string
  • The current readPreference of the Db. Db的当前readPreference。If not explicitly defined for this Db, will be inherited from the parent MongoClient如果没有为此Db显式定义,将从父MongoClient继承

    Returns 返回 ReadPreference

  • get secondaryOk(): boolean
  • Check if a secondary can be used (because the read preference is not set to primary)检查是否可以使用辅助(因为读取首选项设置为primary

    Returns 返回 boolean

  • get slaveOk(): boolean
  • slaveOk specified指定slaveOk

    deprecated

    Use secondaryOk instead改用secondaryOk

    Returns 返回 boolean

Methods方法

  • Add a user to the database将用户添加到数据库

    Parameters参数

    • username: string

      The username for the new user新用户的用户名

    Returns 返回 Promise<Document>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. 回调已被弃用,将在下一个主要版本中删除。See mongodb-legacy for migration assistance请参阅mongodb-legacy获取迁移帮助

    Parameters参数

    Returns 返回 void

  • Parameters参数

    • username: string
    • password: string

    Returns 返回 Promise<Document>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. 回调已被弃用,将在下一个主要版本中删除。See mongodb-legacy for migration assistance请参阅mongodb-legacy获取迁移帮助

    Parameters参数

    Returns 返回 void

  • Parameters参数

    Returns 返回 Promise<Document>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. 回调已被弃用,将在下一个主要版本中删除。See mongodb-legacy for migration assistance请参阅mongodb-legacy获取迁移帮助

    Parameters参数

    Returns 返回 void

  • Parameters参数

    Returns 返回 Promise<Document>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. 回调已被弃用,将在下一个主要版本中删除。See mongodb-legacy for migration assistance请参阅mongodb-legacy获取迁移帮助

    Parameters参数

    Returns 返回 void

  • Return the Admin db instance返回Admin数据库实例

    Returns 返回 Admin

  • Execute an aggregation framework pipeline against the database, needs MongoDB >= 3.6针对数据库执行聚合框架管道,需要MongoDB>=3.6

    Type parameters类型参数

    Parameters参数

    • pipeline: Document[] = []

      An array of aggregation stages to be executed要执行的聚合阶段数组

    • Optional options: AggregateOptions

      Optional settings for the command命令的可选设置

    Returns 返回 AggregationCursor<T>

  • Returns a reference to a MongoDB Collection. 返回对MongoDB集合的引用。If it does not exist it will be created implicitly.如果它不存在,将隐式创建。

    Type parameters类型参数

    Parameters参数

    • name: string

      the collection name we wish to access.我们希望访问的集合名称。

    • options: CollectionOptions = {}

    Returns 返回 Collection<TSchema>

    return the new Collection instance

  • 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>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. 回调已被弃用,将在下一个主要版本中删除。See mongodb-legacy for migration assistance请参阅mongodb-legacy获取迁移帮助

    Parameters参数

    Returns 返回 void

  • Parameters参数

    Returns 返回 Promise<string>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. 回调已被弃用,将在下一个主要版本中删除。See mongodb-legacy for migration assistance请参阅mongodb-legacy获取迁移帮助

    Parameters参数

    Returns 返回 void

  • 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>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. 回调已被弃用,将在下一个主要版本中删除。See mongodb-legacy for migration assistance请参阅mongodb-legacy获取迁移帮助

    Parameters参数

    • name: string
    • callback: Callback<boolean>

    Returns 返回 void

  • Parameters参数

    Returns 返回 Promise<boolean>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. 回调已被弃用,将在下一个主要版本中删除。See mongodb-legacy for migration assistance请参阅mongodb-legacy获取迁移帮助

    Parameters参数

    Returns 返回 void

  • Drop a database, removing it permanently from the server.删除数据库,将其从服务器中永久删除。

    Returns 返回 Promise<boolean>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. 回调已被弃用,将在下一个主要版本中删除。See mongodb-legacy for migration assistance请参阅mongodb-legacy获取迁移帮助

    Parameters参数

    Returns 返回 void

  • Parameters参数

    Returns 返回 Promise<boolean>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. 回调已被弃用,将在下一个主要版本中删除。See mongodb-legacy for migration assistance请参阅mongodb-legacy获取迁移帮助

    Parameters参数

    Returns 返回 void

  • Return the db logger返回数据库记录器

    Returns 返回 Logger

  • Retrieves this collections index info.检索此集合索引信息。

    Parameters参数

    • name: string

      The name of the collection.集合的名称。

    Returns 返回 Promise<Document>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. 回调已被弃用,将在下一个主要版本中删除。See mongodb-legacy for migration assistance请参阅mongodb-legacy获取迁移帮助

    Parameters参数

    Returns 返回 void

  • Parameters参数

    Returns 返回 Promise<Document>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. 回调已被弃用,将在下一个主要版本中删除。See mongodb-legacy for migration assistance请参阅mongodb-legacy获取迁移帮助

    Parameters参数

    Returns 返回 void

  • Retrieve the current profiling Level for MongoDB检索MongoDB的当前分析级别

    Returns 返回 Promise<string>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. 回调已被弃用,将在下一个主要版本中删除。See mongodb-legacy for migration assistance请参阅mongodb-legacy获取迁移帮助

    Parameters参数

    Returns 返回 void

  • Parameters参数

    Returns 返回 Promise<string>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. 回调已被弃用,将在下一个主要版本中删除。See mongodb-legacy for migration assistance请参阅mongodb-legacy获取迁移帮助

    Parameters参数

    Returns 返回 void

  • Remove a user from a database从数据库中删除用户

    Parameters参数

    • username: string

      The username to remove要删除的用户名

    Returns 返回 Promise<boolean>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. 回调已被弃用,将在下一个主要版本中删除。See mongodb-legacy for migration assistance请参阅mongodb-legacy获取迁移帮助

    Parameters参数

    • username: string
    • callback: Callback<boolean>

    Returns 返回 void

  • Parameters参数

    Returns 返回 Promise<boolean>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. 回调已被弃用,将在下一个主要版本中删除。See mongodb-legacy for migration assistance请参阅mongodb-legacy获取迁移帮助

    Parameters参数

    Returns 返回 void

  • 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
  • Rename a collection.重命名集合。

    remarks

    This operation does not inherit options from the MongoClient.此操作不会从MongoClient继承选项。

    Type parameters类型参数

    Parameters参数

    • fromCollection: string

      Name of current collection to rename要重命名的当前集合的名称

    • toCollection: string

      New name of of the collection集合的新名称

    Returns 返回 Promise<Collection<TSchema>>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. 回调已被弃用,将在下一个主要版本中删除。See mongodb-legacy for migration assistance请参阅mongodb-legacy获取迁移帮助

    Type parameters类型参数

    Parameters参数

    Returns 返回 void

  • Type parameters类型参数

    Parameters参数

    • fromCollection: string
    • toCollection: string
    • options: RenameOptions

    Returns 返回 Promise<Collection<TSchema>>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. 回调已被弃用,将在下一个主要版本中删除。See mongodb-legacy for migration assistance请参阅mongodb-legacy获取迁移帮助

    Type parameters类型参数

    Parameters参数

    Returns 返回 void

  • Get all the db statistics.获取所有数据库统计信息。

    Returns 返回 Promise<Document>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. 回调已被弃用,将在下一个主要版本中删除。See mongodb-legacy for migration assistance请参阅mongodb-legacy获取迁移帮助

    Parameters参数

    Returns 返回 void

  • Parameters参数

    Returns 返回 Promise<Document>

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. 回调已被弃用,将在下一个主要版本中删除。See mongodb-legacy for migration assistance请参阅mongodb-legacy获取迁移帮助

    Parameters参数

    Returns 返回 void

  • unref(): void
  • Unref all sockets取消引用所有套接字

    deprecated

    This function is deprecated and will be removed in the next major version.此函数已弃用,将在下一个主要版本中删除。

    Returns 返回 void

  • 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:watch()接受不同用例的两个通用参数:

    • 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第二种方法是完全覆盖变更流文档的形状,如果没有提供,类型将默认为第一个参数的ChangeStreamDocument

    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.这允许筛选(使用$match)和操作变更流文档。

    • options: ChangeStreamOptions = {}

      Optional settings for the command命令的可选设置

    Returns 返回 ChangeStream<TSchema, TChange>

Generated using TypeDoc