diff --git a/README.md b/README.md index a619728b815..04bc7dd3988 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ Core Server (i.e. SERVER) project are **public**. ### Support / Feedback -For issues with, questions about, or feedback for the Node.js driver, please look into our [support channels](https://docs.mongodb.com/manual/support). Please do not email any of the driver developers directly with issues or questions - you're more likely to get an answer on the [MongoDB Community Forums](https://community.mongodb.com/tags/c/drivers-odms-connectors/7/node-js-driver). +For issues with, questions about, or feedback for the Node.js driver, please look into our [support channels](https://www.mongodb.com/docs/manual/support). Please do not email any of the driver developers directly with issues or questions - you're more likely to get an answer on the [MongoDB Community Forums](https://community.mongodb.com/tags/c/drivers-odms-connectors/7/node-js-driver). ### Change Log @@ -41,8 +41,8 @@ Change history can be found in [`HISTORY.md`](https://github.com/mongodb/node-mo For version compatibility matrices, please refer to the following links: -- [MongoDB](https://docs.mongodb.com/drivers/node/current/compatibility/#mongodb-compatibility) -- [NodeJS](https://docs.mongodb.com/drivers/node/current/compatibility/#language-compatibility) +- [MongoDB](https://www.mongodb.com/docs/drivers/node/current/compatibility/#mongodb-compatibility) +- [NodeJS](https://www.mongodb.com/docs/drivers/node/current/compatibility/#language-compatibility) #### Typescript Version @@ -91,7 +91,7 @@ Third party: ## Quick Start -This guide will show you how to set up a simple application using Node.js and MongoDB. Its scope is only how to set up the driver and perform the simple CRUD operations. For more in-depth coverage, see the [official documentation](https://docs.mongodb.com/drivers/node/). +This guide will show you how to set up a simple application using Node.js and MongoDB. Its scope is only how to set up the driver and perform the simple CRUD operations. For more in-depth coverage, see the [official documentation](https://www.mongodb.com/docs/drivers/node/). ### Create the `package.json` file @@ -116,7 +116,7 @@ npm install mongodb ### Start a MongoDB Server -For complete MongoDB installation instructions, see [the manual](https://docs.mongodb.org/manual/installation/). +For complete MongoDB installation instructions, see [the manual](https://www.mongodb.com/docs/manual/installation/). 1. Download the right MongoDB version from [MongoDB](https://www.mongodb.org/downloads) 2. Create a database directory (in this case under **/data**). @@ -243,7 +243,7 @@ console.log('Deleted documents =>', deleteResult); ### Index a Collection -[Indexes](https://docs.mongodb.org/manual/indexes/) can improve your application's +[Indexes](https://www.mongodb.com/docs/manual/indexes/) can improve your application's performance. The following function creates an index on the **a** field in the **documents** collection. @@ -252,7 +252,7 @@ const indexName = await collection.createIndex({ a: 1 }); console.log('index name =', indexName); ``` -For more detailed information, see the [indexing strategies page](https://docs.mongodb.com/manual/applications/indexes/). +For more detailed information, see the [indexing strategies page](https://www.mongodb.com/docs/manual/applications/indexes/). ## Error Handling @@ -282,9 +282,9 @@ try { ## Next Steps -- [MongoDB Documentation](https://docs.mongodb.com/manual/) -- [MongoDB Node Driver Documentation](https://docs.mongodb.com/drivers/node/) -- [Read about Schemas](https://docs.mongodb.com/manual/core/data-modeling-introduction/) +- [MongoDB Documentation](https://www.mongodb.com/docs/manual/) +- [MongoDB Node Driver Documentation](https://www.mongodb.com/docs/drivers/node/) +- [Read about Schemas](https://www.mongodb.com/docs/manual/core/data-modeling-introduction/) - [Star us on GitHub](https://github.com/mongodb/node-mongodb-native) ## License diff --git a/docs/2.2/api/Collection.html b/docs/2.2/api/Collection.html index e3966054167..ec6d23042d2 100644 --- a/docs/2.2/api/Collection.html +++ b/docs/2.2/api/Collection.html @@ -4982,7 +4982,7 @@

-

Creates multiple indexes in the collection, this method is only supported for
MongoDB 2.6 or higher. Earlier version of MongoDB will throw a command not supported
error. Index specifications are defined at http://docs.mongodb.org/manual/reference/command/createIndexes/.

+

Creates multiple indexes in the collection, this method is only supported for
MongoDB 2.6 or higher. Earlier version of MongoDB will throw a command not supported
error. Index specifications are defined at https://www.mongodb.com/docs/manual/reference/command/createIndexes/.

diff --git a/docs/2.2/api/Db.html b/docs/2.2/api/Db.html index 59b1afcd383..04621534bfc 100644 --- a/docs/2.2/api/Db.html +++ b/docs/2.2/api/Db.html @@ -5436,7 +5436,7 @@

-

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://docs.mongodb.com/manual/reference/command/create/

+

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/

diff --git a/docs/2.2/api/lib_collection.js.html b/docs/2.2/api/lib_collection.js.html index 9bb7966499d..8f7cef21c7c 100644 --- a/docs/2.2/api/lib_collection.js.html +++ b/docs/2.2/api/lib_collection.js.html @@ -3442,7 +3442,7 @@

Source: lib/collec /** * Creates multiple indexes in the collection, this method is only supported for * MongoDB 2.6 or higher. Earlier version of MongoDB will throw a command not supported - * error. Index specifications are defined at http://docs.mongodb.org/manual/reference/command/createIndexes/. + * error. Index specifications are defined at https://www.mongodb.com/docs/manual/reference/command/createIndexes/. * @method * @param {array} indexSpecs An array of index specifications to be created * @param {Collection~resultCallback} [callback] The command result callback diff --git a/docs/2.2/api/lib_db.js.html b/docs/2.2/api/lib_db.js.html index ef3073002a6..f8c1b92ac6b 100644 --- a/docs/2.2/api/lib_db.js.html +++ b/docs/2.2/api/lib_db.js.html @@ -2367,7 +2367,7 @@

Source: lib/db.js

/** * 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://docs.mongodb.com/manual/reference/command/create/ + * More information about command options available at https://www.mongodb.com/docs/manual/reference/command/create/ * * @method * @param {string} name the collection name we wish to access. diff --git a/docs/2.2/css/mongodb-docs.css b/docs/2.2/css/mongodb-docs.css index 3944602b762..19c629ab087 100644 --- a/docs/2.2/css/mongodb-docs.css +++ b/docs/2.2/css/mongodb-docs.css @@ -497,14 +497,14 @@ ul.home-nav li.docs { width: 276px; } ul.home-nav li.docs a, ul.home-nav li.docs a:visited { float: left; - background: url(http://www.mongodb.org/static/images/home_nav.png) -11px -63px; + background: url(www.mongodb.com/docs/static/images/home_nav.png) -11px -63px; width: 209px; height: 54px; } ul.home-nav li.docs a:hover { float: left; - background: url(http://www.mongodb.org/static/images/home_nav.png) -11px 0; + background: url(www.mongodb.com/docs/static/images/home_nav.png) -11px 0; width: 209px; height: 54px; } @@ -513,14 +513,14 @@ ul.home-nav li.try { width: 238px; } ul.home-nav li.try a, ul.home-nav li.try a:visited { float: left; - background: url(http://www.mongodb.org/static/images/home_nav.png) -274px -63px; + background: url(www.mongodb.com/docs/static/images/home_nav.png) -274px -63px; width: 176px; height: 54px; } ul.home-nav li.try a:hover { float: left; - background: url(http://www.mongodb.org/static/images/home_nav.png) -274px 0; + background: url(www.mongodb.com/docs/static/images/home_nav.png) -274px 0; width: 176px; height: 54px; } @@ -529,14 +529,14 @@ ul.home-nav li.downloads { width: 245px; } ul.home-nav li.downloads a, ul.home-nav li.downloads a:visited { float: left; - background: url(http://www.mongodb.org/static/images/home_nav.png) -497px -63px; + background: url(www.mongodb.com/docs/static/images/home_nav.png) -497px -63px; width: 185px; height: 54px; } ul.home-nav li.downloads a:hover { float: left; - background: url(http://www.mongodb.org/static/images/home_nav.png) -497px 0; + background: url(www.mongodb.com/docs/static/images/home_nav.png) -497px 0; width: 185px; height: 54px; } @@ -547,14 +547,14 @@ ul.home-nav li.drivers { ul.home-nav li.drivers a, ul.home-nav li.drivers a:visited { float: left; - background: url(http://www.mongodb.org/static/images/home_nav.png) right -63px no-repeat; + background: url(www.mongodb.com/docs/static/images/home_nav.png) right -63px no-repeat; width: 194px; height: 54px; } ul.home-nav li.drivers a:hover { float: left; - background: url(http://www.mongodb.org/static/images/home_nav.png) right 0 no-repeat; + background: url(www.mongodb.com/docs/static/images/home_nav.png) right 0 no-repeat; width: 194px; height: 54px; } diff --git a/docs/2.2/index.html b/docs/2.2/index.html index 5e8d75534b8..e6b08b51cfe 100644 --- a/docs/2.2/index.html +++ b/docs/2.2/index.html @@ -36,17 +36,17 @@
MongoDB University - Downloads - Community - Docs - Blog + Downloads + Community + Docs + Blog

Type parameters

Parameters

Parameters

Returns ChangeStream<TLocal, TChange>

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/4.11/classes/Db.html b/docs/4.11/classes/Db.html index 005626cce34..a6f2a0349c1 100644 --- a/docs/4.11/classes/Db.html +++ b/docs/4.11/classes/Db.html @@ -52,7 +52,7 @@

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

    Parameters

    Returns void

    • createCollection

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.11/classes/FindCursor.html b/docs/4.11/classes/FindCursor.html index 01d1e59931c..2d120339dc3 100644 --- a/docs/4.11/classes/FindCursor.html +++ b/docs/4.11/classes/FindCursor.html @@ -21,11 +21,11 @@

    The modifier value.

    Returns FindCursor<TSchema>

    allowDiskUse

    • allowDiskUse(allow?: boolean): FindCursor<TSchema>

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.11/classes/ListCollectionsCursor.html b/docs/4.11/classes/ListCollectionsCursor.html index 8fdfc77fbbf..b587e0941c6 100644 --- a/docs/4.11/classes/ListCollectionsCursor.html +++ b/docs/4.11/classes/ListCollectionsCursor.html @@ -16,7 +16,7 @@

    Returns ListCollectionsCursor<T>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.11/classes/ListIndexesCursor.html b/docs/4.11/classes/ListIndexesCursor.html index 3f6c505eba7..5d4eed18006 100644 --- a/docs/4.11/classes/ListIndexesCursor.html +++ b/docs/4.11/classes/ListIndexesCursor.html @@ -16,7 +16,7 @@

    Returns ListIndexesCursor

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    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.

      +

      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>

    withSession

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

    • Static connect

    Static getEventListeners

    • getEventListeners(emitter: EventEmitter | _DOMEventTarget, name: string | symbol): Function[]

    Hierarchy

    • ReadConcern

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    level

    level: string

    Accessors

    Static AVAILABLE

    • get AVAILABLE(): "available"

    Static LINEARIZABLE

    • get LINEARIZABLE(): "linearizable"

    Static MAJORITY

    • get MAJORITY(): "majority"

    Static SNAPSHOT

    • get SNAPSHOT(): "snapshot"

    Methods

    toJSON

    Static fromOptions

    Hierarchy

    • ReadPreference

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • Parameters

      • mode: ReadPreferenceMode

        A string describing the read preference mode (primary|primaryPreferred|secondary|secondaryPreferred|nearest)

      • Optional tags: TagSet[]
        @@ -18,11 +18,11 @@

        The string representing the read preference mode.

      Returns boolean

    secondaryOk

    • secondaryOk(): boolean

    slaveOk

    • slaveOk(): boolean

    toJSON

    Static fromOptions

    Hierarchy

    • WriteConcern

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new WriteConcern(w?: W, wtimeout?: number, j?: boolean, fsync?: boolean | 1): WriteConcern

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    @@ -70,7 +70,7 @@

    The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).

    Optional resumeAfter

    resumeAfter?: unknown

    Allows you to start a changeStream after a specified event.

    -
    see

    https://docs.mongodb.com/manual/changeStreams/#resumeafter-for-change-streams

    +
    see

    https://www.mongodb.com/docs/manual/changeStreams/#resumeafter-for-change-streams

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean
    @@ -90,7 +90,7 @@

    Optional startAfter

    startAfter?: unknown

    Similar to resumeAfter, but will allow you to start after an invalidated event.

    -
    see

    https://docs.mongodb.com/manual/changeStreams/#startafter-for-change-streams

    +
    see

    https://www.mongodb.com/docs/manual/changeStreams/#startafter-for-change-streams

    Optional startAtOperationTime

    startAtOperationTime?: Timestamp

    Will start the changeStream after the specified operationTime.

    Optional willRetryWrite

    willRetryWrite?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    diff --git a/docs/4.11/interfaces/CollStats.html b/docs/4.11/interfaces/CollStats.html index 38bb6dd3830..8dfa5ddf6b2 100644 --- a/docs/4.11/interfaces/CollStats.html +++ b/docs/4.11/interfaces/CollStats.html @@ -1,4 +1,4 @@ -CollStats | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CollStats

    see

    https://docs.mongodb.org/manual/reference/command/collStats/

    +CollStats | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CollStats

    see

    https://www.mongodb.com/docs/manual/reference/command/collStats/

    Hierarchy

    Index

    Properties

    Properties

    avgObjSize

    avgObjSize: number

    Average object size in bytes

    capped

    capped: boolean
    diff --git a/docs/4.11/interfaces/CountDocumentsOptions.html b/docs/4.11/interfaces/CountDocumentsOptions.html index 759b5ae9954..e243134a2ba 100644 --- a/docs/4.11/interfaces/CountDocumentsOptions.html +++ b/docs/4.11/interfaces/CountDocumentsOptions.html @@ -1,7 +1,7 @@ CountDocumentsOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CountDocumentsOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional allowDiskUse

    allowDiskUse?: boolean

    allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).

    Optional authdb

    authdb?: string

    Optional batchSize

    batchSize?: number
    -

    The number of documents to return per batch. See aggregation documentation.

    +

    The number of documents to return per batch. See aggregation documentation.

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    diff --git a/docs/4.11/interfaces/FindOneAndDeleteOptions.html b/docs/4.11/interfaces/FindOneAndDeleteOptions.html index 20a14ea5eea..f65b794fb35 100644 --- a/docs/4.11/interfaces/FindOneAndDeleteOptions.html +++ b/docs/4.11/interfaces/FindOneAndDeleteOptions.html @@ -17,7 +17,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.11/interfaces/FindOneAndReplaceOptions.html b/docs/4.11/interfaces/FindOneAndReplaceOptions.html index e0843517830..b5da736076f 100644 --- a/docs/4.11/interfaces/FindOneAndReplaceOptions.html +++ b/docs/4.11/interfaces/FindOneAndReplaceOptions.html @@ -19,7 +19,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.11/interfaces/FindOneAndUpdateOptions.html b/docs/4.11/interfaces/FindOneAndUpdateOptions.html index 2956a444eb7..3e2432aa8aa 100644 --- a/docs/4.11/interfaces/FindOneAndUpdateOptions.html +++ b/docs/4.11/interfaces/FindOneAndUpdateOptions.html @@ -21,7 +21,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.11/interfaces/MongoClientOptions.html b/docs/4.11/interfaces/MongoClientOptions.html index a25bca56702..4f67a53b7d4 100644 --- a/docs/4.11/interfaces/MongoClientOptions.html +++ b/docs/4.11/interfaces/MongoClientOptions.html @@ -1,6 +1,6 @@ MongoClientOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MongoClientOptions

    Describes all possible URI query options for the mongo client

    -
    see

    https://docs.mongodb.com/manual/reference/connection-string

    +
    see

    https://www.mongodb.com/docs/manual/reference/connection-string

    Hierarchy

    Index

    Properties

    Properties

    Optional ALPNProtocols

    ALPNProtocols?: string[] | Uint8Array | Uint8Array[]

    An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

    @@ -18,7 +18,7 @@

    Optionally enable in-use auto encryption

    remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    -

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    +

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    • AutoEncryptionOptions.keyVaultClient is not passed.
      • @@ -250,7 +250,7 @@

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    A MongoDB WriteConcern, which describes the level of acknowledgement requested from MongoDB for write operations.

    -
    see

    https://docs.mongodb.com/manual/reference/write-concern/

    +
    see

    https://www.mongodb.com/docs/manual/reference/write-concern/

    Optional wtimeoutMS

    wtimeoutMS?: number

    The write concern timeout

    deprecated

    Please use the writeConcern option instead

    diff --git a/docs/4.11/interfaces/MongoOptions.html b/docs/4.11/interfaces/MongoOptions.html index ca9eeb06d1d..d084fa5fb26 100644 --- a/docs/4.11/interfaces/MongoOptions.html +++ b/docs/4.11/interfaces/MongoOptions.html @@ -7,7 +7,7 @@

    Optionally enable in-use auto encryption

    remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    -

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    +

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    NumericType

    NumericType: IntegerType | Decimal128 | Double

    OneOrMore

    OneOrMore<T>: T | ReadonlyArray<T>

    Type parameters

    • T

    OnlyFieldsOfType

    OnlyFieldsOfType<TSchema, FieldType, AssignableType>: IsAny<TSchema[keyof TSchema], Record<string, FieldType>, AcceptedFields<TSchema, FieldType, AssignableType> & NotAcceptedFields<TSchema, FieldType> & Record<string, AssignableType>>

    Type parameters

    • TSchema

    • FieldType = any

    • AssignableType = FieldType

    OperationTime

    OperationTime: Timestamp

    Represents a specific point in time on a server. Can be retrieved by using db.command()

    -
    see

    https://docs.mongodb.com/manual/reference/method/db.runCommand/#response

    +
    see

    https://www.mongodb.com/docs/manual/reference/method/db.runCommand/#response

    OptionalId

    OptionalId<TSchema>: EnhancedOmit<TSchema, "_id"> & { _id?: InferIdType<TSchema> }

    Add an optional _id field to an object shaped type

    Type parameters

    • TSchema

    OptionalUnlessRequiredId

    OptionalUnlessRequiredId<TSchema>: TSchema extends { _id: any } ? TSchema : OptionalId<TSchema>
    diff --git a/docs/4.12/classes/AbstractCursor.html b/docs/4.12/classes/AbstractCursor.html index ca41d905dca..2814b89f17f 100644 --- a/docs/4.12/classes/AbstractCursor.html +++ b/docs/4.12/classes/AbstractCursor.html @@ -16,7 +16,7 @@

    Returns AbstractCursor<TSchema, CursorEvents>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    Abstract clone

    • diff --git a/docs/4.12/classes/AggregationCursor.html b/docs/4.12/classes/AggregationCursor.html index f9b0a756e03..8d7b1049695 100644 --- a/docs/4.12/classes/AggregationCursor.html +++ b/docs/4.12/classes/AggregationCursor.html @@ -21,7 +21,7 @@

    Returns AggregationCursor<TSchema>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    mapReduce

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.12/classes/Db.html b/docs/4.12/classes/Db.html index 77336956f3c..ad11ba8320e 100644 --- a/docs/4.12/classes/Db.html +++ b/docs/4.12/classes/Db.html @@ -52,7 +52,7 @@

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    Parameters

    Returns void

    • createCollection

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.12/classes/FindCursor.html b/docs/4.12/classes/FindCursor.html index 4be9a6d7bc4..e633e79cd0f 100644 --- a/docs/4.12/classes/FindCursor.html +++ b/docs/4.12/classes/FindCursor.html @@ -21,11 +21,11 @@

    The modifier value.

    Returns FindCursor<TSchema>

    allowDiskUse

    • allowDiskUse(allow?: boolean): FindCursor<TSchema>

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.12/classes/ListCollectionsCursor.html b/docs/4.12/classes/ListCollectionsCursor.html index dc9c5db42b4..c30ee5c2e74 100644 --- a/docs/4.12/classes/ListCollectionsCursor.html +++ b/docs/4.12/classes/ListCollectionsCursor.html @@ -16,7 +16,7 @@

    Returns ListCollectionsCursor<T>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.12/classes/ListIndexesCursor.html b/docs/4.12/classes/ListIndexesCursor.html index d9b2c3663ed..a2ab036b363 100644 --- a/docs/4.12/classes/ListIndexesCursor.html +++ b/docs/4.12/classes/ListIndexesCursor.html @@ -16,7 +16,7 @@

    Returns ListIndexesCursor

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    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.

      +

      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>

    withSession

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

    • Static connect

    Static getEventListeners

    • getEventListeners(emitter: EventEmitter | _DOMEventTarget, name: string | symbol): Function[]

    Hierarchy

    • ReadConcern

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    level

    level: string

    Accessors

    Static AVAILABLE

    • get AVAILABLE(): "available"

    Static LINEARIZABLE

    • get LINEARIZABLE(): "linearizable"

    Static MAJORITY

    • get MAJORITY(): "majority"

    Static SNAPSHOT

    • get SNAPSHOT(): "snapshot"

    Methods

    toJSON

    Static fromOptions

    Hierarchy

    • ReadPreference

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • Parameters

      • mode: ReadPreferenceMode

        A string describing the read preference mode (primary|primaryPreferred|secondary|secondaryPreferred|nearest)

      • Optional tags: TagSet[]
        @@ -18,11 +18,11 @@

        The string representing the read preference mode.

      Returns boolean

    secondaryOk

    • secondaryOk(): boolean

    slaveOk

    • slaveOk(): boolean

    toJSON

    Static fromOptions

    Hierarchy

    • WriteConcern

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new WriteConcern(w?: W, wtimeout?: number, j?: boolean, fsync?: boolean | 1): WriteConcern

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    @@ -79,7 +79,7 @@

    The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).

    Optional resumeAfter

    resumeAfter?: unknown

    Allows you to start a changeStream after a specified event.

    -
    see

    https://docs.mongodb.com/manual/changeStreams/#resumeafter-for-change-streams

    +
    see

    https://www.mongodb.com/docs/manual/changeStreams/#resumeafter-for-change-streams

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean
    @@ -99,7 +99,7 @@

    Optional startAfter

    startAfter?: unknown

    Similar to resumeAfter, but will allow you to start after an invalidated event.

    -
    see

    https://docs.mongodb.com/manual/changeStreams/#startafter-for-change-streams

    +
    see

    https://www.mongodb.com/docs/manual/changeStreams/#startafter-for-change-streams

    Optional startAtOperationTime

    startAtOperationTime?: Timestamp

    Will start the changeStream after the specified operationTime.

    Optional willRetryWrite

    willRetryWrite?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    diff --git a/docs/4.12/interfaces/CollStats.html b/docs/4.12/interfaces/CollStats.html index eac0d09c8d0..351a4d4cb12 100644 --- a/docs/4.12/interfaces/CollStats.html +++ b/docs/4.12/interfaces/CollStats.html @@ -1,4 +1,4 @@ -CollStats | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CollStats

    see

    https://docs.mongodb.org/manual/reference/command/collStats/

    +CollStats | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CollStats

    see

    https://www.mongodb.com/docs/manual/reference/command/collStats/

    Hierarchy

    Index

    Properties

    Properties

    avgObjSize

    avgObjSize: number

    Average object size in bytes

    capped

    capped: boolean
    diff --git a/docs/4.12/interfaces/CountDocumentsOptions.html b/docs/4.12/interfaces/CountDocumentsOptions.html index 38f3a34e1e2..31e355e3937 100644 --- a/docs/4.12/interfaces/CountDocumentsOptions.html +++ b/docs/4.12/interfaces/CountDocumentsOptions.html @@ -1,7 +1,7 @@ CountDocumentsOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CountDocumentsOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional allowDiskUse

    allowDiskUse?: boolean

    allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).

    Optional authdb

    authdb?: string

    Optional batchSize

    batchSize?: number
    -

    The number of documents to return per batch. See aggregation documentation.

    +

    The number of documents to return per batch. See aggregation documentation.

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    diff --git a/docs/4.12/interfaces/FindOneAndDeleteOptions.html b/docs/4.12/interfaces/FindOneAndDeleteOptions.html index c0d6d04dfb9..cb1427afc66 100644 --- a/docs/4.12/interfaces/FindOneAndDeleteOptions.html +++ b/docs/4.12/interfaces/FindOneAndDeleteOptions.html @@ -17,7 +17,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.12/interfaces/FindOneAndReplaceOptions.html b/docs/4.12/interfaces/FindOneAndReplaceOptions.html index afa4c5e065a..8ec99a5c0a2 100644 --- a/docs/4.12/interfaces/FindOneAndReplaceOptions.html +++ b/docs/4.12/interfaces/FindOneAndReplaceOptions.html @@ -19,7 +19,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.12/interfaces/FindOneAndUpdateOptions.html b/docs/4.12/interfaces/FindOneAndUpdateOptions.html index 879975bc26c..b8f2bebde54 100644 --- a/docs/4.12/interfaces/FindOneAndUpdateOptions.html +++ b/docs/4.12/interfaces/FindOneAndUpdateOptions.html @@ -21,7 +21,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.12/interfaces/MongoClientOptions.html b/docs/4.12/interfaces/MongoClientOptions.html index 602494f98bb..51ffb6d952c 100644 --- a/docs/4.12/interfaces/MongoClientOptions.html +++ b/docs/4.12/interfaces/MongoClientOptions.html @@ -1,6 +1,6 @@ MongoClientOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MongoClientOptions

    Describes all possible URI query options for the mongo client

    -
    see

    https://docs.mongodb.com/manual/reference/connection-string

    +
    see

    https://www.mongodb.com/docs/manual/reference/connection-string

    Hierarchy

    Index

    Properties

    Properties

    Optional ALPNProtocols

    ALPNProtocols?: string[] | Uint8Array | Uint8Array[]

    An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

    @@ -18,7 +18,7 @@

    Optionally enable in-use auto encryption

    remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    -

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    +

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    • AutoEncryptionOptions.keyVaultClient is not passed.
      • @@ -259,7 +259,7 @@

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    A MongoDB WriteConcern, which describes the level of acknowledgement requested from MongoDB for write operations.

    -
    see

    https://docs.mongodb.com/manual/reference/write-concern/

    +
    see

    https://www.mongodb.com/docs/manual/reference/write-concern/

    Optional wtimeoutMS

    wtimeoutMS?: number

    The write concern timeout

    deprecated

    Please use the writeConcern option instead

    diff --git a/docs/4.12/interfaces/MongoOptions.html b/docs/4.12/interfaces/MongoOptions.html index 1f2297c7c7c..fefb4ff8ced 100644 --- a/docs/4.12/interfaces/MongoOptions.html +++ b/docs/4.12/interfaces/MongoOptions.html @@ -7,7 +7,7 @@

    Optionally enable in-use auto encryption

    remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    -

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    +

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    NumericType

    NumericType: IntegerType | Decimal128 | Double

    OneOrMore

    OneOrMore<T>: T | ReadonlyArray<T>

    Type parameters

    • T

    OnlyFieldsOfType

    OnlyFieldsOfType<TSchema, FieldType, AssignableType>: IsAny<TSchema[keyof TSchema], Record<string, FieldType>, AcceptedFields<TSchema, FieldType, AssignableType> & NotAcceptedFields<TSchema, FieldType> & Record<string, AssignableType>>

    Type parameters

    • TSchema

    • FieldType = any

    • AssignableType = FieldType

    OperationTime

    OperationTime: Timestamp

    Represents a specific point in time on a server. Can be retrieved by using db.command()

    -
    see

    https://docs.mongodb.com/manual/reference/method/db.runCommand/#response

    +
    see

    https://www.mongodb.com/docs/manual/reference/method/db.runCommand/#response

    OptionalId

    OptionalId<TSchema>: EnhancedOmit<TSchema, "_id"> & { _id?: InferIdType<TSchema> }

    Add an optional _id field to an object shaped type

    Type parameters

    • TSchema

    OptionalUnlessRequiredId

    OptionalUnlessRequiredId<TSchema>: TSchema extends { _id: any } ? TSchema : OptionalId<TSchema>
    diff --git a/docs/4.13/classes/AbstractCursor.html b/docs/4.13/classes/AbstractCursor.html index dcaf7cc13dd..1bc841027bd 100644 --- a/docs/4.13/classes/AbstractCursor.html +++ b/docs/4.13/classes/AbstractCursor.html @@ -16,7 +16,7 @@

    Returns AbstractCursor<TSchema, CursorEvents>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    Abstract clone

    • diff --git a/docs/4.13/classes/AggregationCursor.html b/docs/4.13/classes/AggregationCursor.html index b38da6e3d76..4c51dc57704 100644 --- a/docs/4.13/classes/AggregationCursor.html +++ b/docs/4.13/classes/AggregationCursor.html @@ -21,7 +21,7 @@

    Returns AggregationCursor<TSchema>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    mapReduce

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.13/classes/Db.html b/docs/4.13/classes/Db.html index b9fb91af854..738c4ee6aa2 100644 --- a/docs/4.13/classes/Db.html +++ b/docs/4.13/classes/Db.html @@ -52,7 +52,7 @@

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    Parameters

    Returns void

    • createCollection

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.13/classes/FindCursor.html b/docs/4.13/classes/FindCursor.html index 7929617a400..480369259d8 100644 --- a/docs/4.13/classes/FindCursor.html +++ b/docs/4.13/classes/FindCursor.html @@ -21,11 +21,11 @@

    The modifier value.

    Returns FindCursor<TSchema>

    allowDiskUse

    • allowDiskUse(allow?: boolean): FindCursor<TSchema>

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.13/classes/ListCollectionsCursor.html b/docs/4.13/classes/ListCollectionsCursor.html index fe56b0d2433..c9e2c6f031d 100644 --- a/docs/4.13/classes/ListCollectionsCursor.html +++ b/docs/4.13/classes/ListCollectionsCursor.html @@ -16,7 +16,7 @@

    Returns ListCollectionsCursor<T>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.13/classes/ListIndexesCursor.html b/docs/4.13/classes/ListIndexesCursor.html index b90aeaab2ed..3212196e7df 100644 --- a/docs/4.13/classes/ListIndexesCursor.html +++ b/docs/4.13/classes/ListIndexesCursor.html @@ -16,7 +16,7 @@

    Returns ListIndexesCursor

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    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.

      +

      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>

    withSession

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

    • Static connect

    Static getEventListeners

    • getEventListeners(emitter: EventEmitter | _DOMEventTarget, name: string | symbol): Function[]

    Hierarchy

    • ReadConcern

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    level

    level: string

    Accessors

    Static AVAILABLE

    • get AVAILABLE(): "available"

    Static LINEARIZABLE

    • get LINEARIZABLE(): "linearizable"

    Static MAJORITY

    • get MAJORITY(): "majority"

    Static SNAPSHOT

    • get SNAPSHOT(): "snapshot"

    Methods

    toJSON

    Static fromOptions

    Hierarchy

    • ReadPreference

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • Parameters

      • mode: ReadPreferenceMode

        A string describing the read preference mode (primary|primaryPreferred|secondary|secondaryPreferred|nearest)

      • Optional tags: TagSet[]
        @@ -18,11 +18,11 @@

        The string representing the read preference mode.

      Returns boolean

    secondaryOk

    • secondaryOk(): boolean

    slaveOk

    • slaveOk(): boolean

    toJSON

    Static fromOptions

    Hierarchy

    • WriteConcern

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new WriteConcern(w?: W, wtimeout?: number, j?: boolean, fsync?: boolean | 1): WriteConcern

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    @@ -79,7 +79,7 @@

    The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).

    Optional resumeAfter

    resumeAfter?: unknown

    Allows you to start a changeStream after a specified event.

    -
    see

    https://docs.mongodb.com/manual/changeStreams/#resumeafter-for-change-streams

    +
    see

    https://www.mongodb.com/docs/manual/changeStreams/#resumeafter-for-change-streams

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean
    @@ -99,7 +99,7 @@

    Optional startAfter

    startAfter?: unknown

    Similar to resumeAfter, but will allow you to start after an invalidated event.

    -
    see

    https://docs.mongodb.com/manual/changeStreams/#startafter-for-change-streams

    +
    see

    https://www.mongodb.com/docs/manual/changeStreams/#startafter-for-change-streams

    Optional startAtOperationTime

    startAtOperationTime?: Timestamp

    Will start the changeStream after the specified operationTime.

    Optional willRetryWrite

    willRetryWrite?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    diff --git a/docs/4.13/interfaces/CollStats.html b/docs/4.13/interfaces/CollStats.html index 6db9e47d1c2..3bb068c8568 100644 --- a/docs/4.13/interfaces/CollStats.html +++ b/docs/4.13/interfaces/CollStats.html @@ -1,4 +1,4 @@ -CollStats | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CollStats

    see

    https://docs.mongodb.org/manual/reference/command/collStats/

    +CollStats | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CollStats

    see

    https://www.mongodb.com/docs/manual/reference/command/collStats/

    Hierarchy

    Index

    Properties

    Properties

    avgObjSize

    avgObjSize: number

    Average object size in bytes

    capped

    capped: boolean
    diff --git a/docs/4.13/interfaces/CountDocumentsOptions.html b/docs/4.13/interfaces/CountDocumentsOptions.html index 49cdf59f971..b4fbdc6a7b6 100644 --- a/docs/4.13/interfaces/CountDocumentsOptions.html +++ b/docs/4.13/interfaces/CountDocumentsOptions.html @@ -1,7 +1,7 @@ CountDocumentsOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CountDocumentsOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional allowDiskUse

    allowDiskUse?: boolean

    allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).

    Optional authdb

    authdb?: string

    Optional batchSize

    batchSize?: number
    -

    The number of documents to return per batch. See aggregation documentation.

    +

    The number of documents to return per batch. See aggregation documentation.

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    diff --git a/docs/4.13/interfaces/FindOneAndDeleteOptions.html b/docs/4.13/interfaces/FindOneAndDeleteOptions.html index 41645b162fc..4a1c874002d 100644 --- a/docs/4.13/interfaces/FindOneAndDeleteOptions.html +++ b/docs/4.13/interfaces/FindOneAndDeleteOptions.html @@ -17,7 +17,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.13/interfaces/FindOneAndReplaceOptions.html b/docs/4.13/interfaces/FindOneAndReplaceOptions.html index deedbe984e2..ffa13fef913 100644 --- a/docs/4.13/interfaces/FindOneAndReplaceOptions.html +++ b/docs/4.13/interfaces/FindOneAndReplaceOptions.html @@ -19,7 +19,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.13/interfaces/FindOneAndUpdateOptions.html b/docs/4.13/interfaces/FindOneAndUpdateOptions.html index 487cadbfeae..14421eb8486 100644 --- a/docs/4.13/interfaces/FindOneAndUpdateOptions.html +++ b/docs/4.13/interfaces/FindOneAndUpdateOptions.html @@ -21,7 +21,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.13/interfaces/MongoClientOptions.html b/docs/4.13/interfaces/MongoClientOptions.html index 94813ca4f08..877de43fa4e 100644 --- a/docs/4.13/interfaces/MongoClientOptions.html +++ b/docs/4.13/interfaces/MongoClientOptions.html @@ -1,6 +1,6 @@ MongoClientOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MongoClientOptions

    Describes all possible URI query options for the mongo client

    -
    see

    https://docs.mongodb.com/manual/reference/connection-string

    +
    see

    https://www.mongodb.com/docs/manual/reference/connection-string

    Hierarchy

    Index

    Properties

    Properties

    Optional ALPNProtocols

    ALPNProtocols?: string[] | Uint8Array | Uint8Array[]

    An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

    @@ -18,7 +18,7 @@

    Optionally enable in-use auto encryption

    remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    -

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    +

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    • AutoEncryptionOptions.keyVaultClient is not passed.
      • @@ -259,7 +259,7 @@

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    A MongoDB WriteConcern, which describes the level of acknowledgement requested from MongoDB for write operations.

    -
    see

    https://docs.mongodb.com/manual/reference/write-concern/

    +
    see

    https://www.mongodb.com/docs/manual/reference/write-concern/

    Optional wtimeoutMS

    wtimeoutMS?: number

    The write concern timeout

    deprecated

    Please use the writeConcern option instead

    diff --git a/docs/4.13/interfaces/MongoOptions.html b/docs/4.13/interfaces/MongoOptions.html index 91c7e01d7ab..da70479bce3 100644 --- a/docs/4.13/interfaces/MongoOptions.html +++ b/docs/4.13/interfaces/MongoOptions.html @@ -7,7 +7,7 @@

    Optionally enable in-use auto encryption

    remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    -

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    +

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    NumericType

    NumericType: IntegerType | Decimal128 | Double

    OneOrMore

    OneOrMore<T>: T | ReadonlyArray<T>

    Type parameters

    • T

    OnlyFieldsOfType

    OnlyFieldsOfType<TSchema, FieldType, AssignableType>: IsAny<TSchema[keyof TSchema], Record<string, FieldType>, AcceptedFields<TSchema, FieldType, AssignableType> & NotAcceptedFields<TSchema, FieldType> & Record<string, AssignableType>>

    Type parameters

    • TSchema

    • FieldType = any

    • AssignableType = FieldType

    OperationTime

    OperationTime: Timestamp

    Represents a specific point in time on a server. Can be retrieved by using db.command()

    -
    see

    https://docs.mongodb.com/manual/reference/method/db.runCommand/#response

    +
    see

    https://www.mongodb.com/docs/manual/reference/method/db.runCommand/#response

    OptionalId

    OptionalId<TSchema>: EnhancedOmit<TSchema, "_id"> & { _id?: InferIdType<TSchema> }

    Add an optional _id field to an object shaped type

    Type parameters

    • TSchema

    OptionalUnlessRequiredId

    OptionalUnlessRequiredId<TSchema>: TSchema extends { _id: any } ? TSchema : OptionalId<TSchema>
    diff --git a/docs/4.14/classes/AbstractCursor.html b/docs/4.14/classes/AbstractCursor.html index 17ac276d044..3a3d00e94ed 100644 --- a/docs/4.14/classes/AbstractCursor.html +++ b/docs/4.14/classes/AbstractCursor.html @@ -16,7 +16,7 @@

    Returns AbstractCursor<TSchema, CursorEvents>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    Abstract clone

    • diff --git a/docs/4.14/classes/AggregationCursor.html b/docs/4.14/classes/AggregationCursor.html index 7d7a7d9dac6..28fb13f39eb 100644 --- a/docs/4.14/classes/AggregationCursor.html +++ b/docs/4.14/classes/AggregationCursor.html @@ -21,7 +21,7 @@

    Returns AggregationCursor<TSchema>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    mapReduce

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.14/classes/Db.html b/docs/4.14/classes/Db.html index afb8159bfb9..8f8da9bb603 100644 --- a/docs/4.14/classes/Db.html +++ b/docs/4.14/classes/Db.html @@ -53,7 +53,7 @@

    Parameters

    Returns void

  • deprecated

    Callbacks are deprecated and will be removed in the next major version. See mongodb-legacy for migration assistance

    Parameters

    Returns void

    • createCollection

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.14/classes/FindCursor.html b/docs/4.14/classes/FindCursor.html index b4966bbf81b..f1a07d41a57 100644 --- a/docs/4.14/classes/FindCursor.html +++ b/docs/4.14/classes/FindCursor.html @@ -21,11 +21,11 @@

    The modifier value.

    Returns FindCursor<TSchema>

    allowDiskUse

    • allowDiskUse(allow?: boolean): FindCursor<TSchema>

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.14/classes/ListCollectionsCursor.html b/docs/4.14/classes/ListCollectionsCursor.html index dcce52b43fd..b3202c77d3e 100644 --- a/docs/4.14/classes/ListCollectionsCursor.html +++ b/docs/4.14/classes/ListCollectionsCursor.html @@ -16,7 +16,7 @@

    Returns ListCollectionsCursor<T>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.14/classes/ListIndexesCursor.html b/docs/4.14/classes/ListIndexesCursor.html index c942eec33a3..d121c064045 100644 --- a/docs/4.14/classes/ListIndexesCursor.html +++ b/docs/4.14/classes/ListIndexesCursor.html @@ -16,7 +16,7 @@

    Returns ListIndexesCursor

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    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.

      +

      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>

    withSession

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

    • Static connect

    Static getEventListeners

    • getEventListeners(emitter: EventEmitter | _DOMEventTarget, name: string | symbol): Function[]

    Hierarchy

    • ReadConcern

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    level

    level: string

    Accessors

    Static AVAILABLE

    • get AVAILABLE(): "available"

    Static LINEARIZABLE

    • get LINEARIZABLE(): "linearizable"

    Static MAJORITY

    • get MAJORITY(): "majority"

    Static SNAPSHOT

    • get SNAPSHOT(): "snapshot"

    Methods

    toJSON

    Static fromOptions

    Hierarchy

    • ReadPreference

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • Parameters

      • mode: ReadPreferenceMode

        A string describing the read preference mode (primary|primaryPreferred|secondary|secondaryPreferred|nearest)

      • Optional tags: TagSet[]
        @@ -18,11 +18,11 @@

        The string representing the read preference mode.

      Returns boolean

    secondaryOk

    • secondaryOk(): boolean

    slaveOk

    • slaveOk(): boolean

    toJSON

    Static fromOptions

    Hierarchy

    • WriteConcern

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new WriteConcern(w?: W, wtimeout?: number, j?: boolean, fsync?: boolean | 1): WriteConcern

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    @@ -79,7 +79,7 @@

    The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).

    Optional resumeAfter

    resumeAfter?: unknown

    Allows you to start a changeStream after a specified event.

    -
    see

    https://docs.mongodb.com/manual/changeStreams/#resumeafter-for-change-streams

    +
    see

    https://www.mongodb.com/docs/manual/changeStreams/#resumeafter-for-change-streams

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean
    @@ -99,7 +99,7 @@

    Optional startAfter

    startAfter?: unknown

    Similar to resumeAfter, but will allow you to start after an invalidated event.

    -
    see

    https://docs.mongodb.com/manual/changeStreams/#startafter-for-change-streams

    +
    see

    https://www.mongodb.com/docs/manual/changeStreams/#startafter-for-change-streams

    Optional startAtOperationTime

    startAtOperationTime?: Timestamp

    Will start the changeStream after the specified operationTime.

    Optional willRetryWrite

    willRetryWrite?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    diff --git a/docs/4.14/interfaces/CollStats.html b/docs/4.14/interfaces/CollStats.html index e20cf93d108..58a8d090926 100644 --- a/docs/4.14/interfaces/CollStats.html +++ b/docs/4.14/interfaces/CollStats.html @@ -1,4 +1,4 @@ -CollStats | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CollStats

    see

    https://docs.mongodb.org/manual/reference/command/collStats/

    +CollStats | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CollStats

    see

    https://www.mongodb.com/docs/manual/reference/command/collStats/

    Hierarchy

    Index

    Properties

    Properties

    avgObjSize

    avgObjSize: number

    Average object size in bytes

    capped

    capped: boolean
    diff --git a/docs/4.14/interfaces/CountDocumentsOptions.html b/docs/4.14/interfaces/CountDocumentsOptions.html index 419425ae8ea..ab5c084697e 100644 --- a/docs/4.14/interfaces/CountDocumentsOptions.html +++ b/docs/4.14/interfaces/CountDocumentsOptions.html @@ -1,7 +1,7 @@ CountDocumentsOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CountDocumentsOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional allowDiskUse

    allowDiskUse?: boolean

    allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).

    Optional authdb

    authdb?: string

    Optional batchSize

    batchSize?: number
    -

    The number of documents to return per batch. See aggregation documentation.

    +

    The number of documents to return per batch. See aggregation documentation.

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    diff --git a/docs/4.14/interfaces/FindOneAndDeleteOptions.html b/docs/4.14/interfaces/FindOneAndDeleteOptions.html index bc2df737b88..37186bb40ad 100644 --- a/docs/4.14/interfaces/FindOneAndDeleteOptions.html +++ b/docs/4.14/interfaces/FindOneAndDeleteOptions.html @@ -17,7 +17,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.14/interfaces/FindOneAndReplaceOptions.html b/docs/4.14/interfaces/FindOneAndReplaceOptions.html index 2fdcc8e8026..e0399baa0b5 100644 --- a/docs/4.14/interfaces/FindOneAndReplaceOptions.html +++ b/docs/4.14/interfaces/FindOneAndReplaceOptions.html @@ -19,7 +19,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.14/interfaces/FindOneAndUpdateOptions.html b/docs/4.14/interfaces/FindOneAndUpdateOptions.html index 5cde7b60342..19def3b7083 100644 --- a/docs/4.14/interfaces/FindOneAndUpdateOptions.html +++ b/docs/4.14/interfaces/FindOneAndUpdateOptions.html @@ -21,7 +21,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.14/interfaces/MongoClientOptions.html b/docs/4.14/interfaces/MongoClientOptions.html index 1c04c2c5450..934a25d098f 100644 --- a/docs/4.14/interfaces/MongoClientOptions.html +++ b/docs/4.14/interfaces/MongoClientOptions.html @@ -1,6 +1,6 @@ MongoClientOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MongoClientOptions

    Describes all possible URI query options for the mongo client

    -
    see

    https://docs.mongodb.com/manual/reference/connection-string

    +
    see

    https://www.mongodb.com/docs/manual/reference/connection-string

    Hierarchy

    Index

    Properties

    Properties

    Optional ALPNProtocols

    ALPNProtocols?: string[] | Uint8Array | Uint8Array[]

    An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

    @@ -18,7 +18,7 @@

    Optionally enable in-use auto encryption

    remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    -

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    +

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    • AutoEncryptionOptions.keyVaultClient is not passed.
      • @@ -261,7 +261,7 @@

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    A MongoDB WriteConcern, which describes the level of acknowledgement requested from MongoDB for write operations.

    -
    see

    https://docs.mongodb.com/manual/reference/write-concern/

    +
    see

    https://www.mongodb.com/docs/manual/reference/write-concern/

    Optional wtimeoutMS

    wtimeoutMS?: number

    The write concern timeout

    deprecated

    Please use the writeConcern option instead

    diff --git a/docs/4.14/interfaces/MongoOptions.html b/docs/4.14/interfaces/MongoOptions.html index 994b59fc17a..764c8bd3b4b 100644 --- a/docs/4.14/interfaces/MongoOptions.html +++ b/docs/4.14/interfaces/MongoOptions.html @@ -7,7 +7,7 @@

    Optionally enable in-use auto encryption

    remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    -

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    +

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    NumericType

    NumericType: IntegerType | Decimal128 | Double

    OneOrMore

    OneOrMore<T>: T | ReadonlyArray<T>

    Type parameters

    • T

    OnlyFieldsOfType

    OnlyFieldsOfType<TSchema, FieldType, AssignableType>: IsAny<TSchema[keyof TSchema], Record<string, FieldType>, AcceptedFields<TSchema, FieldType, AssignableType> & NotAcceptedFields<TSchema, FieldType> & Record<string, AssignableType>>

    Type parameters

    • TSchema

    • FieldType = any

    • AssignableType = FieldType

    OperationTime

    OperationTime: Timestamp

    Represents a specific point in time on a server. Can be retrieved by using db.command()

    -
    see

    https://docs.mongodb.com/manual/reference/method/db.runCommand/#response

    +
    see

    https://www.mongodb.com/docs/manual/reference/method/db.runCommand/#response

    OptionalId

    OptionalId<TSchema>: EnhancedOmit<TSchema, "_id"> & { _id?: InferIdType<TSchema> }

    Add an optional _id field to an object shaped type

    Type parameters

    • TSchema

    OptionalUnlessRequiredId

    OptionalUnlessRequiredId<TSchema>: TSchema extends { _id: any } ? TSchema : OptionalId<TSchema>
    diff --git a/docs/4.2/classes/AbstractCursor.html b/docs/4.2/classes/AbstractCursor.html index a9569f889a6..13f2a29306c 100644 --- a/docs/4.2/classes/AbstractCursor.html +++ b/docs/4.2/classes/AbstractCursor.html @@ -16,7 +16,7 @@

    Returns AbstractCursor<TSchema, CursorEvents>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    Abstract clone

    • diff --git a/docs/4.2/classes/AggregationCursor.html b/docs/4.2/classes/AggregationCursor.html index f5abd163ddc..f640156fd48 100644 --- a/docs/4.2/classes/AggregationCursor.html +++ b/docs/4.2/classes/AggregationCursor.html @@ -21,7 +21,7 @@

    Returns AggregationCursor<TSchema>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.2/classes/ChangeStream.html b/docs/4.2/classes/ChangeStream.html index a0ddc78d7e7..c801cd98195 100644 --- a/docs/4.2/classes/ChangeStream.html +++ b/docs/4.2/classes/ChangeStream.html @@ -3,7 +3,7 @@

    Type parameters

    Hierarchy

    Index

    Constructors

    Events

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Events

    Static Readonly CHANGE

    CHANGE: "change" = ...

    Fired for each new matching change in the specified namespace. Attaching a change event listener to a Change Stream will switch the stream into flowing mode. Data will diff --git a/docs/4.2/classes/ChangeStreamCursor.html b/docs/4.2/classes/ChangeStreamCursor.html index bb4590e268b..2a31241595c 100644 --- a/docs/4.2/classes/ChangeStreamCursor.html +++ b/docs/4.2/classes/ChangeStreamCursor.html @@ -16,7 +16,7 @@

    Returns ChangeStreamCursor<TSchema>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    cacheResumeToken

    • cacheResumeToken(resumeToken: unknown): void

    clone

    createIndex

    • Creates an index on the db and collection collection.

      example
      const collection = client.db('foo').collection('bar');

      await collection.createIndex({ a: 1, b: -1 });

      // Alternate syntax for { c: 1, d: -1 } that ensures order of indexes
      await collection.createIndex([ [c, 1], [d, -1] ]);

      // Equivalent to { e: 1 }
      await collection.createIndex('e');

      // Equivalent to { f: 1, g: 1 }
      await collection.createIndex(['f', 'g'])

      // Equivalent to { h: 1, i: -1 }
      await collection.createIndex([ { h: 1 }, { i: -1 } ]);

      // Equivalent to { j: 1, k: -1, l: 2d }
      await collection.createIndex(['j', ['k', -1], { l: '2d' }])
@@ -89,7 +89,7 @@
 MongoDB 2.6 or higher. Earlier version of MongoDB will throw a command not supported
 error.

      Note: Unlike {@link Collection#createIndex| createIndex}, this function takes in raw index specifications. -Index specifications are defined here.

      +Index specifications are defined here.

      example
      const collection = client.db('foo').collection('bar');
      await collection.createIndexes([
        // Simple index on field fizz
        {
          key: { fizz: 1 },
        }
        // wildcard index
        {
          key: { '$**': 1 }
        },
        // named index on darmok and jalad
        {
          key: { darmok: 1, jalad: -1 }
          name: 'tanagra'
        }
      ]);

      Parameters

      • indexSpecs: IndexDescription[]
        @@ -181,7 +181,7 @@

        Optional settings for the command

      Returns ListIndexesCursor

    mapReduce

    • Run Map Reduce across a collection. Be aware that the inline option for out will return an array of results not a collection.

      -
      deprecated

      collection.mapReduce is deprecated. Use the aggregation pipeline instead. Visit https://docs.mongodb.com/manual/reference/map-reduce-to-aggregation-pipeline for more information on how to translate map-reduce operations to the aggregation pipeline.

      +
      deprecated

      collection.mapReduce is deprecated. Use the aggregation pipeline instead. Visit https://www.mongodb.com/docs/manual/reference/map-reduce-to-aggregation-pipeline for more information on how to translate map-reduce operations to the aggregation pipeline.

      Type parameters

      • TKey = any

      • TValue = any

      Parameters

      • map: string | MapFunction<TSchema>

        The mapping function.

      • reduce: string | ReduceFunction<TKey, TValue>
        @@ -237,7 +237,7 @@

        Create a new Change Stream, watching for new changes (insertions, updates, replacements, deletions, and invalidations) in this collection.

        since

        3.0.0

        Type parameters

        • TLocal = TSchema

        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.

          +

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

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Inherited accessor
    • Constructor
    • Property
    • Method
    • Private property
    • Private method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.2/classes/Db.html b/docs/4.2/classes/Db.html index 3f90277f93c..b6f747fc94a 100644 --- a/docs/4.2/classes/Db.html +++ b/docs/4.2/classes/Db.html @@ -39,7 +39,7 @@

    The command to run

    Returns Promise<Document>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<Document>

  • Parameters

    Returns void

    • createCollection

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Inherited accessor
    • Constructor
    • Property
    • Method
    • Private property
    • Private method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.2/classes/FindCursor.html b/docs/4.2/classes/FindCursor.html index a94c2ec56ed..5b047b0af2e 100644 --- a/docs/4.2/classes/FindCursor.html +++ b/docs/4.2/classes/FindCursor.html @@ -21,11 +21,11 @@

    The modifier value.

    Returns FindCursor<TSchema>

    allowDiskUse

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.2/classes/ListCollectionsCursor.html b/docs/4.2/classes/ListCollectionsCursor.html index 48c06afe213..ba28f4b3691 100644 --- a/docs/4.2/classes/ListCollectionsCursor.html +++ b/docs/4.2/classes/ListCollectionsCursor.html @@ -16,7 +16,7 @@

    Returns ListCollectionsCursor<T>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.2/classes/ListIndexesCursor.html b/docs/4.2/classes/ListIndexesCursor.html index 00e43d5b5cb..d68ae97404c 100644 --- a/docs/4.2/classes/ListIndexesCursor.html +++ b/docs/4.2/classes/ListIndexesCursor.html @@ -16,7 +16,7 @@

    Returns ListIndexesCursor

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.2/classes/MongoClient.html b/docs/4.2/classes/MongoClient.html index 02fef82c135..672a2b1db24 100644 --- a/docs/4.2/classes/MongoClient.html +++ b/docs/4.2/classes/MongoClient.html @@ -40,7 +40,7 @@ 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

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

        +

        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>

    withSession

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

    • Static connect

    Static getEventListeners

    • getEventListeners(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]

    Hierarchy

    • ReadConcern

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    level

    level: string

    Accessors

    Static AVAILABLE

    • get AVAILABLE(): "available"

    Static LINEARIZABLE

    • get LINEARIZABLE(): "linearizable"

    Static MAJORITY

    • get MAJORITY(): "majority"

    Static SNAPSHOT

    • get SNAPSHOT(): "snapshot"

    Methods

    toJSON

    Static fromOptions

    Hierarchy

    • ReadPreference

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • Parameters

      • mode: ReadPreferenceMode

        A string describing the read preference mode (primary|primaryPreferred|secondary|secondaryPreferred|nearest)

      • Optional tags: TagSet[]
        @@ -18,7 +18,7 @@

        The string representing the read preference mode.

      Returns boolean

    slaveOk

    • slaveOk(): boolean

    toJSON

    Static fromOptions

    Hierarchy

    • WriteConcern

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new WriteConcern(w?: W, wtimeout?: number, j?: boolean, fsync?: boolean | 1): WriteConcern

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.3/classes/ChangeStream.html b/docs/4.3/classes/ChangeStream.html index 3fbd023ae73..91b66567c5f 100644 --- a/docs/4.3/classes/ChangeStream.html +++ b/docs/4.3/classes/ChangeStream.html @@ -3,7 +3,7 @@

    Type parameters

    Hierarchy

    Index

    Constructors

    Events

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Events

    Static Readonly CHANGE

    CHANGE: "change" = ...

    Fired for each new matching change in the specified namespace. Attaching a change event listener to a Change Stream will switch the stream into flowing mode. Data will diff --git a/docs/4.3/classes/ChangeStreamCursor.html b/docs/4.3/classes/ChangeStreamCursor.html index 8ef404d3a24..e044862a2c3 100644 --- a/docs/4.3/classes/ChangeStreamCursor.html +++ b/docs/4.3/classes/ChangeStreamCursor.html @@ -16,7 +16,7 @@

    Returns ChangeStreamCursor<TSchema>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    cacheResumeToken

    • cacheResumeToken(resumeToken: unknown): void

    clone

    createIndex

    • Creates an index on the db and collection collection.

      example
      const collection = client.db('foo').collection('bar');

      await collection.createIndex({ a: 1, b: -1 });

      // Alternate syntax for { c: 1, d: -1 } that ensures order of indexes
      await collection.createIndex([ [c, 1], [d, -1] ]);

      // Equivalent to { e: 1 }
      await collection.createIndex('e');

      // Equivalent to { f: 1, g: 1 }
      await collection.createIndex(['f', 'g'])

      // Equivalent to { h: 1, i: -1 }
      await collection.createIndex([ { h: 1 }, { i: -1 } ]);

      // Equivalent to { j: 1, k: -1, l: 2d }
      await collection.createIndex(['j', ['k', -1], { l: '2d' }])
@@ -89,7 +89,7 @@
 MongoDB 2.6 or higher. Earlier version of MongoDB will throw a command not supported
 error.

      Note: Unlike {@link Collection#createIndex| createIndex}, this function takes in raw index specifications. -Index specifications are defined here.

      +Index specifications are defined here.

      example
      const collection = client.db('foo').collection('bar');
      await collection.createIndexes([
        // Simple index on field fizz
        {
          key: { fizz: 1 },
        }
        // wildcard index
        {
          key: { '$**': 1 }
        },
        // named index on darmok and jalad
        {
          key: { darmok: 1, jalad: -1 }
          name: 'tanagra'
        }
      ]);

      Parameters

      • indexSpecs: IndexDescription[]
        @@ -181,7 +181,7 @@

        Optional settings for the command

      Returns ListIndexesCursor

    mapReduce

    • Run Map Reduce across a collection. Be aware that the inline option for out will return an array of results not a collection.

      -
      deprecated

      collection.mapReduce is deprecated. Use the aggregation pipeline instead. Visit https://docs.mongodb.com/manual/reference/map-reduce-to-aggregation-pipeline for more information on how to translate map-reduce operations to the aggregation pipeline.

      +
      deprecated

      collection.mapReduce is deprecated. Use the aggregation pipeline instead. Visit https://www.mongodb.com/docs/manual/reference/map-reduce-to-aggregation-pipeline for more information on how to translate map-reduce operations to the aggregation pipeline.

      Type parameters

      • TKey = any

      • TValue = any

      Parameters

      • map: string | MapFunction<TSchema>

        The mapping function.

      • reduce: string | ReduceFunction<TKey, TValue>
        @@ -237,7 +237,7 @@

        Create a new Change Stream, watching for new changes (insertions, updates, replacements, deletions, and invalidations) in this collection.

        since

        3.0.0

        Type parameters

        • TLocal = TSchema

        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.

          +

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

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Inherited accessor
    • Constructor
    • Property
    • Method
    • Private property
    • Private method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.3/classes/Db.html b/docs/4.3/classes/Db.html index 0643125ce09..90a57529365 100644 --- a/docs/4.3/classes/Db.html +++ b/docs/4.3/classes/Db.html @@ -44,7 +44,7 @@

    The command to run

    Returns Promise<Document>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<Document>

  • Parameters

    Returns void

    • createCollection

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Inherited accessor
    • Constructor
    • Property
    • Method
    • Private property
    • Private method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.3/classes/FindCursor.html b/docs/4.3/classes/FindCursor.html index 4124d14387e..912b9f1c61f 100644 --- a/docs/4.3/classes/FindCursor.html +++ b/docs/4.3/classes/FindCursor.html @@ -21,11 +21,11 @@

    The modifier value.

    Returns FindCursor<TSchema>

    allowDiskUse

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.3/classes/ListCollectionsCursor.html b/docs/4.3/classes/ListCollectionsCursor.html index c0155684649..0e912b9e775 100644 --- a/docs/4.3/classes/ListCollectionsCursor.html +++ b/docs/4.3/classes/ListCollectionsCursor.html @@ -16,7 +16,7 @@

    Returns ListCollectionsCursor<T>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.3/classes/ListIndexesCursor.html b/docs/4.3/classes/ListIndexesCursor.html index 9d248b344ab..ceb104a6679 100644 --- a/docs/4.3/classes/ListIndexesCursor.html +++ b/docs/4.3/classes/ListIndexesCursor.html @@ -16,7 +16,7 @@

    Returns ListIndexesCursor

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.3/classes/MongoClient.html b/docs/4.3/classes/MongoClient.html index 355dc9004a8..2187e185b6d 100644 --- a/docs/4.3/classes/MongoClient.html +++ b/docs/4.3/classes/MongoClient.html @@ -40,7 +40,7 @@ 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

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

        +

        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>

    withSession

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

    • Static connect

    Static getEventListeners

    • getEventListeners(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]

    Hierarchy

    • ReadConcern

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    level

    level: string

    Accessors

    Static AVAILABLE

    • get AVAILABLE(): "available"

    Static LINEARIZABLE

    • get LINEARIZABLE(): "linearizable"

    Static MAJORITY

    • get MAJORITY(): "majority"

    Static SNAPSHOT

    • get SNAPSHOT(): "snapshot"

    Methods

    toJSON

    Static fromOptions

    Hierarchy

    • ReadPreference

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • Parameters

      • mode: ReadPreferenceMode

        A string describing the read preference mode (primary|primaryPreferred|secondary|secondaryPreferred|nearest)

      • Optional tags: TagSet[]
        @@ -18,11 +18,11 @@

        The string representing the read preference mode.

      Returns boolean

    secondaryOk

    • secondaryOk(): boolean

    slaveOk

    • slaveOk(): boolean

    toJSON

    Static fromOptions

    Hierarchy

    • WriteConcern

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new WriteConcern(w?: W, wtimeout?: number, j?: boolean, fsync?: boolean | 1): WriteConcern

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.4/classes/ChangeStream.html b/docs/4.4/classes/ChangeStream.html index 5bd600a2ffe..df3f49d027d 100644 --- a/docs/4.4/classes/ChangeStream.html +++ b/docs/4.4/classes/ChangeStream.html @@ -3,7 +3,7 @@

    Type parameters

    Hierarchy

    Index

    Constructors

    Events

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Events

    Static Readonly CHANGE

    CHANGE: "change" = ...

    Fired for each new matching change in the specified namespace. Attaching a change event listener to a Change Stream will switch the stream into flowing mode. Data will diff --git a/docs/4.4/classes/ChangeStreamCursor.html b/docs/4.4/classes/ChangeStreamCursor.html index 75b8caa8fe7..831019e2dfb 100644 --- a/docs/4.4/classes/ChangeStreamCursor.html +++ b/docs/4.4/classes/ChangeStreamCursor.html @@ -16,7 +16,7 @@

    Returns ChangeStreamCursor<TSchema>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    cacheResumeToken

    • cacheResumeToken(resumeToken: unknown): void

    clone

    createIndex

    • Creates an index on the db and collection collection.

      example
      const collection = client.db('foo').collection('bar');

      await collection.createIndex({ a: 1, b: -1 });

      // Alternate syntax for { c: 1, d: -1 } that ensures order of indexes
      await collection.createIndex([ [c, 1], [d, -1] ]);

      // Equivalent to { e: 1 }
      await collection.createIndex('e');

      // Equivalent to { f: 1, g: 1 }
      await collection.createIndex(['f', 'g'])

      // Equivalent to { h: 1, i: -1 }
      await collection.createIndex([ { h: 1 }, { i: -1 } ]);

      // Equivalent to { j: 1, k: -1, l: 2d }
      await collection.createIndex(['j', ['k', -1], { l: '2d' }])
@@ -89,7 +89,7 @@
 MongoDB 2.6 or higher. Earlier version of MongoDB will throw a command not supported
 error.

      Note: Unlike {@link Collection#createIndex| createIndex}, this function takes in raw index specifications. -Index specifications are defined here.

      +Index specifications are defined here.

      example
      const collection = client.db('foo').collection('bar');
      await collection.createIndexes([
        // Simple index on field fizz
        {
          key: { fizz: 1 },
        }
        // wildcard index
        {
          key: { '$**': 1 }
        },
        // named index on darmok and jalad
        {
          key: { darmok: 1, jalad: -1 }
          name: 'tanagra'
        }
      ]);

      Parameters

      • indexSpecs: IndexDescription[]
        @@ -181,7 +181,7 @@

        Optional settings for the command

      Returns ListIndexesCursor

    mapReduce

    • Run Map Reduce across a collection. Be aware that the inline option for out will return an array of results not a collection.

      -
      deprecated

      collection.mapReduce is deprecated. Use the aggregation pipeline instead. Visit https://docs.mongodb.com/manual/reference/map-reduce-to-aggregation-pipeline for more information on how to translate map-reduce operations to the aggregation pipeline.

      +
      deprecated

      collection.mapReduce is deprecated. Use the aggregation pipeline instead. Visit https://www.mongodb.com/docs/manual/reference/map-reduce-to-aggregation-pipeline for more information on how to translate map-reduce operations to the aggregation pipeline.

      Type parameters

      • TKey = any

      • TValue = any

      Parameters

      • map: string | MapFunction<TSchema>

        The mapping function.

      • reduce: string | ReduceFunction<TKey, TValue>
        @@ -237,7 +237,7 @@

        Create a new Change Stream, watching for new changes (insertions, updates, replacements, deletions, and invalidations) in this collection.

        since

        3.0.0

        Type parameters

        • TLocal = TSchema

        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.

          +

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

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Inherited accessor
    • Constructor
    • Property
    • Method
    • Private property
    • Private method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.4/classes/Db.html b/docs/4.4/classes/Db.html index b8f9e775821..40b46facaab 100644 --- a/docs/4.4/classes/Db.html +++ b/docs/4.4/classes/Db.html @@ -44,7 +44,7 @@

    The command to run

    Returns Promise<Document>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<Document>

  • Parameters

    Returns void

    • createCollection

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Inherited accessor
    • Constructor
    • Property
    • Method
    • Private property
    • Private method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.4/classes/FindCursor.html b/docs/4.4/classes/FindCursor.html index 65790e7189e..d97f54dfefa 100644 --- a/docs/4.4/classes/FindCursor.html +++ b/docs/4.4/classes/FindCursor.html @@ -21,11 +21,11 @@

    The modifier value.

    Returns FindCursor<TSchema>

    allowDiskUse

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.4/classes/ListCollectionsCursor.html b/docs/4.4/classes/ListCollectionsCursor.html index 2d5e51df356..c5870f431b0 100644 --- a/docs/4.4/classes/ListCollectionsCursor.html +++ b/docs/4.4/classes/ListCollectionsCursor.html @@ -16,7 +16,7 @@

    Returns ListCollectionsCursor<T>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.4/classes/ListIndexesCursor.html b/docs/4.4/classes/ListIndexesCursor.html index f90b17fa34e..f0b8f8b01ac 100644 --- a/docs/4.4/classes/ListIndexesCursor.html +++ b/docs/4.4/classes/ListIndexesCursor.html @@ -16,7 +16,7 @@

    Returns ListIndexesCursor

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.4/classes/MongoClient.html b/docs/4.4/classes/MongoClient.html index c2b9787434d..38fbf18e32d 100644 --- a/docs/4.4/classes/MongoClient.html +++ b/docs/4.4/classes/MongoClient.html @@ -40,7 +40,7 @@ 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

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

        +

        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>

    withSession

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

    • Static connect

    Static getEventListeners

    • getEventListeners(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]

    Hierarchy

    • ReadConcern

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    level

    level: string

    Accessors

    Static AVAILABLE

    • get AVAILABLE(): "available"

    Static LINEARIZABLE

    • get LINEARIZABLE(): "linearizable"

    Static MAJORITY

    • get MAJORITY(): "majority"

    Static SNAPSHOT

    • get SNAPSHOT(): "snapshot"

    Methods

    toJSON

    Static fromOptions

    Hierarchy

    • ReadPreference

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • Parameters

      • mode: ReadPreferenceMode

        A string describing the read preference mode (primary|primaryPreferred|secondary|secondaryPreferred|nearest)

      • Optional tags: TagSet[]
        @@ -18,11 +18,11 @@

        The string representing the read preference mode.

      Returns boolean

    secondaryOk

    • secondaryOk(): boolean

    slaveOk

    • slaveOk(): boolean

    toJSON

    Static fromOptions

    Hierarchy

    • WriteConcern

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new WriteConcern(w?: W, wtimeout?: number, j?: boolean, fsync?: boolean | 1): WriteConcern

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    createIndex

    • Creates an index on the db and collection collection.

      example
      const collection = client.db('foo').collection('bar');

      await collection.createIndex({ a: 1, b: -1 });

      // Alternate syntax for { c: 1, d: -1 } that ensures order of indexes
      await collection.createIndex([ [c, 1], [d, -1] ]);

      // Equivalent to { e: 1 }
      await collection.createIndex('e');

      // Equivalent to { f: 1, g: 1 }
      await collection.createIndex(['f', 'g'])

      // Equivalent to { h: 1, i: -1 }
      await collection.createIndex([ { h: 1 }, { i: -1 } ]);

      // Equivalent to { j: 1, k: -1, l: 2d }
      await collection.createIndex(['j', ['k', -1], { l: '2d' }])
@@ -87,7 +87,7 @@
 MongoDB 2.6 or higher. Earlier version of MongoDB will throw a command not supported
 error.

      Note: Unlike {@link Collection#createIndex| createIndex}, this function takes in raw index specifications. -Index specifications are defined here.

      +Index specifications are defined here.

      example
      const collection = client.db('foo').collection('bar');
      await collection.createIndexes([
        // Simple index on field fizz
        {
          key: { fizz: 1 },
        }
        // wildcard index
        {
          key: { '$**': 1 }
        },
        // named index on darmok and jalad
        {
          key: { darmok: 1, jalad: -1 }
          name: 'tanagra'
        }
      ]);

      Parameters

      • indexSpecs: IndexDescription[]
        @@ -179,7 +179,7 @@

        Optional settings for the command

      Returns ListIndexesCursor

    mapReduce

    • Run Map Reduce across a collection. Be aware that the inline option for out will return an array of results not a collection.

      -
      deprecated

      collection.mapReduce is deprecated. Use the aggregation pipeline instead. Visit https://docs.mongodb.com/manual/reference/map-reduce-to-aggregation-pipeline for more information on how to translate map-reduce operations to the aggregation pipeline.

      +
      deprecated

      collection.mapReduce is deprecated. Use the aggregation pipeline instead. Visit https://www.mongodb.com/docs/manual/reference/map-reduce-to-aggregation-pipeline for more information on how to translate map-reduce operations to the aggregation pipeline.

      Type parameters

      • TKey = any

      • TValue = any

      Parameters

      • map: string | MapFunction<TSchema>

        The mapping function.

      • reduce: string | ReduceFunction<TKey, TValue>
        @@ -235,7 +235,7 @@

        Create a new Change Stream, watching for new changes (insertions, updates, replacements, deletions, and invalidations) in this collection.

        since

        3.0.0

        Type parameters

        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.

          +

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

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method
    • Private property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.5/classes/Db.html b/docs/4.5/classes/Db.html index 50fdb6fcb73..9b1cb967fc7 100644 --- a/docs/4.5/classes/Db.html +++ b/docs/4.5/classes/Db.html @@ -44,7 +44,7 @@

    The command to run

    Returns Promise<Document>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<Document>

  • Parameters

    Returns void

    • createCollection

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method
    • Private property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.5/classes/FindCursor.html b/docs/4.5/classes/FindCursor.html index e185822f386..c0bf9405257 100644 --- a/docs/4.5/classes/FindCursor.html +++ b/docs/4.5/classes/FindCursor.html @@ -21,11 +21,11 @@

    The modifier value.

    Returns FindCursor<TSchema>

    allowDiskUse

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.5/classes/ListCollectionsCursor.html b/docs/4.5/classes/ListCollectionsCursor.html index ca17ddea765..a453233ff53 100644 --- a/docs/4.5/classes/ListCollectionsCursor.html +++ b/docs/4.5/classes/ListCollectionsCursor.html @@ -16,7 +16,7 @@

    Returns ListCollectionsCursor<T>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.5/classes/ListIndexesCursor.html b/docs/4.5/classes/ListIndexesCursor.html index bcc154aaf59..8d8684d0917 100644 --- a/docs/4.5/classes/ListIndexesCursor.html +++ b/docs/4.5/classes/ListIndexesCursor.html @@ -16,7 +16,7 @@

    Returns ListIndexesCursor

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.5/classes/MongoClient.html b/docs/4.5/classes/MongoClient.html index bd9fd6dac15..6ca61891454 100644 --- a/docs/4.5/classes/MongoClient.html +++ b/docs/4.5/classes/MongoClient.html @@ -34,7 +34,7 @@ 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

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

        +

        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>

    withSession

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

    • Static connect

    Static getEventListeners

    • getEventListeners(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]

    Hierarchy

    • ReadConcern

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    level

    level: string

    Accessors

    Static AVAILABLE

    • get AVAILABLE(): "available"

    Static LINEARIZABLE

    • get LINEARIZABLE(): "linearizable"

    Static MAJORITY

    • get MAJORITY(): "majority"

    Static SNAPSHOT

    • get SNAPSHOT(): "snapshot"

    Methods

    toJSON

    Static fromOptions

    Hierarchy

    • ReadPreference

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • Parameters

      • mode: ReadPreferenceMode

        A string describing the read preference mode (primary|primaryPreferred|secondary|secondaryPreferred|nearest)

      • Optional tags: TagSet[]
        @@ -18,11 +18,11 @@

        The string representing the read preference mode.

      Returns boolean

    secondaryOk

    • secondaryOk(): boolean

    slaveOk

    • slaveOk(): boolean

    toJSON

    Static fromOptions

    Hierarchy

    • WriteConcern

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new WriteConcern(w?: W, wtimeout?: number, j?: boolean, fsync?: boolean | 1): WriteConcern

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    Abstract clone

    • diff --git a/docs/4.6/classes/AggregationCursor.html b/docs/4.6/classes/AggregationCursor.html index 31f981505b9..69076e3f701 100644 --- a/docs/4.6/classes/AggregationCursor.html +++ b/docs/4.6/classes/AggregationCursor.html @@ -21,7 +21,7 @@

    Returns AggregationCursor<TSchema>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    createIndex

    • Creates an index on the db and collection collection.

      example
      const collection = client.db('foo').collection('bar');

      await collection.createIndex({ a: 1, b: -1 });

      // Alternate syntax for { c: 1, d: -1 } that ensures order of indexes
      await collection.createIndex([ [c, 1], [d, -1] ]);

      // Equivalent to { e: 1 }
      await collection.createIndex('e');

      // Equivalent to { f: 1, g: 1 }
      await collection.createIndex(['f', 'g'])

      // Equivalent to { h: 1, i: -1 }
      await collection.createIndex([ { h: 1 }, { i: -1 } ]);

      // Equivalent to { j: 1, k: -1, l: 2d }
      await collection.createIndex(['j', ['k', -1], { l: '2d' }])
@@ -87,7 +87,7 @@
 MongoDB 2.6 or higher. Earlier version of MongoDB will throw a command not supported
 error.

      Note: Unlike {@link Collection#createIndex| createIndex}, this function takes in raw index specifications. -Index specifications are defined here.

      +Index specifications are defined here.

      example
      const collection = client.db('foo').collection('bar');
      await collection.createIndexes([
        // Simple index on field fizz
        {
          key: { fizz: 1 },
        }
        // wildcard index
        {
          key: { '$**': 1 }
        },
        // named index on darmok and jalad
        {
          key: { darmok: 1, jalad: -1 }
          name: 'tanagra'
        }
      ]);

      Parameters

      • indexSpecs: IndexDescription[]
        @@ -179,7 +179,7 @@

        Optional settings for the command

      Returns ListIndexesCursor

    mapReduce

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method
    • Private property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.6/classes/Db.html b/docs/4.6/classes/Db.html index 71e46e475e2..9af9cb64b97 100644 --- a/docs/4.6/classes/Db.html +++ b/docs/4.6/classes/Db.html @@ -44,7 +44,7 @@

    The command to run

    Returns Promise<Document>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<Document>

  • Parameters

    Returns void

    • createCollection

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method
    • Private property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.6/classes/FindCursor.html b/docs/4.6/classes/FindCursor.html index 836339b4ccf..e165cba2ab9 100644 --- a/docs/4.6/classes/FindCursor.html +++ b/docs/4.6/classes/FindCursor.html @@ -21,11 +21,11 @@

    The modifier value.

    Returns FindCursor<TSchema>

    allowDiskUse

    • allowDiskUse(allow?: boolean): FindCursor<TSchema>

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.6/classes/ListCollectionsCursor.html b/docs/4.6/classes/ListCollectionsCursor.html index 256ec2c9325..2f04d68f32b 100644 --- a/docs/4.6/classes/ListCollectionsCursor.html +++ b/docs/4.6/classes/ListCollectionsCursor.html @@ -16,7 +16,7 @@

    Returns ListCollectionsCursor<T>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.6/classes/ListIndexesCursor.html b/docs/4.6/classes/ListIndexesCursor.html index de472edc2af..a1f5efa8cb0 100644 --- a/docs/4.6/classes/ListIndexesCursor.html +++ b/docs/4.6/classes/ListIndexesCursor.html @@ -16,7 +16,7 @@

    Returns ListIndexesCursor

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.6/classes/MongoClient.html b/docs/4.6/classes/MongoClient.html index 21d69e95fe6..7f09bb52259 100644 --- a/docs/4.6/classes/MongoClient.html +++ b/docs/4.6/classes/MongoClient.html @@ -43,7 +43,7 @@

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

      +

      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>

    withSession

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

    • Static connect

    Static getEventListeners

    • getEventListeners(emitter: DOMEventTarget | EventEmitter, name: string | symbol): Function[]

    Hierarchy

    • ReadConcern

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    level

    level: string

    Accessors

    Static AVAILABLE

    • get AVAILABLE(): "available"

    Static LINEARIZABLE

    • get LINEARIZABLE(): "linearizable"

    Static MAJORITY

    • get MAJORITY(): "majority"

    Static SNAPSHOT

    • get SNAPSHOT(): "snapshot"

    Methods

    toJSON

    Static fromOptions

    Hierarchy

    • ReadPreference

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • Parameters

      • mode: ReadPreferenceMode

        A string describing the read preference mode (primary|primaryPreferred|secondary|secondaryPreferred|nearest)

      • Optional tags: TagSet[]
        @@ -18,11 +18,11 @@

        The string representing the read preference mode.

      Returns boolean

    secondaryOk

    • secondaryOk(): boolean

    slaveOk

    • slaveOk(): boolean

    toJSON

    Static fromOptions

    Hierarchy

    • WriteConcern

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new WriteConcern(w?: W, wtimeout?: number, j?: boolean, fsync?: boolean | 1): WriteConcern

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean
    @@ -64,7 +64,7 @@

    Specify ClientSession for this command

    Optional startAfter

    startAfter?: unknown

    Similar to resumeAfter, but will allow you to start after an invalidated event.

    -
    see

    https://docs.mongodb.com/manual/changeStreams/#startafter-for-change-streams

    +
    see

    https://www.mongodb.com/docs/manual/changeStreams/#startafter-for-change-streams

    Optional startAtOperationTime

    startAtOperationTime?: Timestamp

    Will start the changeStream after the specified operationTime.

    Optional willRetryWrite

    willRetryWrite?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    diff --git a/docs/4.6/interfaces/CollStats.html b/docs/4.6/interfaces/CollStats.html index 91453889e07..d4ff4f34dc2 100644 --- a/docs/4.6/interfaces/CollStats.html +++ b/docs/4.6/interfaces/CollStats.html @@ -1,4 +1,4 @@ -CollStats | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CollStats

    see

    https://docs.mongodb.org/manual/reference/command/collStats/

    +CollStats | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CollStats

    see

    https://www.mongodb.com/docs/manual/reference/command/collStats/

    Hierarchy

    Index

    Properties

    Properties

    avgObjSize

    avgObjSize: number

    Average object size in bytes

    capped

    capped: boolean
    diff --git a/docs/4.6/interfaces/CountDocumentsOptions.html b/docs/4.6/interfaces/CountDocumentsOptions.html index b999c3e8fe7..c17e2798f2d 100644 --- a/docs/4.6/interfaces/CountDocumentsOptions.html +++ b/docs/4.6/interfaces/CountDocumentsOptions.html @@ -1,7 +1,7 @@ CountDocumentsOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CountDocumentsOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional allowDiskUse

    allowDiskUse?: boolean

    allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).

    Optional authdb

    authdb?: string

    Optional batchSize

    batchSize?: number
    -

    The number of documents to return per batch. See aggregation documentation.

    +

    The number of documents to return per batch. See aggregation documentation.

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    diff --git a/docs/4.6/interfaces/FindOneAndDeleteOptions.html b/docs/4.6/interfaces/FindOneAndDeleteOptions.html index 8210d768d21..24cfc862833 100644 --- a/docs/4.6/interfaces/FindOneAndDeleteOptions.html +++ b/docs/4.6/interfaces/FindOneAndDeleteOptions.html @@ -17,7 +17,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.6/interfaces/FindOneAndReplaceOptions.html b/docs/4.6/interfaces/FindOneAndReplaceOptions.html index b6f12ab09e5..f98ade54387 100644 --- a/docs/4.6/interfaces/FindOneAndReplaceOptions.html +++ b/docs/4.6/interfaces/FindOneAndReplaceOptions.html @@ -19,7 +19,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.6/interfaces/FindOneAndUpdateOptions.html b/docs/4.6/interfaces/FindOneAndUpdateOptions.html index 1c9ad879f41..fc4dd149e1d 100644 --- a/docs/4.6/interfaces/FindOneAndUpdateOptions.html +++ b/docs/4.6/interfaces/FindOneAndUpdateOptions.html @@ -21,7 +21,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.6/interfaces/MongoClientOptions.html b/docs/4.6/interfaces/MongoClientOptions.html index ad81ed135a0..9f029342300 100644 --- a/docs/4.6/interfaces/MongoClientOptions.html +++ b/docs/4.6/interfaces/MongoClientOptions.html @@ -1,6 +1,6 @@ MongoClientOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MongoClientOptions

    Describes all possible URI query options for the mongo client

    -
    see

    https://docs.mongodb.com/manual/reference/connection-string

    +
    see

    https://www.mongodb.com/docs/manual/reference/connection-string

    Hierarchy

    Index

    Properties

    Properties

    Optional ALPNProtocols

    ALPNProtocols?: Uint8Array | string[] | Uint8Array[]

    An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

    @@ -18,7 +18,7 @@

    Optionally enable client side auto encryption

    remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    -

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    +

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    • AutoEncryptionOptions.keyVaultClient is not passed.
      • diff --git a/docs/4.6/interfaces/MongoOptions.html b/docs/4.6/interfaces/MongoOptions.html index 79a56445c2b..b39d0dc702a 100644 --- a/docs/4.6/interfaces/MongoOptions.html +++ b/docs/4.6/interfaces/MongoOptions.html @@ -7,7 +7,7 @@

      Optionally enable client side auto encryption

    remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    -

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    +

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    NumericType

    NumericType: IntegerType | Decimal128 | Double

    OneOrMore

    OneOrMore<T>: T | ReadonlyArray<T>

    Type parameters

    • T

    OnlyFieldsOfType

    OnlyFieldsOfType<TSchema, FieldType, AssignableType>: IsAny<TSchema[keyof TSchema], Record<string, FieldType>, AcceptedFields<TSchema, FieldType, AssignableType> & NotAcceptedFields<TSchema, FieldType> & Record<string, AssignableType>>

    Type parameters

    • TSchema

    • FieldType = any

    • AssignableType = FieldType

    OperationTime

    OperationTime: Timestamp

    Represents a specific point in time on a server. Can be retrieved by using db.command()

    -
    see

    https://docs.mongodb.com/manual/reference/method/db.runCommand/#response

    +
    see

    https://www.mongodb.com/docs/manual/reference/method/db.runCommand/#response

    OptionalId

    OptionalId<TSchema>: EnhancedOmit<TSchema, "_id"> & { _id?: InferIdType<TSchema> }

    Add an optional _id field to an object shaped type

    Type parameters

    • TSchema

    OptionalUnlessRequiredId

    OptionalUnlessRequiredId<TSchema>: TSchema extends { _id: any } ? TSchema : OptionalId<TSchema>
    diff --git a/docs/4.7/classes/AbstractCursor.html b/docs/4.7/classes/AbstractCursor.html index e2b1e73f730..74acfe758bb 100644 --- a/docs/4.7/classes/AbstractCursor.html +++ b/docs/4.7/classes/AbstractCursor.html @@ -16,7 +16,7 @@

    Returns AbstractCursor<TSchema, CursorEvents>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    Abstract clone

    • diff --git a/docs/4.7/classes/AggregationCursor.html b/docs/4.7/classes/AggregationCursor.html index 965c5721ad8..5652a8fff31 100644 --- a/docs/4.7/classes/AggregationCursor.html +++ b/docs/4.7/classes/AggregationCursor.html @@ -21,7 +21,7 @@

    Returns AggregationCursor<TSchema>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    Returns Promise<number>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<number>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<number>

  • Parameters

    Returns void

  • Parameters

    Returns void

    • createIndex

    • Creates an index on the db and collection collection.

      example
      const collection = client.db('foo').collection('bar');

      await collection.createIndex({ a: 1, b: -1 });

      // Alternate syntax for { c: 1, d: -1 } that ensures order of indexes
      await collection.createIndex([ [c, 1], [d, -1] ]);

      // Equivalent to { e: 1 }
      await collection.createIndex('e');

      // Equivalent to { f: 1, g: 1 }
      await collection.createIndex(['f', 'g'])

      // Equivalent to { h: 1, i: -1 }
      await collection.createIndex([ { h: 1 }, { i: -1 } ]);

      // Equivalent to { j: 1, k: -1, l: 2d }
      await collection.createIndex(['j', ['k', -1], { l: '2d' }])
@@ -87,7 +87,7 @@
 MongoDB 2.6 or higher. Earlier version of MongoDB will throw a command not supported
 error.

      Note: Unlike {@link Collection#createIndex| createIndex}, this function takes in raw index specifications. -Index specifications are defined here.

      +Index specifications are defined here.

      example
      const collection = client.db('foo').collection('bar');
      await collection.createIndexes([
        // Simple index on field fizz
        {
          key: { fizz: 1 },
        }
        // wildcard index
        {
          key: { '$**': 1 }
        },
        // named index on darmok and jalad
        {
          key: { darmok: 1, jalad: -1 }
          name: 'tanagra'
        }
      ]);

    Parameters

    • indexSpecs: IndexDescription[]
      @@ -186,7 +186,7 @@

      Optional settings for the command

    Returns ListIndexesCursor

    mapReduce

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method
    • Private property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.7/classes/Db.html b/docs/4.7/classes/Db.html index 7929ab5dc96..a11595ba63f 100644 --- a/docs/4.7/classes/Db.html +++ b/docs/4.7/classes/Db.html @@ -44,7 +44,7 @@

    The command to run

    Returns Promise<Document>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<Document>

  • Parameters

    Returns void

    • createCollection

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method
    • Private property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.7/classes/FindCursor.html b/docs/4.7/classes/FindCursor.html index a74b2e958cb..38345b7b57b 100644 --- a/docs/4.7/classes/FindCursor.html +++ b/docs/4.7/classes/FindCursor.html @@ -21,11 +21,11 @@

    The modifier value.

    Returns FindCursor<TSchema>

    allowDiskUse

    • allowDiskUse(allow?: boolean): FindCursor<TSchema>

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.7/classes/ListCollectionsCursor.html b/docs/4.7/classes/ListCollectionsCursor.html index 53e70b86aed..c341cc42014 100644 --- a/docs/4.7/classes/ListCollectionsCursor.html +++ b/docs/4.7/classes/ListCollectionsCursor.html @@ -16,7 +16,7 @@

    Returns ListCollectionsCursor<T>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.7/classes/ListIndexesCursor.html b/docs/4.7/classes/ListIndexesCursor.html index 542ba24cfd7..a7fcd878726 100644 --- a/docs/4.7/classes/ListIndexesCursor.html +++ b/docs/4.7/classes/ListIndexesCursor.html @@ -16,7 +16,7 @@

    Returns ListIndexesCursor

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.7/classes/MongoClient.html b/docs/4.7/classes/MongoClient.html index 16ab8afaca1..a6d288ce95f 100644 --- a/docs/4.7/classes/MongoClient.html +++ b/docs/4.7/classes/MongoClient.html @@ -43,7 +43,7 @@

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

      +

      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>

    withSession

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

    • Static connect

    Static getEventListeners

    • getEventListeners(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]

    Hierarchy

    • ReadConcern

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    level

    level: string

    Accessors

    Static AVAILABLE

    • get AVAILABLE(): "available"

    Static LINEARIZABLE

    • get LINEARIZABLE(): "linearizable"

    Static MAJORITY

    • get MAJORITY(): "majority"

    Static SNAPSHOT

    • get SNAPSHOT(): "snapshot"

    Methods

    toJSON

    Static fromOptions

    Hierarchy

    • ReadPreference

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • Parameters

      • mode: ReadPreferenceMode

        A string describing the read preference mode (primary|primaryPreferred|secondary|secondaryPreferred|nearest)

      • Optional tags: TagSet[]
        @@ -18,11 +18,11 @@

        The string representing the read preference mode.

      Returns boolean

    secondaryOk

    • secondaryOk(): boolean

    slaveOk

    • slaveOk(): boolean

    toJSON

    Static fromOptions

    Hierarchy

    • WriteConcern

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new WriteConcern(w?: W, wtimeout?: number, j?: boolean, fsync?: boolean | 1): WriteConcern

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean
    @@ -90,7 +90,7 @@

    Optional startAfter

    startAfter?: unknown

    Similar to resumeAfter, but will allow you to start after an invalidated event.

    -
    see

    https://docs.mongodb.com/manual/changeStreams/#startafter-for-change-streams

    +
    see

    https://www.mongodb.com/docs/manual/changeStreams/#startafter-for-change-streams

    Optional startAtOperationTime

    startAtOperationTime?: Timestamp

    Will start the changeStream after the specified operationTime.

    Optional willRetryWrite

    willRetryWrite?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    diff --git a/docs/4.7/interfaces/CollStats.html b/docs/4.7/interfaces/CollStats.html index 378b3eb3f7a..2ac07a4b299 100644 --- a/docs/4.7/interfaces/CollStats.html +++ b/docs/4.7/interfaces/CollStats.html @@ -1,4 +1,4 @@ -CollStats | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CollStats

    see

    https://docs.mongodb.org/manual/reference/command/collStats/

    +CollStats | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CollStats

    see

    https://www.mongodb.com/docs/manual/reference/command/collStats/

    Hierarchy

    Index

    Properties

    Properties

    avgObjSize

    avgObjSize: number

    Average object size in bytes

    capped

    capped: boolean
    diff --git a/docs/4.7/interfaces/CountDocumentsOptions.html b/docs/4.7/interfaces/CountDocumentsOptions.html index 63438bb506d..d649179b306 100644 --- a/docs/4.7/interfaces/CountDocumentsOptions.html +++ b/docs/4.7/interfaces/CountDocumentsOptions.html @@ -1,7 +1,7 @@ CountDocumentsOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CountDocumentsOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional allowDiskUse

    allowDiskUse?: boolean

    allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).

    Optional authdb

    authdb?: string

    Optional batchSize

    batchSize?: number
    -

    The number of documents to return per batch. See aggregation documentation.

    +

    The number of documents to return per batch. See aggregation documentation.

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    diff --git a/docs/4.7/interfaces/FindOneAndDeleteOptions.html b/docs/4.7/interfaces/FindOneAndDeleteOptions.html index d063d92f299..d296a5e8ba8 100644 --- a/docs/4.7/interfaces/FindOneAndDeleteOptions.html +++ b/docs/4.7/interfaces/FindOneAndDeleteOptions.html @@ -17,7 +17,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.7/interfaces/FindOneAndReplaceOptions.html b/docs/4.7/interfaces/FindOneAndReplaceOptions.html index 16377ed61bd..cfa36fb98e7 100644 --- a/docs/4.7/interfaces/FindOneAndReplaceOptions.html +++ b/docs/4.7/interfaces/FindOneAndReplaceOptions.html @@ -19,7 +19,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.7/interfaces/FindOneAndUpdateOptions.html b/docs/4.7/interfaces/FindOneAndUpdateOptions.html index 33544037bc8..5ec89c55f4b 100644 --- a/docs/4.7/interfaces/FindOneAndUpdateOptions.html +++ b/docs/4.7/interfaces/FindOneAndUpdateOptions.html @@ -21,7 +21,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.7/interfaces/MongoClientOptions.html b/docs/4.7/interfaces/MongoClientOptions.html index 688f5948f6c..9a38311a41f 100644 --- a/docs/4.7/interfaces/MongoClientOptions.html +++ b/docs/4.7/interfaces/MongoClientOptions.html @@ -1,6 +1,6 @@ MongoClientOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MongoClientOptions

    Describes all possible URI query options for the mongo client

    -
    see

    https://docs.mongodb.com/manual/reference/connection-string

    +
    see

    https://www.mongodb.com/docs/manual/reference/connection-string

    Hierarchy

    Index

    Properties

    Properties

    Optional ALPNProtocols

    ALPNProtocols?: Uint8Array | string[] | Uint8Array[]

    An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

    @@ -18,7 +18,7 @@

    Optionally enable client side auto encryption

    remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    -

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    +

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    • AutoEncryptionOptions.keyVaultClient is not passed.
      • diff --git a/docs/4.7/interfaces/MongoOptions.html b/docs/4.7/interfaces/MongoOptions.html index d422852d6ee..fa6b3817972 100644 --- a/docs/4.7/interfaces/MongoOptions.html +++ b/docs/4.7/interfaces/MongoOptions.html @@ -7,7 +7,7 @@

      Optionally enable client side auto encryption

    remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    -

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    +

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    NumericType

    NumericType: IntegerType | Decimal128 | Double

    OneOrMore

    OneOrMore<T>: T | ReadonlyArray<T>

    Type parameters

    • T

    OnlyFieldsOfType

    OnlyFieldsOfType<TSchema, FieldType, AssignableType>: IsAny<TSchema[keyof TSchema], Record<string, FieldType>, AcceptedFields<TSchema, FieldType, AssignableType> & NotAcceptedFields<TSchema, FieldType> & Record<string, AssignableType>>

    Type parameters

    • TSchema

    • FieldType = any

    • AssignableType = FieldType

    OperationTime

    OperationTime: Timestamp

    Represents a specific point in time on a server. Can be retrieved by using db.command()

    -
    see

    https://docs.mongodb.com/manual/reference/method/db.runCommand/#response

    +
    see

    https://www.mongodb.com/docs/manual/reference/method/db.runCommand/#response

    OptionalId

    OptionalId<TSchema>: EnhancedOmit<TSchema, "_id"> & { _id?: InferIdType<TSchema> }

    Add an optional _id field to an object shaped type

    Type parameters

    • TSchema

    OptionalUnlessRequiredId

    OptionalUnlessRequiredId<TSchema>: TSchema extends { _id: any } ? TSchema : OptionalId<TSchema>
    diff --git a/docs/4.8/classes/AbstractCursor.html b/docs/4.8/classes/AbstractCursor.html index f228735813d..fd001534352 100644 --- a/docs/4.8/classes/AbstractCursor.html +++ b/docs/4.8/classes/AbstractCursor.html @@ -16,7 +16,7 @@

    Returns AbstractCursor<TSchema, CursorEvents>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    Abstract clone

    • diff --git a/docs/4.8/classes/AggregationCursor.html b/docs/4.8/classes/AggregationCursor.html index 1d5ab7b63e9..77b94ad88cb 100644 --- a/docs/4.8/classes/AggregationCursor.html +++ b/docs/4.8/classes/AggregationCursor.html @@ -21,7 +21,7 @@

    Returns AggregationCursor<TSchema>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    Returns Promise<number>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<number>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<number>

  • Parameters

    Returns void

  • Parameters

    Returns void

    • createIndex

    • Creates an index on the db and collection collection.

      example
      const collection = client.db('foo').collection('bar');

      await collection.createIndex({ a: 1, b: -1 });

      // Alternate syntax for { c: 1, d: -1 } that ensures order of indexes
      await collection.createIndex([ [c, 1], [d, -1] ]);

      // Equivalent to { e: 1 }
      await collection.createIndex('e');

      // Equivalent to { f: 1, g: 1 }
      await collection.createIndex(['f', 'g'])

      // Equivalent to { h: 1, i: -1 }
      await collection.createIndex([ { h: 1 }, { i: -1 } ]);

      // Equivalent to { j: 1, k: -1, l: 2d }
      await collection.createIndex(['j', ['k', -1], { l: '2d' }])
@@ -87,7 +87,7 @@
 MongoDB 2.6 or higher. Earlier version of MongoDB will throw a command not supported
 error.

      Note: Unlike {@link Collection#createIndex| createIndex}, this function takes in raw index specifications. -Index specifications are defined here.

      +Index specifications are defined here.

      example
      const collection = client.db('foo').collection('bar');
      await collection.createIndexes([
        // Simple index on field fizz
        {
          key: { fizz: 1 },
        }
        // wildcard index
        {
          key: { '$**': 1 }
        },
        // named index on darmok and jalad
        {
          key: { darmok: 1, jalad: -1 }
          name: 'tanagra'
        }
      ]);

    Parameters

    • indexSpecs: IndexDescription[]
      @@ -192,7 +192,7 @@

      Optional settings for the command

    Returns ListIndexesCursor

    mapReduce

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method
    • Private property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.8/classes/Db.html b/docs/4.8/classes/Db.html index 8990ae2cb9f..5a2e6dce0d1 100644 --- a/docs/4.8/classes/Db.html +++ b/docs/4.8/classes/Db.html @@ -44,7 +44,7 @@

    The command to run

    Returns Promise<Document>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<Document>

  • Parameters

    Returns void

    • createCollection

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method
    • Private property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.8/classes/FindCursor.html b/docs/4.8/classes/FindCursor.html index d78222512f5..3f65db79a6a 100644 --- a/docs/4.8/classes/FindCursor.html +++ b/docs/4.8/classes/FindCursor.html @@ -21,11 +21,11 @@

    The modifier value.

    Returns FindCursor<TSchema>

    allowDiskUse

    • allowDiskUse(allow?: boolean): FindCursor<TSchema>

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.8/classes/ListCollectionsCursor.html b/docs/4.8/classes/ListCollectionsCursor.html index d461d252159..ee840c856c3 100644 --- a/docs/4.8/classes/ListCollectionsCursor.html +++ b/docs/4.8/classes/ListCollectionsCursor.html @@ -16,7 +16,7 @@

    Returns ListCollectionsCursor<T>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.8/classes/ListIndexesCursor.html b/docs/4.8/classes/ListIndexesCursor.html index 1feaddd22af..daf931ba00d 100644 --- a/docs/4.8/classes/ListIndexesCursor.html +++ b/docs/4.8/classes/ListIndexesCursor.html @@ -16,7 +16,7 @@

    Returns ListIndexesCursor

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    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.

      +

      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>

    withSession

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

    • Static connect

    Static getEventListeners

    • getEventListeners(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]

    Hierarchy

    • ReadConcern

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    level

    level: string

    Accessors

    Static AVAILABLE

    • get AVAILABLE(): "available"

    Static LINEARIZABLE

    • get LINEARIZABLE(): "linearizable"

    Static MAJORITY

    • get MAJORITY(): "majority"

    Static SNAPSHOT

    • get SNAPSHOT(): "snapshot"

    Methods

    toJSON

    Static fromOptions

    Hierarchy

    • ReadPreference

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • Parameters

      • mode: ReadPreferenceMode

        A string describing the read preference mode (primary|primaryPreferred|secondary|secondaryPreferred|nearest)

      • Optional tags: TagSet[]
        @@ -18,11 +18,11 @@

        The string representing the read preference mode.

      Returns boolean

    secondaryOk

    • secondaryOk(): boolean

    slaveOk

    • slaveOk(): boolean

    toJSON

    Static fromOptions

    Hierarchy

    • WriteConcern

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new WriteConcern(w?: W, wtimeout?: number, j?: boolean, fsync?: boolean | 1): WriteConcern

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean
    @@ -90,7 +90,7 @@

    Optional startAfter

    startAfter?: unknown

    Similar to resumeAfter, but will allow you to start after an invalidated event.

    -
    see

    https://docs.mongodb.com/manual/changeStreams/#startafter-for-change-streams

    +
    see

    https://www.mongodb.com/docs/manual/changeStreams/#startafter-for-change-streams

    Optional startAtOperationTime

    startAtOperationTime?: Timestamp

    Will start the changeStream after the specified operationTime.

    Optional willRetryWrite

    willRetryWrite?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    diff --git a/docs/4.8/interfaces/CollStats.html b/docs/4.8/interfaces/CollStats.html index 616f53ad77a..53bc41470e8 100644 --- a/docs/4.8/interfaces/CollStats.html +++ b/docs/4.8/interfaces/CollStats.html @@ -1,4 +1,4 @@ -CollStats | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CollStats

    see

    https://docs.mongodb.org/manual/reference/command/collStats/

    +CollStats | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CollStats

    see

    https://www.mongodb.com/docs/manual/reference/command/collStats/

    Hierarchy

    Index

    Properties

    Properties

    avgObjSize

    avgObjSize: number

    Average object size in bytes

    capped

    capped: boolean
    diff --git a/docs/4.8/interfaces/CountDocumentsOptions.html b/docs/4.8/interfaces/CountDocumentsOptions.html index 8674a9ff9c1..1f02d22ddbe 100644 --- a/docs/4.8/interfaces/CountDocumentsOptions.html +++ b/docs/4.8/interfaces/CountDocumentsOptions.html @@ -1,7 +1,7 @@ CountDocumentsOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CountDocumentsOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional allowDiskUse

    allowDiskUse?: boolean

    allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).

    Optional authdb

    authdb?: string

    Optional batchSize

    batchSize?: number
    -

    The number of documents to return per batch. See aggregation documentation.

    +

    The number of documents to return per batch. See aggregation documentation.

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    diff --git a/docs/4.8/interfaces/FindOneAndDeleteOptions.html b/docs/4.8/interfaces/FindOneAndDeleteOptions.html index 9f313af7663..9c99df93b38 100644 --- a/docs/4.8/interfaces/FindOneAndDeleteOptions.html +++ b/docs/4.8/interfaces/FindOneAndDeleteOptions.html @@ -17,7 +17,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.8/interfaces/FindOneAndReplaceOptions.html b/docs/4.8/interfaces/FindOneAndReplaceOptions.html index 4a7bcf7789b..8cae5f5144c 100644 --- a/docs/4.8/interfaces/FindOneAndReplaceOptions.html +++ b/docs/4.8/interfaces/FindOneAndReplaceOptions.html @@ -19,7 +19,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.8/interfaces/FindOneAndUpdateOptions.html b/docs/4.8/interfaces/FindOneAndUpdateOptions.html index f87f70fbbaa..a779b2eb4e5 100644 --- a/docs/4.8/interfaces/FindOneAndUpdateOptions.html +++ b/docs/4.8/interfaces/FindOneAndUpdateOptions.html @@ -21,7 +21,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.8/interfaces/MongoClientOptions.html b/docs/4.8/interfaces/MongoClientOptions.html index 5ebfda116fa..a893351886b 100644 --- a/docs/4.8/interfaces/MongoClientOptions.html +++ b/docs/4.8/interfaces/MongoClientOptions.html @@ -1,6 +1,6 @@ MongoClientOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MongoClientOptions

    Describes all possible URI query options for the mongo client

    -
    see

    https://docs.mongodb.com/manual/reference/connection-string

    +
    see

    https://www.mongodb.com/docs/manual/reference/connection-string

    Hierarchy

    Index

    Properties

    Properties

    Optional ALPNProtocols

    ALPNProtocols?: Uint8Array | string[] | Uint8Array[]

    An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

    @@ -18,7 +18,7 @@

    Optionally enable client side auto encryption

    remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    -

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    +

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    • AutoEncryptionOptions.keyVaultClient is not passed.
      • diff --git a/docs/4.8/interfaces/MongoOptions.html b/docs/4.8/interfaces/MongoOptions.html index cf7f06dc7ed..8af0d7299d6 100644 --- a/docs/4.8/interfaces/MongoOptions.html +++ b/docs/4.8/interfaces/MongoOptions.html @@ -7,7 +7,7 @@

      Optionally enable client side auto encryption

    remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    -

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    +

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    NumericType

    NumericType: IntegerType | Decimal128 | Double

    OneOrMore

    OneOrMore<T>: T | ReadonlyArray<T>

    Type parameters

    • T

    OnlyFieldsOfType

    OnlyFieldsOfType<TSchema, FieldType, AssignableType>: IsAny<TSchema[keyof TSchema], Record<string, FieldType>, AcceptedFields<TSchema, FieldType, AssignableType> & NotAcceptedFields<TSchema, FieldType> & Record<string, AssignableType>>

    Type parameters

    • TSchema

    • FieldType = any

    • AssignableType = FieldType

    OperationTime

    OperationTime: Timestamp

    Represents a specific point in time on a server. Can be retrieved by using db.command()

    -
    see

    https://docs.mongodb.com/manual/reference/method/db.runCommand/#response

    +
    see

    https://www.mongodb.com/docs/manual/reference/method/db.runCommand/#response

    OptionalId

    OptionalId<TSchema>: EnhancedOmit<TSchema, "_id"> & { _id?: InferIdType<TSchema> }

    Add an optional _id field to an object shaped type

    Type parameters

    • TSchema

    OptionalUnlessRequiredId

    OptionalUnlessRequiredId<TSchema>: TSchema extends { _id: any } ? TSchema : OptionalId<TSchema>
    diff --git a/docs/4.9/classes/AbstractCursor.html b/docs/4.9/classes/AbstractCursor.html index 8cf4f54c31b..b192d0d4c5b 100644 --- a/docs/4.9/classes/AbstractCursor.html +++ b/docs/4.9/classes/AbstractCursor.html @@ -16,7 +16,7 @@

    Returns AbstractCursor<TSchema, CursorEvents>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    Abstract clone

    • diff --git a/docs/4.9/classes/AggregationCursor.html b/docs/4.9/classes/AggregationCursor.html index a957e1d2506..8af2b862864 100644 --- a/docs/4.9/classes/AggregationCursor.html +++ b/docs/4.9/classes/AggregationCursor.html @@ -21,7 +21,7 @@

    Returns AggregationCursor<TSchema>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    Returns Promise<number>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<number>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<number>

  • Parameters

    Returns void

  • Parameters

    Returns void

    • createIndex

    • Creates an index on the db and collection collection.

      example
      const collection = client.db('foo').collection('bar');

      await collection.createIndex({ a: 1, b: -1 });

      // Alternate syntax for { c: 1, d: -1 } that ensures order of indexes
      await collection.createIndex([ [c, 1], [d, -1] ]);

      // Equivalent to { e: 1 }
      await collection.createIndex('e');

      // Equivalent to { f: 1, g: 1 }
      await collection.createIndex(['f', 'g'])

      // Equivalent to { h: 1, i: -1 }
      await collection.createIndex([ { h: 1 }, { i: -1 } ]);

      // Equivalent to { j: 1, k: -1, l: 2d }
      await collection.createIndex(['j', ['k', -1], { l: '2d' }])
@@ -87,7 +87,7 @@
 MongoDB 2.6 or higher. Earlier version of MongoDB will throw a command not supported
 error.

      Note: Unlike {@link Collection#createIndex| createIndex}, this function takes in raw index specifications. -Index specifications are defined here.

      +Index specifications are defined here.

      example
      const collection = client.db('foo').collection('bar');
      await collection.createIndexes([
        // Simple index on field fizz
        {
          key: { fizz: 1 },
        }
        // wildcard index
        {
          key: { '$**': 1 }
        },
        // named index on darmok and jalad
        {
          key: { darmok: 1, jalad: -1 }
          name: 'tanagra'
        }
      ]);

    Parameters

    • indexSpecs: IndexDescription[]
      @@ -192,7 +192,7 @@

      Optional settings for the command

    Returns ListIndexesCursor

    mapReduce

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.9/classes/Db.html b/docs/4.9/classes/Db.html index cb0a071b053..35012bbbd16 100644 --- a/docs/4.9/classes/Db.html +++ b/docs/4.9/classes/Db.html @@ -44,7 +44,7 @@

    The command to run

    Returns Promise<Document>

  • Parameters

    Returns void

  • Parameters

    Returns Promise<Document>

  • Parameters

    Returns void

    • createCollection

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/4.9/classes/FindCursor.html b/docs/4.9/classes/FindCursor.html index f0ee2d49ba8..22d5f2dabf6 100644 --- a/docs/4.9/classes/FindCursor.html +++ b/docs/4.9/classes/FindCursor.html @@ -21,11 +21,11 @@

    The modifier value.

    Returns FindCursor<TSchema>

    allowDiskUse

    • allowDiskUse(allow?: boolean): FindCursor<TSchema>

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.9/classes/ListCollectionsCursor.html b/docs/4.9/classes/ListCollectionsCursor.html index 1b0b87a2b96..1ea455988d9 100644 --- a/docs/4.9/classes/ListCollectionsCursor.html +++ b/docs/4.9/classes/ListCollectionsCursor.html @@ -16,7 +16,7 @@

    Returns ListCollectionsCursor<T>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/4.9/classes/ListIndexesCursor.html b/docs/4.9/classes/ListIndexesCursor.html index eb5d8a827ac..936da523cb5 100644 --- a/docs/4.9/classes/ListIndexesCursor.html +++ b/docs/4.9/classes/ListIndexesCursor.html @@ -16,7 +16,7 @@

    Returns ListIndexesCursor

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    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.

      +

      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>

    withSession

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

    • Static connect

    Static getEventListeners

    • getEventListeners(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]

    Hierarchy

    • ReadConcern

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    level

    level: string

    Accessors

    Static AVAILABLE

    • get AVAILABLE(): "available"

    Static LINEARIZABLE

    • get LINEARIZABLE(): "linearizable"

    Static MAJORITY

    • get MAJORITY(): "majority"

    Static SNAPSHOT

    • get SNAPSHOT(): "snapshot"

    Methods

    toJSON

    Static fromOptions

    Hierarchy

    • ReadPreference

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • Parameters

      • mode: ReadPreferenceMode

        A string describing the read preference mode (primary|primaryPreferred|secondary|secondaryPreferred|nearest)

      • Optional tags: TagSet[]
        @@ -18,11 +18,11 @@

        The string representing the read preference mode.

      Returns boolean

    secondaryOk

    • secondaryOk(): boolean

    slaveOk

    • slaveOk(): boolean

    toJSON

    Static fromOptions

    Hierarchy

    • WriteConcern

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new WriteConcern(w?: W, wtimeout?: number, j?: boolean, fsync?: boolean | 1): WriteConcern

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    @@ -70,7 +70,7 @@

    The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).

    Optional resumeAfter

    resumeAfter?: unknown

    Allows you to start a changeStream after a specified event.

    -
    see

    https://docs.mongodb.com/manual/changeStreams/#resumeafter-for-change-streams

    +
    see

    https://www.mongodb.com/docs/manual/changeStreams/#resumeafter-for-change-streams

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean
    @@ -90,7 +90,7 @@

    Optional startAfter

    startAfter?: unknown

    Similar to resumeAfter, but will allow you to start after an invalidated event.

    -
    see

    https://docs.mongodb.com/manual/changeStreams/#startafter-for-change-streams

    +
    see

    https://www.mongodb.com/docs/manual/changeStreams/#startafter-for-change-streams

    Optional startAtOperationTime

    startAtOperationTime?: Timestamp

    Will start the changeStream after the specified operationTime.

    Optional willRetryWrite

    willRetryWrite?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    diff --git a/docs/4.9/interfaces/CollStats.html b/docs/4.9/interfaces/CollStats.html index 8e974d49ba7..a500a435863 100644 --- a/docs/4.9/interfaces/CollStats.html +++ b/docs/4.9/interfaces/CollStats.html @@ -1,4 +1,4 @@ -CollStats | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CollStats

    see

    https://docs.mongodb.org/manual/reference/command/collStats/

    +CollStats | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CollStats

    see

    https://www.mongodb.com/docs/manual/reference/command/collStats/

    Hierarchy

    Index

    Properties

    Properties

    avgObjSize

    avgObjSize: number

    Average object size in bytes

    capped

    capped: boolean
    diff --git a/docs/4.9/interfaces/CountDocumentsOptions.html b/docs/4.9/interfaces/CountDocumentsOptions.html index 1f8d2d92349..10f6b2788b9 100644 --- a/docs/4.9/interfaces/CountDocumentsOptions.html +++ b/docs/4.9/interfaces/CountDocumentsOptions.html @@ -1,7 +1,7 @@ CountDocumentsOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CountDocumentsOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional allowDiskUse

    allowDiskUse?: boolean

    allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).

    Optional authdb

    authdb?: string

    Optional batchSize

    batchSize?: number
    -

    The number of documents to return per batch. See aggregation documentation.

    +

    The number of documents to return per batch. See aggregation documentation.

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    diff --git a/docs/4.9/interfaces/FindOneAndDeleteOptions.html b/docs/4.9/interfaces/FindOneAndDeleteOptions.html index dc167cd49ff..4a44f22bffd 100644 --- a/docs/4.9/interfaces/FindOneAndDeleteOptions.html +++ b/docs/4.9/interfaces/FindOneAndDeleteOptions.html @@ -17,7 +17,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.9/interfaces/FindOneAndReplaceOptions.html b/docs/4.9/interfaces/FindOneAndReplaceOptions.html index 0146ec01f8e..19b8aaad9a4 100644 --- a/docs/4.9/interfaces/FindOneAndReplaceOptions.html +++ b/docs/4.9/interfaces/FindOneAndReplaceOptions.html @@ -19,7 +19,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.9/interfaces/FindOneAndUpdateOptions.html b/docs/4.9/interfaces/FindOneAndUpdateOptions.html index e3b9772a2fd..89bbc0eafe1 100644 --- a/docs/4.9/interfaces/FindOneAndUpdateOptions.html +++ b/docs/4.9/interfaces/FindOneAndUpdateOptions.html @@ -21,7 +21,7 @@

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional fullResponse

    fullResponse?: boolean
    deprecated

    This option does nothing

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/4.9/interfaces/MongoClientOptions.html b/docs/4.9/interfaces/MongoClientOptions.html index a6c9a079b44..77a89244ebd 100644 --- a/docs/4.9/interfaces/MongoClientOptions.html +++ b/docs/4.9/interfaces/MongoClientOptions.html @@ -1,6 +1,6 @@ MongoClientOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MongoClientOptions

    Describes all possible URI query options for the mongo client

    -
    see

    https://docs.mongodb.com/manual/reference/connection-string

    +
    see

    https://www.mongodb.com/docs/manual/reference/connection-string

    Hierarchy

    Index

    Properties

    Properties

    Optional ALPNProtocols

    ALPNProtocols?: Uint8Array | string[] | Uint8Array[]

    An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

    @@ -18,7 +18,7 @@

    Optionally enable client side auto encryption

    remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    -

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    +

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    • AutoEncryptionOptions.keyVaultClient is not passed.
      • @@ -245,7 +245,7 @@

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    A MongoDB WriteConcern, which describes the level of acknowledgement requested from MongoDB for write operations.

    -
    see

    https://docs.mongodb.com/manual/reference/write-concern/

    +
    see

    https://www.mongodb.com/docs/manual/reference/write-concern/

    Optional wtimeoutMS

    wtimeoutMS?: number

    The write concern timeout

    deprecated

    Please use the writeConcern option instead

    diff --git a/docs/4.9/interfaces/MongoOptions.html b/docs/4.9/interfaces/MongoOptions.html index 77ea314e3df..548fd691162 100644 --- a/docs/4.9/interfaces/MongoOptions.html +++ b/docs/4.9/interfaces/MongoOptions.html @@ -7,7 +7,7 @@

    Optionally enable client side auto encryption

    remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    -

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    +

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    NumericType

    NumericType: IntegerType | Decimal128 | Double

    OneOrMore

    OneOrMore<T>: T | ReadonlyArray<T>

    Type parameters

    • T

    OnlyFieldsOfType

    OnlyFieldsOfType<TSchema, FieldType, AssignableType>: IsAny<TSchema[keyof TSchema], Record<string, FieldType>, AcceptedFields<TSchema, FieldType, AssignableType> & NotAcceptedFields<TSchema, FieldType> & Record<string, AssignableType>>

    Type parameters

    • TSchema

    • FieldType = any

    • AssignableType = FieldType

    OperationTime

    OperationTime: Timestamp

    Represents a specific point in time on a server. Can be retrieved by using db.command()

    -
    see

    https://docs.mongodb.com/manual/reference/method/db.runCommand/#response

    +
    see

    https://www.mongodb.com/docs/manual/reference/method/db.runCommand/#response

    OptionalId

    OptionalId<TSchema>: EnhancedOmit<TSchema, "_id"> & { _id?: InferIdType<TSchema> }

    Add an optional _id field to an object shaped type

    Type parameters

    • TSchema

    OptionalUnlessRequiredId

    OptionalUnlessRequiredId<TSchema>: TSchema extends { _id: any } ? TSchema : OptionalId<TSchema>
    diff --git a/docs/404.html b/docs/404.html index 61961ba0e2d..ef939e8cf63 100644 --- a/docs/404.html +++ b/docs/404.html @@ -34,10 +34,10 @@ @@ -67,7 +67,7 @@

    404: Page not found

    -

    Copyright © 2022 MongoDB, Inc. +

    Copyright © 2022 MongoDB, Inc. Licensed under Creative Commons. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.

    diff --git a/docs/5.0/classes/AbstractCursor.html b/docs/5.0/classes/AbstractCursor.html index f2730da44aa..51d96c18670 100644 --- a/docs/5.0/classes/AbstractCursor.html +++ b/docs/5.0/classes/AbstractCursor.html @@ -16,7 +16,7 @@

    Returns AbstractCursor<TSchema, CursorEvents>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    Abstract clone

    • diff --git a/docs/5.0/classes/AggregationCursor.html b/docs/5.0/classes/AggregationCursor.html index 0b18b524eb7..e2bd00ff831 100644 --- a/docs/5.0/classes/AggregationCursor.html +++ b/docs/5.0/classes/AggregationCursor.html @@ -21,7 +21,7 @@

    Returns AggregationCursor<TSchema>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method
    • Private property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/5.0/classes/Db.html b/docs/5.0/classes/Db.html index 6566388a43e..9cdc0453780 100644 --- a/docs/5.0/classes/Db.html +++ b/docs/5.0/classes/Db.html @@ -49,7 +49,7 @@

    Optional settings for the command

    Returns Promise<Document>

    createCollection

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method
    • Private property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/5.0/classes/FindCursor.html b/docs/5.0/classes/FindCursor.html index 62d95a2280e..2d6eb15f3ff 100644 --- a/docs/5.0/classes/FindCursor.html +++ b/docs/5.0/classes/FindCursor.html @@ -21,11 +21,11 @@

    The modifier value.

    Returns FindCursor<TSchema>

    allowDiskUse

    • allowDiskUse(allow?: boolean): FindCursor<TSchema>

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/5.0/classes/ListCollectionsCursor.html b/docs/5.0/classes/ListCollectionsCursor.html index 132f376b039..ed13151eb6b 100644 --- a/docs/5.0/classes/ListCollectionsCursor.html +++ b/docs/5.0/classes/ListCollectionsCursor.html @@ -16,7 +16,7 @@

    Returns ListCollectionsCursor<T>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/5.0/classes/ListIndexesCursor.html b/docs/5.0/classes/ListIndexesCursor.html index 3b7848dc42c..4b3de6c46d9 100644 --- a/docs/5.0/classes/ListIndexesCursor.html +++ b/docs/5.0/classes/ListIndexesCursor.html @@ -16,7 +16,7 @@

    Returns ListIndexesCursor

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    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.

      +

      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>

    withSession

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

    • Static connect

    Static getEventListeners

    • getEventListeners(emitter: EventEmitter | _DOMEventTarget, name: string | symbol): Function[]

    Hierarchy

    • ReadConcern

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    level

    level: string

    Accessors

    Static AVAILABLE

    • get AVAILABLE(): "available"

    Static LINEARIZABLE

    • get LINEARIZABLE(): "linearizable"

    Static MAJORITY

    • get MAJORITY(): "majority"

    Static SNAPSHOT

    • get SNAPSHOT(): "snapshot"

    Methods

    toJSON

    Static fromOptions

    Hierarchy

    • ReadPreference

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • Parameters

      • mode: ReadPreferenceMode

        A string describing the read preference mode (primary|primaryPreferred|secondary|secondaryPreferred|nearest)

      • Optional tags: TagSet[]
        @@ -18,7 +18,7 @@

        The string representing the read preference mode.

      Returns boolean

    secondaryOk

    • secondaryOk(): boolean

    toJSON

    Static fromOptions

    Hierarchy

    • WriteConcern

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new WriteConcern(w?: W, wtimeout?: number, j?: boolean, fsync?: boolean | 1): WriteConcern

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    @@ -78,7 +78,7 @@

    The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).

    Optional resumeAfter

    resumeAfter?: unknown

    Allows you to start a changeStream after a specified event.

    -
    see

    https://docs.mongodb.com/manual/changeStreams/#resumeafter-for-change-streams

    +
    see

    https://www.mongodb.com/docs/manual/changeStreams/#resumeafter-for-change-streams

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean
    @@ -98,7 +98,7 @@

    Optional startAfter

    startAfter?: unknown

    Similar to resumeAfter, but will allow you to start after an invalidated event.

    -
    see

    https://docs.mongodb.com/manual/changeStreams/#startafter-for-change-streams

    +
    see

    https://www.mongodb.com/docs/manual/changeStreams/#startafter-for-change-streams

    Optional startAtOperationTime

    startAtOperationTime?: Timestamp

    Will start the changeStream after the specified operationTime.

    Optional willRetryWrite

    willRetryWrite?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    diff --git a/docs/5.0/interfaces/CollStats.html b/docs/5.0/interfaces/CollStats.html index e9e9ed991d8..8498e22a008 100644 --- a/docs/5.0/interfaces/CollStats.html +++ b/docs/5.0/interfaces/CollStats.html @@ -1,4 +1,4 @@ -CollStats | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CollStats

    see

    https://docs.mongodb.org/manual/reference/command/collStats/

    +CollStats | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CollStats

    see

    https://www.mongodb.com/docs/manual/reference/command/collStats/

    Hierarchy

    Index

    Properties

    Properties

    avgObjSize

    avgObjSize: number

    Average object size in bytes

    capped

    capped: boolean
    diff --git a/docs/5.0/interfaces/CountDocumentsOptions.html b/docs/5.0/interfaces/CountDocumentsOptions.html index ea991df0b25..c08aa26999e 100644 --- a/docs/5.0/interfaces/CountDocumentsOptions.html +++ b/docs/5.0/interfaces/CountDocumentsOptions.html @@ -1,7 +1,7 @@ CountDocumentsOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CountDocumentsOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional allowDiskUse

    allowDiskUse?: boolean

    allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).

    Optional authdb

    authdb?: string

    Optional batchSize

    batchSize?: number
    -

    The number of documents to return per batch. See aggregation documentation.

    +

    The number of documents to return per batch. See aggregation documentation.

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    diff --git a/docs/5.0/interfaces/FindOneAndDeleteOptions.html b/docs/5.0/interfaces/FindOneAndDeleteOptions.html index ea4456e87d3..5cf76ce2c9e 100644 --- a/docs/5.0/interfaces/FindOneAndDeleteOptions.html +++ b/docs/5.0/interfaces/FindOneAndDeleteOptions.html @@ -16,7 +16,7 @@

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/5.0/interfaces/FindOneAndReplaceOptions.html b/docs/5.0/interfaces/FindOneAndReplaceOptions.html index ed783f96039..968335b2a7c 100644 --- a/docs/5.0/interfaces/FindOneAndReplaceOptions.html +++ b/docs/5.0/interfaces/FindOneAndReplaceOptions.html @@ -18,7 +18,7 @@

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/5.0/interfaces/FindOneAndUpdateOptions.html b/docs/5.0/interfaces/FindOneAndUpdateOptions.html index e6d4824c72f..f709584c578 100644 --- a/docs/5.0/interfaces/FindOneAndUpdateOptions.html +++ b/docs/5.0/interfaces/FindOneAndUpdateOptions.html @@ -20,7 +20,7 @@

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/5.0/interfaces/MongoClientOptions.html b/docs/5.0/interfaces/MongoClientOptions.html index d11161115eb..38e148f9c2e 100644 --- a/docs/5.0/interfaces/MongoClientOptions.html +++ b/docs/5.0/interfaces/MongoClientOptions.html @@ -1,6 +1,6 @@ MongoClientOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MongoClientOptions

    Describes all possible URI query options for the mongo client

    -
    see

    https://docs.mongodb.com/manual/reference/connection-string

    +
    see

    https://www.mongodb.com/docs/manual/reference/connection-string

    Hierarchy

    Index

    Properties

    Properties

    Optional ALPNProtocols

    ALPNProtocols?: string[] | Uint8Array | Uint8Array[]

    An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

    @@ -18,7 +18,7 @@

    Optionally enable in-use auto encryption

    remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    -

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    +

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    • AutoEncryptionOptions.keyVaultClient is not passed.
      • @@ -252,7 +252,7 @@

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    A MongoDB WriteConcern, which describes the level of acknowledgement requested from MongoDB for write operations.

    -
    see

    https://docs.mongodb.com/manual/reference/write-concern/

    +
    see

    https://www.mongodb.com/docs/manual/reference/write-concern/

    Optional wtimeoutMS

    wtimeoutMS?: number

    The write concern timeout

    deprecated

    Please use the writeConcern option instead

    diff --git a/docs/5.0/interfaces/MongoOptions.html b/docs/5.0/interfaces/MongoOptions.html index 04c4c26b2d6..7023b1bbbcc 100644 --- a/docs/5.0/interfaces/MongoOptions.html +++ b/docs/5.0/interfaces/MongoOptions.html @@ -7,7 +7,7 @@

    Optionally enable in-use auto encryption

    remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    -

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    +

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    NumericType

    NumericType: IntegerType | Decimal128 | Double

    OneOrMore

    OneOrMore<T>: T | ReadonlyArray<T>

    Type parameters

    • T

    OnlyFieldsOfType

    OnlyFieldsOfType<TSchema, FieldType, AssignableType>: IsAny<TSchema[keyof TSchema], Record<string, FieldType>, AcceptedFields<TSchema, FieldType, AssignableType> & NotAcceptedFields<TSchema, FieldType> & Record<string, AssignableType>>

    Type parameters

    • TSchema

    • FieldType = any

    • AssignableType = FieldType

    OperationTime

    OperationTime: Timestamp

    Represents a specific point in time on a server. Can be retrieved by using db.command()

    -
    see

    https://docs.mongodb.com/manual/reference/method/db.runCommand/#response

    +
    see

    https://www.mongodb.com/docs/manual/reference/method/db.runCommand/#response

    OptionalId

    OptionalId<TSchema>: EnhancedOmit<TSchema, "_id"> & { _id?: InferIdType<TSchema> }

    Add an optional _id field to an object shaped type

    Type parameters

    • TSchema

    OptionalUnlessRequiredId

    OptionalUnlessRequiredId<TSchema>: TSchema extends { _id: any } ? TSchema : OptionalId<TSchema>
    diff --git a/docs/Next/classes/AbstractCursor.html b/docs/Next/classes/AbstractCursor.html index db762c1db70..c583d8233c9 100644 --- a/docs/Next/classes/AbstractCursor.html +++ b/docs/Next/classes/AbstractCursor.html @@ -16,7 +16,7 @@

    Returns AbstractCursor<TSchema, CursorEvents>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    Abstract clone

    • diff --git a/docs/Next/classes/AggregationCursor.html b/docs/Next/classes/AggregationCursor.html index 88866ea9fcc..e6bfc8a0135 100644 --- a/docs/Next/classes/AggregationCursor.html +++ b/docs/Next/classes/AggregationCursor.html @@ -21,7 +21,7 @@

    Returns AggregationCursor<TSchema>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method
    • Private property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/Db.html b/docs/Next/classes/Db.html index f76a8b44d2f..6fecff5eb01 100644 --- a/docs/Next/classes/Db.html +++ b/docs/Next/classes/Db.html @@ -49,7 +49,7 @@

    Optional settings for the command

    Returns Promise<Document>

    createCollection

    Legend

    • Constructor
    • Property
    • Method
    • Accessor
    • Constructor
    • Property
    • Method
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Static property
    • Static method
    • Private property

    Settings

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/docs/Next/classes/FindCursor.html b/docs/Next/classes/FindCursor.html index 2f849ab1f27..85076a72ebd 100644 --- a/docs/Next/classes/FindCursor.html +++ b/docs/Next/classes/FindCursor.html @@ -21,11 +21,11 @@

    The modifier value.

    Returns FindCursor<TSchema>

    allowDiskUse

    • allowDiskUse(allow?: boolean): FindCursor<TSchema>

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/Next/classes/ListCollectionsCursor.html b/docs/Next/classes/ListCollectionsCursor.html index 1bf13684638..45c3385621c 100644 --- a/docs/Next/classes/ListCollectionsCursor.html +++ b/docs/Next/classes/ListCollectionsCursor.html @@ -16,7 +16,7 @@

    Returns ListCollectionsCursor<T>

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    • diff --git a/docs/Next/classes/ListIndexesCursor.html b/docs/Next/classes/ListIndexesCursor.html index c048cc4cb90..8948ea81aa3 100644 --- a/docs/Next/classes/ListIndexesCursor.html +++ b/docs/Next/classes/ListIndexesCursor.html @@ -16,7 +16,7 @@

    Returns ListIndexesCursor

    addListener

    batchSize

    bufferedCount

    • bufferedCount(): number

    clone

    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.

      +

      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>

    withSession

    Returns Promise<void>

  • Parameters

    Returns Promise<void>

    • Static connect

    Static getEventListeners

    • getEventListeners(emitter: EventEmitter | _DOMEventTarget, name: string | symbol): Function[]

    • Returns a copy of the array of listeners for the event named eventName.

      For EventEmitters this behaves exactly the same as calling .listeners on diff --git a/docs/Next/classes/ReadConcern.html b/docs/Next/classes/ReadConcern.html index c65e2bb473b..1e513c472a1 100644 --- a/docs/Next/classes/ReadConcern.html +++ b/docs/Next/classes/ReadConcern.html @@ -1,7 +1,7 @@ ReadConcern | mongodb

      Options
      All
      • Public
      • Public/Protected
      • All
      Menu

      Class ReadConcern

      The MongoDB ReadConcern, which allows for control of the consistency and isolation properties of the data read from replica sets and replica set shards.

      -
      see

      https://docs.mongodb.com/manual/reference/read-concern/index.html

      +
      see

      https://www.mongodb.com/docs/manual/reference/read-concern/index.html

    Hierarchy

    • ReadConcern

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    Properties

    level

    level: string

    Accessors

    Static AVAILABLE

    • get AVAILABLE(): "available"

    Static LINEARIZABLE

    • get LINEARIZABLE(): "linearizable"

    Static MAJORITY

    • get MAJORITY(): "majority"

    Static SNAPSHOT

    • get SNAPSHOT(): "snapshot"

    Methods

    toJSON

    Static fromOptions

    Hierarchy

    • ReadPreference

    Index

    Constructors

    Properties

    Accessors

    Methods

    Constructors

    constructor

    • Parameters

      • mode: ReadPreferenceMode

        A string describing the read preference mode (primary|primaryPreferred|secondary|secondaryPreferred|nearest)

      • Optional tags: TagSet[]
        @@ -18,7 +18,7 @@

        The string representing the read preference mode.

      Returns boolean

    secondaryOk

    • secondaryOk(): boolean

    toJSON

    Static fromOptions

    Hierarchy

    • WriteConcern

    Index

    Constructors

    Properties

    Methods

    Constructors

    constructor

    • new WriteConcern(w?: W, wtimeout?: number, j?: boolean, fsync?: boolean | 1): WriteConcern

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    @@ -78,7 +78,7 @@

    The preferred read preference (ReadPreference.primary, ReadPreference.primary_preferred, ReadPreference.secondary, ReadPreference.secondary_preferred, ReadPreference.nearest).

    Optional resumeAfter

    resumeAfter?: unknown

    Allows you to start a changeStream after a specified event.

    -
    see

    https://docs.mongodb.com/manual/changeStreams/#resumeafter-for-change-streams

    +
    see

    https://www.mongodb.com/docs/manual/changeStreams/#resumeafter-for-change-streams

    Optional retryWrites

    retryWrites?: boolean

    Should retry failed writes

    Optional serializeFunctions

    serializeFunctions?: boolean
    @@ -98,7 +98,7 @@

    Optional startAfter

    startAfter?: unknown

    Similar to resumeAfter, but will allow you to start after an invalidated event.

    -
    see

    https://docs.mongodb.com/manual/changeStreams/#startafter-for-change-streams

    +
    see

    https://www.mongodb.com/docs/manual/changeStreams/#startafter-for-change-streams

    Optional startAtOperationTime

    startAtOperationTime?: Timestamp

    Will start the changeStream after the specified operationTime.

    Optional willRetryWrite

    willRetryWrite?: boolean

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings
    diff --git a/docs/Next/interfaces/CollStats.html b/docs/Next/interfaces/CollStats.html index 40816e004a2..8d9c30e1652 100644 --- a/docs/Next/interfaces/CollStats.html +++ b/docs/Next/interfaces/CollStats.html @@ -1,4 +1,4 @@ -CollStats | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CollStats

    see

    https://docs.mongodb.org/manual/reference/command/collStats/

    +CollStats | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CollStats

    see

    https://www.mongodb.com/docs/manual/reference/command/collStats/

    Hierarchy

    Index

    Properties

    Properties

    avgObjSize

    avgObjSize: number

    Average object size in bytes

    capped

    capped: boolean
    diff --git a/docs/Next/interfaces/CountDocumentsOptions.html b/docs/Next/interfaces/CountDocumentsOptions.html index 915f348f142..d52106d4692 100644 --- a/docs/Next/interfaces/CountDocumentsOptions.html +++ b/docs/Next/interfaces/CountDocumentsOptions.html @@ -1,7 +1,7 @@ CountDocumentsOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface CountDocumentsOptions

    Hierarchy

    Index

    Properties

    Properties

    Optional allowDiskUse

    allowDiskUse?: boolean

    allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 >).

    Optional authdb

    authdb?: string

    Optional batchSize

    batchSize?: number
    -

    The number of documents to return per batch. See aggregation documentation.

    +

    The number of documents to return per batch. See aggregation documentation.

    Optional bsonRegExp

    bsonRegExp?: boolean

    return BSON regular expressions as BSONRegExp instances.

    Optional bypassDocumentValidation

    bypassDocumentValidation?: boolean
    diff --git a/docs/Next/interfaces/FindOneAndDeleteOptions.html b/docs/Next/interfaces/FindOneAndDeleteOptions.html index b40eebab948..0c17525429d 100644 --- a/docs/Next/interfaces/FindOneAndDeleteOptions.html +++ b/docs/Next/interfaces/FindOneAndDeleteOptions.html @@ -16,7 +16,7 @@

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/Next/interfaces/FindOneAndReplaceOptions.html b/docs/Next/interfaces/FindOneAndReplaceOptions.html index 1a85934caca..7fd12da633b 100644 --- a/docs/Next/interfaces/FindOneAndReplaceOptions.html +++ b/docs/Next/interfaces/FindOneAndReplaceOptions.html @@ -18,7 +18,7 @@

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/Next/interfaces/FindOneAndUpdateOptions.html b/docs/Next/interfaces/FindOneAndUpdateOptions.html index 4b25da5829c..d6d5c0bb6ea 100644 --- a/docs/Next/interfaces/FindOneAndUpdateOptions.html +++ b/docs/Next/interfaces/FindOneAndUpdateOptions.html @@ -20,7 +20,7 @@

    Optional fieldsAsRaw

    fieldsAsRaw?: Document

    allow to specify if there what fields we wish to return as unserialized raw buffer.

    Optional hint

    hint?: Document
    -

    An optional hint for query optimization. See the update command reference for more information.

    +

    An optional hint for query optimization. See the update command reference for more information.

    Optional ignoreUndefined

    ignoreUndefined?: boolean

    serialize will not emit undefined fields (default:true)

    Optional let

    let?: Document
    diff --git a/docs/Next/interfaces/MongoClientOptions.html b/docs/Next/interfaces/MongoClientOptions.html index 4f71e81bd1a..767263627d4 100644 --- a/docs/Next/interfaces/MongoClientOptions.html +++ b/docs/Next/interfaces/MongoClientOptions.html @@ -1,6 +1,6 @@ MongoClientOptions | mongodb
    Options
    All
    • Public
    • Public/Protected
    • All
    Menu

    Interface MongoClientOptions

    Describes all possible URI query options for the mongo client

    -
    see

    https://docs.mongodb.com/manual/reference/connection-string

    +
    see

    https://www.mongodb.com/docs/manual/reference/connection-string

    Hierarchy

    Index

    Properties

    Properties

    Optional ALPNProtocols

    ALPNProtocols?: string[] | Uint8Array | Uint8Array[]

    An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

    @@ -18,7 +18,7 @@

    Optionally enable in-use auto encryption

    remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    -

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    +

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    • AutoEncryptionOptions.keyVaultClient is not passed.
      • @@ -252,7 +252,7 @@

    Optional writeConcern

    writeConcern?: WriteConcern | WriteConcernSettings

    A MongoDB WriteConcern, which describes the level of acknowledgement requested from MongoDB for write operations.

    -
    see

    https://docs.mongodb.com/manual/reference/write-concern/

    +
    see

    https://www.mongodb.com/docs/manual/reference/write-concern/

    Optional wtimeoutMS

    wtimeoutMS?: number

    The write concern timeout

    deprecated

    Please use the writeConcern option instead

    diff --git a/docs/Next/interfaces/MongoOptions.html b/docs/Next/interfaces/MongoOptions.html index a4287f350e0..226c696c6e3 100644 --- a/docs/Next/interfaces/MongoOptions.html +++ b/docs/Next/interfaces/MongoOptions.html @@ -7,7 +7,7 @@

    Optionally enable in-use auto encryption

    remarks

    Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

    -

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    +

    Automatic encryption requires the authenticated user to have the listCollections privilege action.

    If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

    NumericType

    NumericType: IntegerType | Decimal128 | Double

    OneOrMore

    OneOrMore<T>: T | ReadonlyArray<T>

    Type parameters

    • T

    OnlyFieldsOfType

    OnlyFieldsOfType<TSchema, FieldType, AssignableType>: IsAny<TSchema[keyof TSchema], Record<string, FieldType>, AcceptedFields<TSchema, FieldType, AssignableType> & NotAcceptedFields<TSchema, FieldType> & Record<string, AssignableType>>

    Type parameters

    • TSchema

    • FieldType = any

    • AssignableType = FieldType

    OperationTime

    OperationTime: Timestamp

    Represents a specific point in time on a server. Can be retrieved by using db.command()

    -
    see

    https://docs.mongodb.com/manual/reference/method/db.runCommand/#response

    +
    see

    https://www.mongodb.com/docs/manual/reference/method/db.runCommand/#response

    OptionalId

    OptionalId<TSchema>: EnhancedOmit<TSchema, "_id"> & { _id?: InferIdType<TSchema> }

    Add an optional _id field to an object shaped type

    Type parameters

    • TSchema

    OptionalUnlessRequiredId

    OptionalUnlessRequiredId<TSchema>: TSchema extends { _id: any } ? TSchema : OptionalId<TSchema>
    diff --git a/docs/_sources/api-articles/nodekoarticle1.txt b/docs/_sources/api-articles/nodekoarticle1.txt index 85485b92461..a9481b392a3 100644 --- a/docs/_sources/api-articles/nodekoarticle1.txt +++ b/docs/_sources/api-articles/nodekoarticle1.txt @@ -280,7 +280,7 @@ efficient way is to replace the whole document, this is not really the way to go if you want to change just a field in your document. Luckily Mongo DB provides a whole set of operations that let you modify just pieces of the document `Atomic operations -documentation `_. +documentation `_. Basically outlined below. - $inc - increment a particular value by a certain amount @@ -379,7 +379,7 @@ and Mongo DB is no exception. Fortunately for us it has a rich query interface with cursors and close to SQL concepts for slicing and dicing your datasets. To build queries we have lots of operators to choose from `Mongo DB advanced -queries `_. There +queries `_. There are literarily tons of ways to search and ways to limit the query. Let's look at some simple code for dealing with queries in different ways. @@ -461,7 +461,6 @@ Links and stuff - `All the integration tests, they have tons of different usage cases `_ - `The Mongo DB wiki pages such as the advanced query - link `_ + link `_ - `A silly simple location based application using Express JS and Mongo DB `_ - diff --git a/docs/_sources/api-generated/db.txt b/docs/_sources/api-generated/db.txt index 46e898b20e1..09bb0855ce1 100644 --- a/docs/_sources/api-generated/db.txt +++ b/docs/_sources/api-generated/db.txt @@ -41,7 +41,7 @@ Options Constants ------------------ -.. csv-table:: +.. csv-table:: :header: "Constant Name", "Value", "Description" :widths: 15, 10, 30 @@ -57,13 +57,13 @@ Initialize the database connection. .. js:function:: open(callback) :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the index information or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + An example of a simple single server db connection .. code-block:: javascript @@ -84,13 +84,13 @@ Initialize the database connection. // Establish connection to db db.open(function(err, db) { assert.equal(null, err); - + db.on('close', test.done.bind(test)); db.close(); }); - - + + Simple replicaset connection setup, requires a running replicaset on the correct ports .. code-block:: javascript @@ -118,8 +118,8 @@ Initialize the database connection. p_db.close(); }); - - + + Example of Read Preference usage at the query level. .. code-block:: javascript @@ -147,7 +147,7 @@ Initialize the database connection. db.on("fullsetup", function() { // Rip out secondaries forcing an attempt to read from the primary db.serverConfig._state.secondaries = {}; - + // Grab the collection db.collection("read_preference_replicaset_test_0", function(err, collection) { // Attempt to read (should fail due to the server not being a primary); @@ -159,14 +159,14 @@ Initialize the database connection. }); }); }); - + // Connect to the db db.open(function(err, p_db) { db = p_db; }); - - + + A Simple example off connecting to Mongos with a list of alternative proxies. .. code-block:: javascript @@ -188,23 +188,23 @@ Initialize the database connection. new Server("localhost", 50000, { auto_reconnect: true }), new Server("localhost", 50001, { auto_reconnect: true }) ]) - + // Connect using the mongos connections var db = new Db('integration_test_', mongos, {w:0}); db.open(function(err, db) { assert.equal(null, err); assert.ok(db != null); - + // Perform a simple insert into a collection var collection = db.collection("shard_test"); // Insert a simple doc collection.insert({test:1}, {w:1}, function(err, result) { assert.equal(null, err); - + collection.findOne({test:1}, {}, {readPreference:new ReadPreference(ReadPreference.SECONDARY)}, function(err, item) { assert.equal(null, err); assert.equal(1, item.test); - + db.close(); }) }); @@ -226,8 +226,8 @@ Create a new Db instance sharing the current socket connections. **Examples** - - + + Simple example connecting to two different databases sharing the socket connections below. .. code-block:: javascript @@ -245,29 +245,29 @@ Create a new Db instance sharing the current socket connections. assert = require('assert'); var db = new Db('test', new Server('localhost', 27017)); - // Establish connection to db + // Establish connection to db db.open(function(err, db) { assert.equal(null, err); - + // Reference a different database sharing the same connections // for the data transfer var secondDb = db.db("integration_tests_2"); - + // Fetch the collections var multipleColl1 = db.collection("multiple_db_instances"); var multipleColl2 = secondDb.collection("multiple_db_instances"); - + // Write a record into each and then count the records stored - multipleColl1.insert({a:1}, {w:1}, function(err, result) { + multipleColl1.insert({a:1}, {w:1}, function(err, result) { multipleColl2.insert({a:1}, {w:1}, function(err, result) { - + // Count over the results ensuring only on record in each collection multipleColl1.count(function(err, count) { assert.equal(1, count); - + multipleColl2.count(function(err, count) { assert.equal(1, count); - + db.close(); }); }); @@ -287,13 +287,13 @@ Close the current db connection, including all the child db instances. Emits clo :param boolean [forceClose]: connection can never be reused. :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the results or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + An example that shows how to force close a db connection so it cannot be reused. .. code-block:: javascript @@ -313,17 +313,17 @@ Close the current db connection, including all the child db instances. Emits clo var db = new Db('test', new Server('localhost', 27017)); // Establish connection to db db.open(function(err, db) { - + // Fetch a collection var collection = db.collection('shouldCorrectlyFailOnRetryDueToAppCloseOfDb'); - + // Insert a document collection.insert({a:1}, {w:1}, function(err, result) { assert.equal(null, err); - + // Force close the connection db.close(true, function(err, result) { - + // Attemp to insert should fail now with correct message 'db closed by application' collection.insert({a:2}, {w:1}, function(err, result) { assert.equal('db closed by application', err.message); @@ -332,8 +332,8 @@ Close the current db connection, including all the child db instances. Emits clo }); }); - - + + An example of a simple single server db connection and close function .. code-block:: javascript @@ -354,11 +354,11 @@ Close the current db connection, including all the child db instances. Emits clo // Establish connection to db db.open(function(err, db) { assert.equal(null, err); - + // Close the connection with a callback that is optional db.close(function(err, result) { assert.equal(null, err); - + }); }); @@ -378,8 +378,8 @@ Access the Admin database **Examples** - - + + Example showing how to access the Admin database for admin level operations. .. code-block:: javascript @@ -398,11 +398,11 @@ Access the Admin database var db = new Db('test', new Server('localhost', 27017)); db.open(function(err, db) { - + // Use the admin database for the operation var adminDb = db.admin() assert.ok(adminDb != null); - + db.close(); }); @@ -418,13 +418,13 @@ Returns a cursor to all the collection information. :param string [collectionName]: the collection name we wish to retrieve the information from. :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the options or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + An example of retrieving the information of all the collections. .. code-block:: javascript @@ -445,22 +445,22 @@ Returns a cursor to all the collection information. // Establish connection to db db.open(function(err, db) { assert.equal(null, err); - + // Create a collection db.createCollection('test_collections_info', function(err, r) { assert.equal(null, err); - + // Return the information of a single collection name db.collectionsInfo("test_collections_info").toArray(function(err, items) { assert.equal(1, items.length); - + // Return the information of a all collections, using the callback format db.collectionsInfo(function(err, cursor) { - + // Turn the cursor into an array of results cursor.toArray(function(err, items) { assert.ok(items.length > 0); - + db.close(); }); }) @@ -486,13 +486,13 @@ Options :param string [collectionName]: the collection name we wish to filter by. :param object [options]: additional options during update. :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the collection names or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + An example of retrieving the collection names for a database. .. code-block:: javascript @@ -513,19 +513,19 @@ Options // Establish connection to db db.open(function(err, db) { assert.equal(null, err); - + // Create a collection db.createCollection('test_collections_info', function(err, r) { assert.equal(null, err); - + // Return the information of a single collection name db.collectionNames("test_collections_info", function(err, items) { assert.equal(1, items.length); - + // Return the information of a all collections, using the callback format db.collectionNames(function(err, items) { assert.ok(items.length > 0); - + db.close(); }); }); @@ -559,13 +559,13 @@ Options :param string collectionName: the collection name we wish to access. :param object [options]: returns option results. :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the collection or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + An example of retrieving a collection from a db using the collection function. .. code-block:: javascript @@ -586,25 +586,25 @@ Options // Establish connection to db db.open(function(err, db) { assert.equal(null, err); - + // Grab a collection without a callback no safe mode var col1 = db.collection('test_correctly_access_collections'); - + // Grab a collection with a callback but no safe operation db.collection('test_correctly_access_collections', function(err, col2) { assert.equal(null, err); - + // Grab a collection with a callback in safe mode, ensuring it exists (should fail as it's not created) db.collection('test_correctly_access_collections', {strict:true}, function(err, col3) { assert.ok(err != null); - + // Create the collection db.createCollection('test_correctly_access_collections', function(err, result) { - + // Retry to get the collection, should work as it's now created db.collection('test_correctly_access_collections', {strict:true}, function(err, col3) { assert.equal(null, err); - + db.close(); }); }); @@ -623,13 +623,13 @@ Fetch all collections for the current db. .. js:function:: collections(callback) :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the collections or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + An example of retrieving all collections for a db as Collection objects .. code-block:: javascript @@ -650,15 +650,15 @@ Fetch all collections for the current db. // Establish connection to db db.open(function(err, db) { assert.equal(null, err); - + // Create the collection db.createCollection('test_correctly_access_collections2', function(err, result) { - + // Retry to get the collection, should work as it's now created db.collections(function(err, collections) { assert.equal(null, err); assert.ok(collections.length > 0); - + db.close(); }); }); @@ -683,13 +683,13 @@ Options :param object [parameters]: the parameters for the call. :param object [options]: the options :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the results from eval or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + A whole bunch of examples on how to use eval on the server. .. code-block:: javascript @@ -710,26 +710,26 @@ Options // Establish connection to db db.open(function(err, db) { var numberOfTests = 10; - + var tests_done = function() { numberOfTests = numberOfTests - 1; - + if(numberOfTests == 0) { db.close(); } } - + // Evaluate a function on the server with the parameter 3 passed in db.eval('function (x) {return x;}', [3], function(err, result) { assert.equal(3, result); tests_done(); }); - + // Evaluate a function on the server with the parameter 3 passed in no lock aquired for eval // on server db.eval('function (x) {return x;}', [3], {nolock:true}, function(err, result) { assert.equal(3, result); tests_done(); }); - + // Evaluate a function on the server that writes to a server collection db.eval('function (x) {db.test_eval.save({y:x});}', [5], function(err, result) { // Locate the entry @@ -739,37 +739,37 @@ Options }); }); }); - + // Evaluate a function with 2 parameters passed in db.eval('function (x, y) {return x + y;}', [2, 3], function(err, result) { assert.equal(5, result); tests_done(); }); - + // Evaluate a function with no parameters passed in db.eval('function () {return 5;}', function(err, result) { assert.equal(5, result); tests_done(); }); - + // Evaluate a statement db.eval('2 + 3;', function(err, result) { assert.equal(5, result); tests_done(); }); - + // Evaluate a statement using the code object db.eval(new Code("2 + 3;"), function(err, result) { assert.equal(5, result); tests_done(); }); - + // Evaluate a statement using the code object including a scope db.eval(new Code("return i;", {'i':2}), function(err, result) { assert.equal(2, result); tests_done(); }); - + // Evaluate a statement using the code object including a scope db.eval(new Code("i + 3;", {'i':2}), function(err, result) { assert.equal(5, result); tests_done(); }); - + // Evaluate an illegal statement db.eval("5 ++ 5;", function(err, result) { assert.ok(err instanceof Error); @@ -781,9 +781,9 @@ Options }); }); - - - Defining and calling a system level javascript function (NOT recommended, http://www.mongodb.org/display/DOCS/Server-side+Code+Execution) + + + Defining and calling a system level javascript function (NOT recommended, www.mongodb.com/docs/display/DOCS/Server-side+Code+Execution) .. code-block:: javascript @@ -802,19 +802,19 @@ Options var db = new Db('test', new Server('localhost', 27017)); // Establish connection to db db.open(function(err, db) { - + // Clean out the collection db.collection("system.js").remove({}, {w:1}, function(err, result) { assert.equal(null, err); - + // Define a system level function db.collection("system.js").insert({_id: "echo", value: new Code("function(x) { return x; }")}, {w:1}, function(err, result) { assert.equal(null, err); - + db.eval("echo(5)", function(err, result) { assert.equal(null, err); assert.equal(5, result); - + db.close(); }); }); @@ -833,13 +833,13 @@ Dereference a dbref, against a db :param dbref dbRef: db reference object we wish to resolve. :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the results from dereference or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + An example of dereferencing values. .. code-block:: javascript @@ -860,30 +860,30 @@ Dereference a dbref, against a db // Establish connection to db db.open(function(err, db) { assert.equal(null, err); - + // Get a second db var secondDb = db.db('integration_tests_2'); - + // Create a dereference example secondDb.createCollection('test_deref_examples', function(err, collection) { - + // Insert a document in the collection collection.insert({'a':1}, {w:1}, function(err, ids) { - + // Let's build a db reference and resolve it var dbRef = new DBRef('test_deref_examples', ids[0]._id, 'integration_tests_2'); - + // Resolve it including a db resolve db.dereference(dbRef, function(err, item) { assert.equal(1, item.a); - + // Let's build a db reference and resolve it var dbRef = new DBRef('test_deref_examples', ids[0]._id); - + // Simple local resolve secondDb.dereference(dbRef, function(err, item) { assert.equal(1, item.a); - + db.close(); }); }); @@ -902,13 +902,13 @@ Logout user from server, fire off on all connections and remove all auth info .. js:function:: logout(callback) :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the results from logout or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + An example of using the logout command for the database. .. code-block:: javascript @@ -929,23 +929,23 @@ Logout user from server, fire off on all connections and remove all auth info // Establish connection to db db.open(function(err, db) { assert.equal(null, err); - + // Add a user to the database db.addUser('user3', 'name', function(err, result) { assert.equal(null, err); - + // Authenticate db.authenticate('user3', 'name', function(err, result) { assert.equal(true, result); - + // Logout the db db.logout(function(err, result) { assert.equal(true, result); - + // Remove the user db.removeUser('user3', function(err, result) { assert.equal(true, result); - + db.close(); }); }); @@ -970,13 +970,13 @@ Options :param string password: password. :param object [options]: the options :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the results from authentication or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + An example of using the authenticate command. .. code-block:: javascript @@ -997,15 +997,15 @@ Options // Establish connection to db db.open(function(err, db) { assert.equal(null, err); - + // Add a user to the database db.addUser('user2', 'name', function(err, result) { assert.equal(null, err); - + // Authenticate db.authenticate('user2', 'name', function(err, result) { assert.equal(true, result); - + db.close(); }); }); @@ -1035,13 +1035,13 @@ Options :param string password: password. :param object [options]: additional options during update. :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the results from addUser or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + An example of adding a user to the database. .. code-block:: javascript @@ -1062,11 +1062,11 @@ Options // Establish connection to db db.open(function(err, db) { assert.equal(null, err); - + // Add a user to the database db.addUser('user', 'name', function(err, result) { assert.equal(null, err); - + db.close(); }); }); @@ -1092,13 +1092,13 @@ Options :param string username: username. :param object [options]: additional options during update. :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the results from removeUser or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + An example of dereferencing values. .. code-block:: javascript @@ -1119,26 +1119,26 @@ Options // Establish connection to db db.open(function(err, db) { assert.equal(null, err); - + // Add a user to the database db.addUser('user', 'name', function(err, result) { assert.equal(null, err); - + // Authenticate db.authenticate('user', 'name', function(err, result) { assert.equal(true, result); - + // Logout the db db.logout(function(err, result) { assert.equal(true, result); - + // Remove the user from the db db.removeUser('user', function(err, result) { - + // Authenticate db.authenticate('user', 'name', function(err, result) { assert.equal(false, result); - + db.close(); }); }); @@ -1177,13 +1177,13 @@ Options :param string collectionName: the collection name we wish to access. :param object [options]: returns option results. :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the results from createCollection or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + A simple example showing the creation of a collection. .. code-block:: javascript @@ -1204,15 +1204,15 @@ Options // Establish connection to db db.open(function(err, db) { assert.equal(null, err); - + // Create a capped collection with a maximum of 1000 documents db.createCollection("a_simple_collection", {capped:true, size:10000, max:1000, w:1}, function(err, collection) { assert.equal(null, err); - + // Insert a document in the capped collection collection.insert({a:1}, {w:1}, function(err, result) { assert.equal(null, err); - + db.close(); }); }); @@ -1240,13 +1240,13 @@ Options :param object selector: the command hash to send to the server, ex: {ping:1}. :param object [options]: additional options for the command. :param function callback: this will be called after executing this method. The command always return the whole result of the command as the second parameter. - :returns: null + :returns: null **Examples** - - + + A simple example creating, dropping a collection and then verifying that the collection is gone. .. code-block:: javascript @@ -1267,11 +1267,11 @@ Options // Establish connection to db db.open(function(err, db) { assert.equal(null, err); - + // Execute ping against the server db.command({ping:1}, function(err, result) { assert.equal(null, err); - + db.close(); }); }); @@ -1288,13 +1288,13 @@ Drop a collection from the database, removing it permanently. New accesses will :param string collectionName: the name of the collection we wish to drop. :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the results from dropCollection or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + A simple example executing a command against the server. .. code-block:: javascript @@ -1315,27 +1315,27 @@ Drop a collection from the database, removing it permanently. New accesses will // Establish connection to db db.open(function(err, db) { assert.equal(null, err); - + // Execute ping against the server db.command({ping:1}, function(err, result) { assert.equal(null, err); - + // Create a capped collection with a maximum of 1000 documents db.createCollection("a_simple_create_drop_collection", {capped:true, size:10000, max:1000, w:1}, function(err, collection) { assert.equal(null, err); - + // Insert a document in the capped collection collection.insert({a:1}, {w:1}, function(err, result) { assert.equal(null, err); - + // Drop the collection from this world db.dropCollection("a_simple_create_drop_collection", function(err, result) { assert.equal(null, err); - + // Verify that the collection is gone db.collectionNames("a_simple_create_drop_collection", function(err, names) { assert.equal(0, names.length); - + db.close(); }); }); @@ -1363,13 +1363,13 @@ Options :param string toCollection: the new name of the collection. :param object [options]: returns option results. :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the results from renameCollection or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + A simple example creating, dropping a collection and then verifying that the collection is gone. .. code-block:: javascript @@ -1390,31 +1390,31 @@ Options // Establish connection to db db.open(function(err, db) { assert.equal(null, err); - + // Create a collection db.createCollection("simple_rename_collection", {w:1}, function(err, collection) { assert.equal(null, err); - + // Insert a document in the collection collection.insert({a:1}, {w:1}, function(err, result) { assert.equal(null, err); - + // Rename the collection db.renameCollection("simple_rename_collection", "simple_rename_collection_2", function(err, collection2) { assert.equal(null, err); - + // Retrieve the number of documents from the collection collection2.count(function(err, count) { assert.equal(1, count); - + // Verify that the collection is gone db.collectionNames("simple_rename_collection", function(err, names) { assert.equal(0, names.length); - + // Verify that the new collection exists db.collectionNames("simple_rename_collection_2", function(err, names) { assert.equal(1, names.length); - + db.close(); }); }); @@ -1455,13 +1455,13 @@ Options :param object fieldOrSpec: fieldOrSpec that defines the index. :param object [options]: additional options during update. :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the results from createIndex or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + A more complex createIndex using a compound unique index in the background and dropping duplicated documents .. code-block:: javascript @@ -1481,31 +1481,31 @@ Options var db = new Db('test', new Server('localhost', 27017)); // Establish connection to db db.open(function(err, db) { - + // Create a collection we want to drop later db.createCollection('more_complex_index_test', function(err, collection) { assert.equal(null, err); - + // Insert a bunch of documents for the index collection.insert([{a:1, b:1}, {a:1, b:1} , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) { assert.equal(null, err); - + // Create an index on the a field db.createIndex('more_complex_index_test', {a:1, b:1} , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) { - + // Show that duplicate records got dropped collection.find({}).toArray(function(err, items) { assert.equal(null, err); assert.equal(4, items.length); - + // Peform a query, with explain to show we hit the query collection.find({a:2}, {explain:true}).toArray(function(err, explanation) { assert.equal(null, err); assert.ok(explanation[0].indexBounds.a != null); assert.ok(explanation[0].indexBounds.b != null); - + db.close(); }); }) @@ -1545,13 +1545,13 @@ Options :param object fieldOrSpec: fieldOrSpec that defines the index. :param object [options]: additional options during update. :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the results from ensureIndex or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + A more complex ensureIndex using a compound unique index in the background and dropping duplicated documents. .. code-block:: javascript @@ -1571,31 +1571,31 @@ Options var db = new Db('test', new Server('localhost', 27017)); // Establish connection to db db.open(function(err, db) { - + // Create a collection we want to drop later db.createCollection('more_complex_ensure_index_db_test', function(err, collection) { assert.equal(null, err); - + // Insert a bunch of documents for the index collection.insert([{a:1, b:1}, {a:1, b:1} , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) { assert.equal(null, err); - + // Create an index on the a field db.ensureIndex('more_complex_ensure_index_db_test', {a:1, b:1} , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) { - + // Show that duplicate records got dropped collection.find({}).toArray(function(err, items) { assert.equal(null, err); assert.equal(4, items.length); - + // Peform a query, with explain to show we hit the query collection.find({a:2}, {explain:true}).toArray(function(err, explanation) { assert.equal(null, err); assert.ok(explanation[0].indexBounds.a != null); assert.ok(explanation[0].indexBounds.b != null); - + db.close(); }); }) @@ -1621,13 +1621,13 @@ Options :param object [options]: additional options during update. :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the results from cursorInfo or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + A Simple example of returning current cursor information in MongoDB .. code-block:: javascript @@ -1647,30 +1647,30 @@ Options var db = new Db('test', new Server('localhost', 27017)); // Establish connection to db db.open(function(err, db) { - + // Create a collection we want to drop later db.createCollection('cursor_information_collection', function(err, collection) { assert.equal(null, err); - + // Create a bunch of documents so we can force the creation of a cursor var docs = []; for(var i = 0; i < 1000; i++) { docs.push({a:'hello world hello world hello world hello world hello world hello world hello world hello world'}); } - + // Insert a bunch of documents for the index collection.insert(docs, {w:1}, function(err, result) { assert.equal(null, err); - + // Let's set a cursor var cursor = collection.find({}, {batchSize:10}); cursor.nextObject(function(err, item) { assert.equal(null, err); - + // Let's grab the information about the cursors on the database db.cursorInfo(function(err, cursorInformation) { assert.ok(cursorInformation.totalOpen > 0); - + db.close(); }); }); @@ -1691,13 +1691,13 @@ Drop an index on a collection. :param string collectionName: the name of the collection where the command will drop an index. :param string indexName: name of the index to drop. :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the results from dropIndex or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + An examples showing the creation and dropping of an index .. code-block:: javascript @@ -1717,29 +1717,29 @@ Drop an index on a collection. var db = new Db('test', new Server('localhost', 27017)); // Establish connection to db db.open(function(err, db) { - + // Create a collection we want to drop later db.createCollection('create_and_drop_an_index', function(err, collection) { assert.equal(null, err); - + // Insert a bunch of documents for the index collection.insert([{a:1, b:1}, {a:1, b:1} , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) { assert.equal(null, err); - + // Create an index on the a field collection.ensureIndex({a:1, b:1} , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) { - + // Drop the index db.dropIndex("create_and_drop_an_index", "a_1_b_1", function(err, result) { assert.equal(null, err); - + // Verify that the index is gone collection.indexInformation(function(err, indexInformation) { assert.deepEqual([ [ '_id', 1 ] ], indexInformation._id_); assert.equal(null, indexInformation.a_1_b_1); - + db.close(); }); }); @@ -1764,8 +1764,8 @@ Warning: reIndex is a blocking operation (indexes are rebuilt in the foreground) **Examples** - - + + An example showing how to force a reindex of a collection. .. code-block:: javascript @@ -1785,30 +1785,30 @@ Warning: reIndex is a blocking operation (indexes are rebuilt in the foreground) var db = new Db('test', new Server('localhost', 27017)); // Establish connection to db db.open(function(err, db) { - + // Create a collection we want to drop later db.createCollection('create_and_drop_all_indexes', function(err, collection) { assert.equal(null, err); - + // Insert a bunch of documents for the index collection.insert([{a:1, b:1}, {a:1, b:1} , {a:2, b:2}, {a:3, b:3}, {a:4, b:4, c:4}], {w:1}, function(err, result) { assert.equal(null, err); - + // Create an index on the a field collection.ensureIndex({a:1, b:1} , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) { - + // Force a reindex of the collection db.reIndex('create_and_drop_all_indexes', function(err, result) { assert.equal(null, err); assert.equal(true, result); - + // Verify that the index is gone collection.indexInformation(function(err, indexInformation) { assert.deepEqual([ [ '_id', 1 ] ], indexInformation._id_); assert.deepEqual([ [ 'a', 1 ], [ 'b', 1 ] ], indexInformation.a_1_b_1); - + db.close(); }); }); @@ -1836,13 +1836,13 @@ Options :param string collectionName: the name of the collection. :param object [options]: additional options during update. :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the results from indexInformation or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + An example showing the information returned by indexInformation .. code-block:: javascript @@ -1862,30 +1862,30 @@ Options var db = new Db('test', new Server('localhost', 27017)); // Establish connection to db db.open(function(err, db) { - + // Create a collection we want to drop later db.createCollection('more_index_information_test', function(err, collection) { assert.equal(null, err); - + // Insert a bunch of documents for the index collection.insert([{a:1, b:1}, {a:1, b:1} , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) { assert.equal(null, err); - + // Create an index on the a field collection.ensureIndex({a:1, b:1} , {unique:true, background:true, dropDups:true, w:1}, function(err, indexName) { - + // Fetch basic indexInformation for collection db.indexInformation('more_index_information_test', function(err, indexInformation) { assert.deepEqual([ [ '_id', 1 ] ], indexInformation._id_); assert.deepEqual([ [ 'a', 1 ], [ 'b', 1 ] ], indexInformation.a_1_b_1); - + // Fetch full index information collection.indexInformation({full:true}, function(err, indexInformation) { assert.deepEqual({ _id: 1 }, indexInformation[0].key); assert.deepEqual({ a: 1, b: 1 }, indexInformation[1].key); - + db.close(); }); }); @@ -1905,13 +1905,13 @@ Drop a database. .. js:function:: dropDatabase(callback) :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the results from dropDatabase or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + An examples showing the dropping of a database .. code-block:: javascript @@ -1931,20 +1931,20 @@ Drop a database. var db = new Db('test', new Server('localhost', 27017)); // Establish connection to db db.open(function(err, db) { - + // Create a collection db.createCollection('more_index_information_test', function(err, collection) { assert.equal(null, err); - + // Insert a bunch of documents for the index collection.insert([{a:1, b:1}, {a:1, b:1} , {a:2, b:2}, {a:3, b:3}, {a:4, b:4}], {w:1}, function(err, result) { assert.equal(null, err); - + // Let's drop the database db.dropDatabase(function(err, result) { assert.equal(null, err); - + // Wait to seconds to let it replicate across setTimeout(function() { // Get the admin database @@ -1953,15 +1953,15 @@ Drop a database. dbs = dbs.databases; // Did we find the db var found = false; - + // Check if we have the db in the list for(var i = 0; i < dbs.length; i++) { if(dbs[i].name == 'integration_tests_to_drop') found = true; } - + // We should not find the databases if(process.env['JENKINS'] == null) assert.equal(false, found); - + db.close(); }); }, 2000); @@ -1988,13 +1988,13 @@ Options :param objects [options]: options for the stats command :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the results from stats or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + An example showing how to retrieve the db statistics .. code-block:: javascript @@ -2015,11 +2015,11 @@ Options // Establish connection to db db.open(function(err, db) { assert.equal(null, err); - + db.stats(function(err, stats) { assert.equal(null, err); assert.ok(stats != null); - + db.close(); }) }); @@ -2050,13 +2050,13 @@ Options :param string url: connection url for MongoDB. :param object [options]: optional options for insert command :param function callback: this will be called after executing this method. The first parameter will contain the Error object if an error occurred, or null otherwise. While the second parameter will contain the db instance or null if an error occurred. - :returns: null + :returns: null **Examples** - - + + Example of a simple url connection string, with no acknowledgement of writes. .. code-block:: javascript @@ -2076,7 +2076,6 @@ Options // Connect to the server Db.connect(configuration.url(), function(err, db) { assert.equal(null, err); - + db.close(); }); - diff --git a/docs/_sources/driver-articles/mongoclient.txt b/docs/_sources/driver-articles/mongoclient.txt index d9025c9da8e..b634d39df02 100644 --- a/docs/_sources/driver-articles/mongoclient.txt +++ b/docs/_sources/driver-articles/mongoclient.txt @@ -136,7 +136,7 @@ Write concern configuration: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ More detailed information about write concerns can be found at -`http://www.mongodb.org/display/DOCS/getLastError+Command `_ +`www.mongodb.com/docs/display/DOCS/getLastError+Command `_ - **w=wValue** @@ -466,4 +466,3 @@ mongos: A hash of options at the mongos level not supported by the url. to reconnect to down proxies - **haInterval** {Number, default:2000}, time between each replicaset status check. - diff --git a/docs/_sources/index.txt b/docs/_sources/index.txt index 686a0d0e5b3..08f13eadc3d 100644 --- a/docs/_sources/index.txt +++ b/docs/_sources/index.txt @@ -66,7 +66,7 @@ MongoDB in General ------------------ There are two main places to learn about MongoDB itself. I've included links below. - * http://www.mongodb.org, all the documentation for the database + * www.mongodb.com/docs, all the documentation for the database * http://www.10gen.com/presentations, lots of presentations and slides about using the database. There are also some very good books out these days @@ -94,4 +94,4 @@ Indices ------- - :ref:`genindex` -- :ref:`search` \ No newline at end of file +- :ref:`search` diff --git a/docs/_sources/markdown-docs/gridfs.txt b/docs/_sources/markdown-docs/gridfs.txt index 0c4dcf9b3ee..ededfb9ba85 100644 --- a/docs/_sources/markdown-docs/gridfs.txt +++ b/docs/_sources/markdown-docs/gridfs.txt @@ -5,7 +5,7 @@ GridFS is a scalable MongoDB *filesystem* for storing and retrieving large files. The default limit for a MongoDB record is 16MB, so to store data that is larger than this limit, GridFS can be used. GridFS shards the data into smaller chunks automatically. See `MongoDB -documentation `_ +documentation `_ for details. GridStore is a single file inside GridFS that can be managed by the diff --git a/docs/_sources/markdown-docs/indexes.txt b/docs/_sources/markdown-docs/indexes.txt index 040c4b2fb68..46fd91be804 100644 --- a/docs/_sources/markdown-docs/indexes.txt +++ b/docs/_sources/markdown-docs/indexes.txt @@ -7,7 +7,7 @@ index set, then the query will be a lot faster compared to if the index was not present. See `MongoDB -documentation `_ for +documentation `_ for details. Create indexes with createIndex() diff --git a/docs/_sources/markdown-docs/insert.txt b/docs/_sources/markdown-docs/insert.txt index 975639fa86f..aa8f9992b5b 100644 --- a/docs/_sources/markdown-docs/insert.txt +++ b/docs/_sources/markdown-docs/insert.txt @@ -110,7 +110,7 @@ else intact. collection.update({_id:"123"}, {$set: {author:"Jessica"}}); See `MongoDB -documentation `_ for all +documentation `_ for all possible operators. Find and Modify @@ -154,7 +154,7 @@ Example :: var MongoClient = require('mongodb').MongoClient - , format = require('util').format; + , format = require('util').format; MongoClient.connect('mongodb://127.0.0.1:27017/test', function(err, db) { if(err) throw err; @@ -172,4 +172,3 @@ Example } }); }); - diff --git a/docs/index.html b/docs/index.html index 05a1f304596..f05773e3683 100644 --- a/docs/index.html +++ b/docs/index.html @@ -35,10 +35,10 @@ @@ -59,7 +59,7 @@

    MongoDB Node.js Driver

    - Latest documentation + Latest documentation

    @@ -87,14 +87,14 @@

    Features

    Whether you are new to MongoDB or you just want to brush up on the core concepts, you can check out the Fundamentals section which features material on using the Node.js driver for the following:
      -
    • Connection Guide: connect to a MongoDB instance or replica set
      • -
    • Authentication: configure authentication and log a user in
      • -
    • CRUD Operations: read and write data to MongoDB
      • -
    • Promises and Callbacks: access return values using asynchronous Javascript
      • -
    • Indexes: create and design indexes to make your queries efficient
      • -
    • Collations: apply language-specific sorting rules to your query results
      • -
    • Logging: configure the driver to log MongoDB operations
      • -
    • Monitoring: configure the driver to monitor MongoDB server events
      • +
    • Connection Guide: connect to a MongoDB instance or replica set
      • +
    • Authentication: configure authentication and log a user in
      • +
    • CRUD Operations: read and write data to MongoDB
      • +
    • Promises and Callbacks: access return values using asynchronous Javascript
      • +
    • Indexes: create and design indexes to make your queries efficient
      • +
    • Collations: apply language-specific sorting rules to your query results
      • +
    • Logging: configure the driver to log MongoDB operations
      • +
    • Monitoring: configure the driver to monitor MongoDB server events
    @@ -125,7 +125,7 @@

    Releases

    - Reference + Reference | @@ -155,7 +155,7 @@

    Releases

    - Reference + Reference | @@ -170,7 +170,7 @@

    Releases

    - Reference + Reference | @@ -185,7 +185,7 @@

    Releases

    - Reference + Reference | @@ -200,7 +200,7 @@

    Releases

    - Reference + Reference | @@ -215,7 +215,7 @@

    Releases

    - Reference + Reference | @@ -230,7 +230,7 @@

    Releases

    - Reference + Reference | @@ -245,7 +245,7 @@

    Releases

    - Reference + Reference | @@ -260,7 +260,7 @@

    Releases

    - Reference + Reference | @@ -275,7 +275,7 @@

    Releases

    - Reference + Reference | @@ -290,7 +290,7 @@

    Releases

    - Reference + Reference | @@ -305,7 +305,7 @@

    Releases

    - Reference + Reference | @@ -320,7 +320,7 @@

    Releases

    - Reference + Reference | @@ -335,7 +335,7 @@

    Releases

    - Reference + Reference | @@ -350,7 +350,7 @@

    Releases

    - Reference + Reference | @@ -365,7 +365,7 @@

    Releases

    - Reference + Reference | @@ -380,7 +380,7 @@

    Releases

    - Reference + Reference | @@ -564,7 +564,7 @@

    M101JS: MongoDB for Node.JS Developers

    -

    Copyright © 2022 MongoDB, Inc. +

    Copyright © 2022 MongoDB, Inc. Licensed under Creative Commons. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.

    diff --git a/docs/modules/mongoose/index.html b/docs/modules/mongoose/index.html index 45c90dc153e..62c9248d4de 100644 --- a/docs/modules/mongoose/index.html +++ b/docs/modules/mongoose/index.html @@ -57,7 +57,7 @@

    Node.js And MongoDB

  • - + 1.4 Driver Docs @@ -67,7 +67,7 @@

    Node.js And MongoDB

  • - + 2.0 Driver Docs @@ -77,7 +77,7 @@

    Node.js And MongoDB

  • - + 1.1 Core Docs diff --git a/docs/schema/chapter1/index.html b/docs/schema/chapter1/index.html index c584e24dcaf..2c615295d37 100644 --- a/docs/schema/chapter1/index.html +++ b/docs/schema/chapter1/index.html @@ -84,7 +84,7 @@

    Introduction

  • - + 2.0 driver docs @@ -94,7 +94,7 @@

    Introduction

  • - + 1.4 driver docs @@ -104,7 +104,7 @@

    Introduction

  • - + Core driver docs diff --git a/docs/schema/chapter10/index.html b/docs/schema/chapter10/index.html index 331ce0c530c..559dbdb3508 100644 --- a/docs/schema/chapter10/index.html +++ b/docs/schema/chapter10/index.html @@ -84,7 +84,7 @@

    Shopping Cart

  • - + 2.0 driver docs @@ -94,7 +94,7 @@

    Shopping Cart

  • - + 1.4 driver docs @@ -104,7 +104,7 @@

    Shopping Cart

  • - + Core driver docs diff --git a/docs/schema/chapter11/index.html b/docs/schema/chapter11/index.html index b2b73c9fcd0..5aafe112381 100644 --- a/docs/schema/chapter11/index.html +++ b/docs/schema/chapter11/index.html @@ -84,7 +84,7 @@

    Sharding

  • - + 2.0 driver docs @@ -94,7 +94,7 @@

    Sharding

  • - + 1.4 driver docs @@ -104,7 +104,7 @@

    Sharding

  • - + Core driver docs diff --git a/docs/schema/chapter2/index.html b/docs/schema/chapter2/index.html index 34b404f3018..20b549797d6 100644 --- a/docs/schema/chapter2/index.html +++ b/docs/schema/chapter2/index.html @@ -84,7 +84,7 @@

    Schema Basics

  • - + 2.0 driver docs @@ -94,7 +94,7 @@

    Schema Basics

  • - + 1.4 driver docs @@ -104,7 +104,7 @@

    Schema Basics

  • - + Core driver docs diff --git a/docs/schema/chapter3/index.html b/docs/schema/chapter3/index.html index 8a736ef7a2b..3f243f6e69a 100644 --- a/docs/schema/chapter3/index.html +++ b/docs/schema/chapter3/index.html @@ -84,7 +84,7 @@

    MongoDB Storage

  • - + 2.0 driver docs @@ -94,7 +94,7 @@

    MongoDB Storage

  • - + 1.4 driver docs @@ -104,7 +104,7 @@

    MongoDB Storage

  • - + Core driver docs diff --git a/docs/schema/chapter4/index.html b/docs/schema/chapter4/index.html index 76982cac2f5..96844da2349 100644 --- a/docs/schema/chapter4/index.html +++ b/docs/schema/chapter4/index.html @@ -84,7 +84,7 @@

    Indexes

  • - + 2.0 driver docs @@ -94,7 +94,7 @@

    Indexes

  • - + 1.4 driver docs @@ -104,7 +104,7 @@

    Indexes

  • - + Core driver docs diff --git a/docs/schema/chapter5/index.html b/docs/schema/chapter5/index.html index 4123aeca4d2..37b4c99c796 100644 --- a/docs/schema/chapter5/index.html +++ b/docs/schema/chapter5/index.html @@ -84,7 +84,7 @@

    Metadata

  • - + 2.0 driver docs @@ -94,7 +94,7 @@

    Metadata

  • - + 1.4 driver docs @@ -104,7 +104,7 @@

    Metadata

  • - + Core driver docs diff --git a/docs/schema/chapter6/index.html b/docs/schema/chapter6/index.html index 179c2380eb4..baec6d69110 100644 --- a/docs/schema/chapter6/index.html +++ b/docs/schema/chapter6/index.html @@ -84,7 +84,7 @@

    Time Series

  • - + 2.0 driver docs @@ -94,7 +94,7 @@

    Time Series

  • - + 1.4 driver docs @@ -104,7 +104,7 @@

    Time Series

  • - + Core driver docs diff --git a/docs/schema/chapter7/index.html b/docs/schema/chapter7/index.html index ca4d269d1e6..4ce64c162f2 100644 --- a/docs/schema/chapter7/index.html +++ b/docs/schema/chapter7/index.html @@ -84,7 +84,7 @@

    Queues

  • - + 2.0 driver docs @@ -94,7 +94,7 @@

    Queues

  • - + 1.4 driver docs @@ -104,7 +104,7 @@

    Queues

  • - + Core driver docs diff --git a/docs/schema/chapter8/index.html b/docs/schema/chapter8/index.html index 9e345975345..b2f6b7c8e18 100644 --- a/docs/schema/chapter8/index.html +++ b/docs/schema/chapter8/index.html @@ -84,7 +84,7 @@

    Nested Categories

  • - + 2.0 driver docs @@ -94,7 +94,7 @@

    Nested Categories

  • - + 1.4 driver docs @@ -104,7 +104,7 @@

    Nested Categories

  • - + Core driver docs diff --git a/docs/schema/chapter9/index.html b/docs/schema/chapter9/index.html index a8bf9e5dafe..91ecf7b4b63 100644 --- a/docs/schema/chapter9/index.html +++ b/docs/schema/chapter9/index.html @@ -84,7 +84,7 @@

    Account Transactions

  • - + 2.0 driver docs @@ -94,7 +94,7 @@

    Account Transactions

  • - + 1.4 driver docs @@ -104,7 +104,7 @@

    Account Transactions

  • - + Core driver docs diff --git a/etc/docs/template/config.toml b/etc/docs/template/config.toml index 1e82ab06a22..73d6a22bd47 100644 --- a/etc/docs/template/config.toml +++ b/etc/docs/template/config.toml @@ -6,4 +6,4 @@ canonifyurls = false githubRepo = "node-mongodb-native" [params] - referenceDocsUrl = "https://docs.mongodb.com/drivers/node" + referenceDocsUrl = "https://www.mongodb.com/docs/drivers/node" diff --git a/etc/docs/template/data/releases.toml b/etc/docs/template/data/releases.toml index 448acb527ea..be039ec8a6e 100644 --- a/etc/docs/template/data/releases.toml +++ b/etc/docs/template/data/releases.toml @@ -1,5 +1,5 @@ current = "5.1 Driver" -mongoDBManual = "https://docs.mongodb.com/drivers/node/" +mongoDBManual = "https://www.mongodb.com/docs/drivers/node/" [[versions]] version = "Next Driver" diff --git a/etc/docs/template/layouts/partials/features.html b/etc/docs/template/layouts/partials/features.html index f03ee6caedf..f8039f8702b 100644 --- a/etc/docs/template/layouts/partials/features.html +++ b/etc/docs/template/layouts/partials/features.html @@ -5,14 +5,14 @@

    Features

    Whether you are new to MongoDB or you just want to brush up on the core concepts, you can check out the Fundamentals section which features material on using the Node.js driver for the following:
      -
    • Connection Guide: connect to a MongoDB instance or replica set
      • -
    • Authentication: configure authentication and log a user in
      • -
    • CRUD Operations: read and write data to MongoDB
      • -
    • Promises and Callbacks: access return values using asynchronous Javascript
      • -
    • Indexes: create and design indexes to make your queries efficient
      • -
    • Collations: apply language-specific sorting rules to your query results
      • -
    • Logging: configure the driver to log MongoDB operations
      • -
    • Monitoring: configure the driver to monitor MongoDB server events
      • +
    • Connection Guide: connect to a MongoDB instance or replica set
      • +
    • Authentication: configure authentication and log a user in
      • +
    • CRUD Operations: read and write data to MongoDB
      • +
    • Promises and Callbacks: access return values using asynchronous Javascript
      • +
    • Indexes: create and design indexes to make your queries efficient
      • +
    • Collations: apply language-specific sorting rules to your query results
      • +
    • Logging: configure the driver to log MongoDB operations
      • +
    • Monitoring: configure the driver to monitor MongoDB server events
    diff --git a/etc/docs/template/layouts/partials/footer.html b/etc/docs/template/layouts/partials/footer.html index 0b00f7b844d..72db5fd7581 100644 --- a/etc/docs/template/layouts/partials/footer.html +++ b/etc/docs/template/layouts/partials/footer.html @@ -1,6 +1,6 @@
    -

    Copyright © 2022 MongoDB, Inc. +

    Copyright © 2022 MongoDB, Inc. Licensed under Creative Commons. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.

    diff --git a/etc/docs/template/layouts/partials/header/topRight.html b/etc/docs/template/layouts/partials/header/topRight.html index b447f7f3e5f..57c4f73c7b9 100644 --- a/etc/docs/template/layouts/partials/header/topRight.html +++ b/etc/docs/template/layouts/partials/header/topRight.html @@ -1,9 +1,9 @@ diff --git a/etc/notes/CHANGES_4.0.0.md b/etc/notes/CHANGES_4.0.0.md index 12e8717796c..42c1476835d 100644 --- a/etc/notes/CHANGES_4.0.0.md +++ b/etc/notes/CHANGES_4.0.0.md @@ -218,7 +218,7 @@ The same functionality can be achieved using the aggregation pipeline's `$group` ### GridStore removed The deprecated GridStore API has been removed from the driver. -For more information on GridFS [see the mongodb manual](https://docs.mongodb.com/manual/core/gridfs/). +For more information on GridFS [see the mongodb manual](https://www.mongodb.com/docs/manual/core/gridfs/). Below are some snippets that represent equivalent operations: diff --git a/src/change_stream.ts b/src/change_stream.ts index d4b1c7eec88..19e4a395c1e 100644 --- a/src/change_stream.ts +++ b/src/change_stream.ts @@ -74,7 +74,7 @@ export type ResumeToken = unknown; /** * Represents a specific point in time on a server. Can be retrieved by using `db.command()` * @public - * @see https://docs.mongodb.com/manual/reference/method/db.runCommand/#response + * @see https://www.mongodb.com/docs/manual/reference/method/db.runCommand/#response */ export type OperationTime = Timestamp; @@ -117,19 +117,19 @@ export interface ChangeStreamOptions extends Omit { * error. * * **Note**: Unlike {@link Collection#createIndex| createIndex}, this function takes in raw index specifications. - * Index specifications are defined {@link http://docs.mongodb.org/manual/reference/command/createIndexes/| here}. + * Index specifications are defined {@link https://www.mongodb.com/docs/manual/reference/command/createIndexes/| here}. * * @param indexSpecs - An array of index specifications to be created * @param options - Optional settings for the command @@ -705,18 +705,18 @@ export class Collection { * | `$near` | [`$geoWithin`][2] with [`$center`][3] | * | `$nearSphere` | [`$geoWithin`][2] with [`$centerSphere`][4] | * - * [1]: https://docs.mongodb.com/manual/reference/operator/query/expr/ - * [2]: https://docs.mongodb.com/manual/reference/operator/query/geoWithin/ - * [3]: https://docs.mongodb.com/manual/reference/operator/query/center/#op._S_center - * [4]: https://docs.mongodb.com/manual/reference/operator/query/centerSphere/#op._S_centerSphere + * [1]: https://www.mongodb.com/docs/manual/reference/operator/query/expr/ + * [2]: https://www.mongodb.com/docs/manual/reference/operator/query/geoWithin/ + * [3]: https://www.mongodb.com/docs/manual/reference/operator/query/center/#op._S_center + * [4]: https://www.mongodb.com/docs/manual/reference/operator/query/centerSphere/#op._S_centerSphere * * @param filter - The filter for the count * @param options - Optional settings for the command * - * @see https://docs.mongodb.com/manual/reference/operator/query/expr/ - * @see https://docs.mongodb.com/manual/reference/operator/query/geoWithin/ - * @see https://docs.mongodb.com/manual/reference/operator/query/center/#op._S_center - * @see https://docs.mongodb.com/manual/reference/operator/query/centerSphere/#op._S_centerSphere + * @see https://www.mongodb.com/docs/manual/reference/operator/query/expr/ + * @see https://www.mongodb.com/docs/manual/reference/operator/query/geoWithin/ + * @see https://www.mongodb.com/docs/manual/reference/operator/query/center/#op._S_center + * @see https://www.mongodb.com/docs/manual/reference/operator/query/centerSphere/#op._S_centerSphere */ async countDocuments( filter: Document = {}, @@ -916,7 +916,7 @@ export class Collection { * }); * ``` * - * @param pipeline - An array of {@link https://docs.mongodb.com/manual/reference/operator/aggregation-pipeline/|aggregation pipeline stages} through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents. + * @param pipeline - An array of {@link https://www.mongodb.com/docs/manual/reference/operator/aggregation-pipeline/|aggregation pipeline stages} through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents. * @param options - Optional settings for the command * @typeParam TLocal - Type of the data being detected by the change stream * @typeParam TChange - Type of the whole change stream document emitted diff --git a/src/cursor/abstract_cursor.ts b/src/cursor/abstract_cursor.ts index a115d971f53..c6b10adfc28 100644 --- a/src/cursor/abstract_cursor.ts +++ b/src/cursor/abstract_cursor.ts @@ -557,7 +557,7 @@ export abstract class AbstractCursor< /** * Set the batch size for the cursor. * - * @param value - The number of documents to return per batch. See {@link https://docs.mongodb.com/manual/reference/command/find/|find command documentation}. + * @param value - The number of documents to return per batch. See {@link https://www.mongodb.com/docs/manual/reference/command/find/|find command documentation}. */ batchSize(value: number): this { assertUninitialized(this); diff --git a/src/cursor/find_cursor.ts b/src/cursor/find_cursor.ts index ff4cd6ddf07..1ab66913427 100644 --- a/src/cursor/find_cursor.ts +++ b/src/cursor/find_cursor.ts @@ -386,7 +386,7 @@ export class FindCursor extends AbstractCursor { * Allows disk use for blocking sort operations exceeding 100MB memory. (MongoDB 3.2 or higher) * * @remarks - * {@link https://docs.mongodb.com/manual/reference/command/find/#find-cmd-allowdiskuse | find command allowDiskUse documentation} + * {@link https://www.mongodb.com/docs/manual/reference/command/find/#find-cmd-allowdiskuse | find command allowDiskUse documentation} */ allowDiskUse(allow = true): this { assertUninitialized(this); diff --git a/src/db.ts b/src/db.ts index 4381caa7952..b88c54888a7 100644 --- a/src/db.ts +++ b/src/db.ts @@ -211,7 +211,7 @@ export class Db { /** * 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://docs.mongodb.com/manual/reference/command/create/ + * More information about command options available at https://www.mongodb.com/docs/manual/reference/command/create/ * * @param name - The name of the collection to create * @param options - Optional settings for the command @@ -488,7 +488,7 @@ export class Db { * - 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 * - * @param pipeline - An array of {@link https://docs.mongodb.com/manual/reference/operator/aggregation-pipeline/|aggregation pipeline stages} through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents. + * @param pipeline - An array of {@link https://www.mongodb.com/docs/manual/reference/operator/aggregation-pipeline/|aggregation pipeline stages} through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents. * @param options - Optional settings for the command * @typeParam TSchema - Type of the data being detected by the change stream * @typeParam TChange - Type of the whole change stream document emitted diff --git a/src/mongo_client.ts b/src/mongo_client.ts index 391ab3959cd..7dcd712d299 100644 --- a/src/mongo_client.ts +++ b/src/mongo_client.ts @@ -88,7 +88,7 @@ export type SupportedNodeConnectionOptions = SupportedTLSConnectionOptions & /** * Describes all possible URI query options for the mongo client * @public - * @see https://docs.mongodb.com/manual/reference/connection-string + * @see https://www.mongodb.com/docs/manual/reference/connection-string */ export interface MongoClientOptions extends BSONSerializeOptions, SupportedNodeConnectionOptions { /** Specifies the name of the replica set, if the mongod is a member of a replica set. */ @@ -194,7 +194,7 @@ export interface MongoClientOptions extends BSONSerializeOptions, SupportedNodeC * A MongoDB WriteConcern, which describes the level of acknowledgement * requested from MongoDB for write operations. * - * @see https://docs.mongodb.com/manual/reference/write-concern/ + * @see https://www.mongodb.com/docs/manual/reference/write-concern/ */ writeConcern?: WriteConcern | WriteConcernSettings; /** Validate mongod server certificate against Certificate Authority */ @@ -230,7 +230,7 @@ export interface MongoClientOptions extends BSONSerializeOptions, SupportedNodeC * Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error * (see [libmongocrypt: Auto Encryption Allow-List](https://github.com/mongodb/specifications/blob/master/source/client-side-encryption/client-side-encryption.rst#libmongocrypt-auto-encryption-allow-list)). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts. * - * Automatic encryption requires the authenticated user to have the [listCollections privilege action](https://docs.mongodb.com/manual/reference/command/listCollections/#dbcmd.listCollections). + * Automatic encryption requires the authenticated user to have the [listCollections privilege action](https://www.mongodb.com/docs/manual/reference/command/listCollections/#dbcmd.listCollections). * * If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true: * - AutoEncryptionOptions.keyVaultClient is not passed. @@ -542,7 +542,7 @@ export class MongoClient extends TypedEventEmitter { * @remarks * The programmatically provided options take precedence over the URI options. * - * @see https://docs.mongodb.org/manual/reference/connection-string/ + * @see https://www.mongodb.com/docs/manual/reference/connection-string/ */ static async connect(url: string, options?: MongoClientOptions): Promise { const client = new this(url, options); @@ -616,7 +616,7 @@ export class MongoClient extends TypedEventEmitter { * - The first is to provide the schema that may be defined for all the data within the current cluster * - 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 * - * @param pipeline - An array of {@link https://docs.mongodb.com/manual/reference/operator/aggregation-pipeline/|aggregation pipeline stages} through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents. + * @param pipeline - An array of {@link https://www.mongodb.com/docs/manual/reference/operator/aggregation-pipeline/|aggregation pipeline stages} through which to pass change stream documents. This allows for filtering (using $match) and manipulating the change stream documents. * @param options - Optional settings for the command * @typeParam TSchema - Type of the data being detected by the change stream * @typeParam TChange - Type of the whole change stream document emitted diff --git a/src/mongo_types.ts b/src/mongo_types.ts index ceee3aa69eb..b7a10847f4b 100644 --- a/src/mongo_types.ts +++ b/src/mongo_types.ts @@ -440,7 +440,7 @@ export type PropertyType = string extends Propert /** * @public * returns tuple of strings (keys to be joined on '.') that represent every path into a schema - * https://docs.mongodb.com/manual/tutorial/query-embedded-documents/ + * https://www.mongodb.com/docs/manual/tutorial/query-embedded-documents/ * * @remarks * Through testing we determined that a depth of 8 is safe for the typescript compiler @@ -491,7 +491,7 @@ export type NestedPaths = Depth['length'] extends /** * @public * returns keys (strings) for every path into a schema with a value of type - * https://docs.mongodb.com/manual/tutorial/query-embedded-documents/ + * https://www.mongodb.com/docs/manual/tutorial/query-embedded-documents/ */ export type NestedPathsOfType = KeysOfAType< { diff --git a/src/operations/aggregate.ts b/src/operations/aggregate.ts index ea0b7fa4387..f0ada99bf5e 100644 --- a/src/operations/aggregate.ts +++ b/src/operations/aggregate.ts @@ -14,7 +14,7 @@ const MIN_WIRE_VERSION_$OUT_READ_CONCERN_SUPPORT = 8 as const; export interface AggregateOptions extends CommandOperationOptions { /** allowDiskUse lets the server know if it can use disk to store temporary results for the aggregation (requires mongodb 2.6 \>). */ allowDiskUse?: boolean; - /** The number of documents to return per batch. See [aggregation documentation](https://docs.mongodb.com/manual/reference/command/aggregate). */ + /** The number of documents to return per batch. See [aggregation documentation](https://www.mongodb.com/docs/manual/reference/command/aggregate). */ batchSize?: number; /** Allow driver to bypass schema validation in MongoDB 3.2 or higher. */ bypassDocumentValidation?: boolean; diff --git a/src/operations/create_collection.ts b/src/operations/create_collection.ts index 1d51d9aff60..31c29da7b00 100644 --- a/src/operations/create_collection.ts +++ b/src/operations/create_collection.ts @@ -35,7 +35,7 @@ const ILLEGAL_COMMAND_FIELDS = new Set([ /** @public * Configuration options for timeseries collections - * @see https://docs.mongodb.com/manual/core/timeseries-collections/ + * @see https://www.mongodb.com/docs/manual/core/timeseries-collections/ */ export interface TimeSeriesCollectionOptions extends Document { timeField: string; diff --git a/src/operations/find_and_modify.ts b/src/operations/find_and_modify.ts index d292c423c20..9c567ce9b22 100644 --- a/src/operations/find_and_modify.ts +++ b/src/operations/find_and_modify.ts @@ -21,7 +21,7 @@ export type ReturnDocument = typeof ReturnDocument[keyof typeof ReturnDocument]; /** @public */ export interface FindOneAndDeleteOptions extends CommandOperationOptions { - /** An optional hint for query optimization. See the {@link https://docs.mongodb.com/manual/reference/command/update/#update-command-hint|update command} reference for more information.*/ + /** An optional hint for query optimization. See the {@link https://www.mongodb.com/docs/manual/reference/command/update/#update-command-hint|update command} reference for more information.*/ hint?: Document; /** Limits the fields to return for all matching documents. */ projection?: Document; @@ -35,7 +35,7 @@ export interface FindOneAndDeleteOptions extends CommandOperationOptions { export interface FindOneAndReplaceOptions extends CommandOperationOptions { /** Allow driver to bypass schema validation in MongoDB 3.2 or higher. */ bypassDocumentValidation?: boolean; - /** An optional hint for query optimization. See the {@link https://docs.mongodb.com/manual/reference/command/update/#update-command-hint|update command} reference for more information.*/ + /** An optional hint for query optimization. See the {@link https://www.mongodb.com/docs/manual/reference/command/update/#update-command-hint|update command} reference for more information.*/ hint?: Document; /** Limits the fields to return for all matching documents. */ projection?: Document; @@ -55,7 +55,7 @@ export interface FindOneAndUpdateOptions extends CommandOperationOptions { arrayFilters?: Document[]; /** Allow driver to bypass schema validation in MongoDB 3.2 or higher. */ bypassDocumentValidation?: boolean; - /** An optional hint for query optimization. See the {@link https://docs.mongodb.com/manual/reference/command/update/#update-command-hint|update command} reference for more information.*/ + /** An optional hint for query optimization. See the {@link https://www.mongodb.com/docs/manual/reference/command/update/#update-command-hint|update command} reference for more information.*/ hint?: Document; /** Limits the fields to return for all matching documents. */ projection?: Document; diff --git a/src/operations/stats.ts b/src/operations/stats.ts index b63a70de343..99e680cdbee 100644 --- a/src/operations/stats.ts +++ b/src/operations/stats.ts @@ -78,7 +78,7 @@ export class DbStatsOperation extends CommandOperation { /** * @public - * @see https://docs.mongodb.org/manual/reference/command/collStats/ + * @see https://www.mongodb.com/docs/manual/reference/command/collStats/ */ export interface CollStats extends Document { /** Namespace */ diff --git a/src/read_concern.ts b/src/read_concern.ts index 09e39be5612..76224c66093 100644 --- a/src/read_concern.ts +++ b/src/read_concern.ts @@ -20,7 +20,7 @@ export type ReadConcernLike = ReadConcern | { level: ReadConcernLevel } | ReadCo * of the data read from replica sets and replica set shards. * @public * - * @see https://docs.mongodb.com/manual/reference/read-concern/index.html + * @see https://www.mongodb.com/docs/manual/reference/read-concern/index.html */ export class ReadConcern { level: ReadConcernLevel | string; diff --git a/src/read_preference.ts b/src/read_preference.ts index 1f3d2d0c867..b609f47cbc3 100644 --- a/src/read_preference.ts +++ b/src/read_preference.ts @@ -56,7 +56,7 @@ export interface ReadPreferenceFromOptions extends ReadPreferenceLikeOptions { * used to construct connections. * @public * - * @see https://docs.mongodb.com/manual/core/read-preference/ + * @see https://www.mongodb.com/docs/manual/core/read-preference/ */ export class ReadPreference { mode: ReadPreferenceMode; @@ -229,7 +229,7 @@ export class ReadPreference { /** * Indicates that this readPreference needs the "SecondaryOk" bit when sent over the wire - * @see https://docs.mongodb.com/manual/reference/mongodb-wire-protocol/#op-query + * @see https://www.mongodb.com/docs/manual/reference/mongodb-wire-protocol/#op-query */ secondaryOk(): boolean { const NEEDS_SECONDARYOK = new Set([ diff --git a/src/write_concern.ts b/src/write_concern.ts index ebc77ebf6f7..0d57cacd8d9 100644 --- a/src/write_concern.ts +++ b/src/write_concern.ts @@ -32,7 +32,7 @@ export const WRITE_CONCERN_KEYS = ['w', 'wtimeout', 'j', 'journal', 'fsync']; * requested from MongoDB for write operations. * @public * - * @see https://docs.mongodb.com/manual/reference/write-concern/ + * @see https://www.mongodb.com/docs/manual/reference/write-concern/ */ export class WriteConcern { /** request acknowledgment that the write operation has propagated to a specified number of mongod instances or to mongod instances with specified tags. */ diff --git a/test/integration/client-side-encryption/client_side_encryption.prose.06.corpus.test.js b/test/integration/client-side-encryption/client_side_encryption.prose.06.corpus.test.js index e08e08cf60f..2e854818cd4 100644 --- a/test/integration/client-side-encryption/client_side_encryption.prose.06.corpus.test.js +++ b/test/integration/client-side-encryption/client_side_encryption.prose.06.corpus.test.js @@ -262,7 +262,7 @@ describe('Client Side Encryption Prose Corpus Test', function () { // 5. Load `corpus/corpus.json <../corpus/corpus.json>`_ to a variable named ``corpus``. The corpus contains subdocuments with the following fields: // // - ``kms`` is either ``aws`` or ``local`` - // - ``type`` is a BSON type string `names coming from here `_) + // - ``type`` is a BSON type string `names coming from here `_) // - ``algo`` is either ``rand`` or ``det`` for random or deterministic encryption // - ``method`` is either ``auto``, for automatic encryption or ``explicit`` for explicit encryption // - ``identifier`` is either ``id`` or ``altname`` for the key identifier diff --git a/test/integration/crud/misc_cursors.test.js b/test/integration/crud/misc_cursors.test.js index e224dbd3c75..8ea1c38e008 100644 --- a/test/integration/crud/misc_cursors.test.js +++ b/test/integration/crud/misc_cursors.test.js @@ -1887,7 +1887,7 @@ describe('Cursor', function () { }, test: function (done) { - // http://www.mongodb.org/display/DOCS/Tailable+Cursors + // www.mongodb.com/docs/display/DOCS/Tailable+Cursors const configuration = this.configuration; client.connect((err, client) => { @@ -1926,7 +1926,7 @@ describe('Cursor', function () { }); it('shouldAwaitDataWithDocumentsAvailable', function (done) { - // http://www.mongodb.org/display/DOCS/Tailable+Cursors + // www.mongodb.com/docs/display/DOCS/Tailable+Cursors const configuration = this.configuration; const client = configuration.newClient({ maxPoolSize: 1 }); @@ -2020,7 +2020,7 @@ describe('Cursor', function () { }, test: function (done) { - // http://www.mongodb.org/display/DOCS/Tailable+Cursors + // www.mongodb.com/docs/display/DOCS/Tailable+Cursors const configuration = this.configuration; client.connect((err, client) => { diff --git a/test/readme.md b/test/readme.md index b92f04491db..2772a05ed18 100644 --- a/test/readme.md +++ b/test/readme.md @@ -484,7 +484,7 @@ lerna run test --scope @mongosh/service-provider-server [mocha]: https://mochajs.org/ [mocha-skip]: https://mochajs.org/#inclusive-tests -[mongodb-ulimit]: https://docs.mongodb.com/manual/reference/ulimit/#recommended-ulimit-settings +[mongodb-ulimit]: https://www.mongodb.com/docs/manual/reference/ulimit/#recommended-ulimit-settings [macos-ulimt]: https://wilsonmar.github.io/maximum-limits/ [mocha-only]: https://mochajs.org/#exclusive-tests [mocha-grep]: https://mochajs.org/#command-line-usage diff --git a/test/spec/crud/README.rst b/test/spec/crud/README.rst index b3d2512995f..0bfea3cd153 100644 --- a/test/spec/crud/README.rst +++ b/test/spec/crud/README.rst @@ -257,7 +257,7 @@ Test that ``writeErrors[].errInfo`` in a command response is propagated as ``WriteError.details`` (or equivalent) in the driver. Using a 5.0+ server, create a collection with -`document validation `_ +`document validation `_ like so: .. code:: javascript diff --git a/test/spec/crud/v1/read/aggregate-collation.yml b/test/spec/crud/v1/read/aggregate-collation.yml index 24cafd24bf2..924192a6e56 100644 --- a/test/spec/crud/v1/read/aggregate-collation.yml +++ b/test/spec/crud/v1/read/aggregate-collation.yml @@ -12,7 +12,7 @@ tests: pipeline: - $match: x: 'PING' - collation: { locale: 'en_US', strength: 2 } # https://docs.mongodb.com/manual/reference/collation/#collation-document + collation: { locale: 'en_US', strength: 2 } # https://www.mongodb.com/docs/manual/reference/collation/#collation-document outcome: result: - {_id: 1, x: 'ping'} diff --git a/test/spec/crud/v1/read/count-collation.yml b/test/spec/crud/v1/read/count-collation.yml index 02da74c6b09..fd1c29a07e5 100644 --- a/test/spec/crud/v1/read/count-collation.yml +++ b/test/spec/crud/v1/read/count-collation.yml @@ -10,7 +10,7 @@ tests: name: countDocuments arguments: filter: { x: 'ping' } - collation: { locale: 'en_US', strength: 2 } # https://docs.mongodb.com/manual/reference/collation/#collation-document + collation: { locale: 'en_US', strength: 2 } # https://www.mongodb.com/docs/manual/reference/collation/#collation-document outcome: result: 1 diff --git a/test/spec/crud/v1/read/distinct-collation.yml b/test/spec/crud/v1/read/distinct-collation.yml index 33b57d9927c..8785f29d4b6 100644 --- a/test/spec/crud/v1/read/distinct-collation.yml +++ b/test/spec/crud/v1/read/distinct-collation.yml @@ -11,7 +11,7 @@ tests: name: distinct arguments: fieldName: "string" - collation: { locale: 'en_US', strength: 2 } # https://docs.mongodb.com/manual/reference/collation/#collation-document + collation: { locale: 'en_US', strength: 2 } # https://www.mongodb.com/docs/manual/reference/collation/#collation-document outcome: result: diff --git a/test/spec/crud/v1/read/find-collation.yml b/test/spec/crud/v1/read/find-collation.yml index baac5add496..1ecc491546c 100644 --- a/test/spec/crud/v1/read/find-collation.yml +++ b/test/spec/crud/v1/read/find-collation.yml @@ -10,7 +10,7 @@ tests: name: "find" arguments: filter: {x: 'PING'} - collation: { locale: 'en_US', strength: 2 } # https://docs.mongodb.com/manual/reference/collation/#collation-document + collation: { locale: 'en_US', strength: 2 } # https://www.mongodb.com/docs/manual/reference/collation/#collation-document outcome: result: - {_id: 1, x: 'ping'} diff --git a/test/spec/crud/v1/write/bulkWrite-collation.yml b/test/spec/crud/v1/write/bulkWrite-collation.yml index 5aff22eed18..75ab468a5e7 100644 --- a/test/spec/crud/v1/write/bulkWrite-collation.yml +++ b/test/spec/crud/v1/write/bulkWrite-collation.yml @@ -8,7 +8,7 @@ data: minServerVersion: '3.4' serverless: 'forbid' -# See: https://docs.mongodb.com/manual/reference/collation/#collation-document +# See: https://www.mongodb.com/docs/manual/reference/collation/#collation-document tests: - description: "BulkWrite with delete operations and collation" diff --git a/test/spec/crud/v1/write/deleteMany-collation.yml b/test/spec/crud/v1/write/deleteMany-collation.yml index 2b0ef9db944..65a49b7fdad 100644 --- a/test/spec/crud/v1/write/deleteMany-collation.yml +++ b/test/spec/crud/v1/write/deleteMany-collation.yml @@ -13,7 +13,7 @@ tests: arguments: filter: x: 'PING' - collation: { locale: 'en_US', strength: 2 } # https://docs.mongodb.com/manual/reference/collation/#collation-document + collation: { locale: 'en_US', strength: 2 } # https://www.mongodb.com/docs/manual/reference/collation/#collation-document outcome: result: diff --git a/test/spec/crud/v1/write/deleteOne-collation.yml b/test/spec/crud/v1/write/deleteOne-collation.yml index d37ecf76de1..ce335bf3de6 100644 --- a/test/spec/crud/v1/write/deleteOne-collation.yml +++ b/test/spec/crud/v1/write/deleteOne-collation.yml @@ -12,7 +12,7 @@ tests: name: "deleteOne" arguments: filter: {x: 'PING'} - collation: { locale: 'en_US', strength: 2 } # https://docs.mongodb.com/manual/reference/collation/#collation-document + collation: { locale: 'en_US', strength: 2 } # https://www.mongodb.com/docs/manual/reference/collation/#collation-document outcome: result: diff --git a/test/spec/crud/v1/write/findOneAndDelete-collation.yml b/test/spec/crud/v1/write/findOneAndDelete-collation.yml index 5f13b7e5b73..720ecb2f81b 100644 --- a/test/spec/crud/v1/write/findOneAndDelete-collation.yml +++ b/test/spec/crud/v1/write/findOneAndDelete-collation.yml @@ -14,7 +14,7 @@ tests: filter: {_id: 2, x: 'PING'} projection: {x: 1, _id: 0} sort: {x: 1} - collation: { locale: 'en_US', strength: 2 } # https://docs.mongodb.com/manual/reference/collation/#collation-document + collation: { locale: 'en_US', strength: 2 } # https://www.mongodb.com/docs/manual/reference/collation/#collation-document outcome: result: {x: 'ping'} diff --git a/test/spec/crud/v1/write/findOneAndReplace-collation.yml b/test/spec/crud/v1/write/findOneAndReplace-collation.yml index 206ac829c83..f132b1211da 100644 --- a/test/spec/crud/v1/write/findOneAndReplace-collation.yml +++ b/test/spec/crud/v1/write/findOneAndReplace-collation.yml @@ -15,7 +15,7 @@ tests: projection: {x: 1, _id: 0} returnDocument: After sort: {x: 1} - collation: { locale: 'en_US', strength: 2 } # https://docs.mongodb.com/manual/reference/collation/#collation-document + collation: { locale: 'en_US', strength: 2 } # https://www.mongodb.com/docs/manual/reference/collation/#collation-document outcome: result: {x: 'pong'} diff --git a/test/spec/crud/v1/write/findOneAndUpdate-collation.yml b/test/spec/crud/v1/write/findOneAndUpdate-collation.yml index 1c50e86be81..5a110b01bfb 100644 --- a/test/spec/crud/v1/write/findOneAndUpdate-collation.yml +++ b/test/spec/crud/v1/write/findOneAndUpdate-collation.yml @@ -17,7 +17,7 @@ tests: $set: {x: 'pong'} projection: {x: 1, _id: 0} sort: {_id: 1} - collation: { locale: 'en_US', strength: 2 } # https://docs.mongodb.com/manual/reference/collation/#collation-document + collation: { locale: 'en_US', strength: 2 } # https://www.mongodb.com/docs/manual/reference/collation/#collation-document outcome: result: {x: 'ping'} diff --git a/test/spec/crud/v1/write/replaceOne-collation.yml b/test/spec/crud/v1/write/replaceOne-collation.yml index 715cdce8441..cad343caa16 100644 --- a/test/spec/crud/v1/write/replaceOne-collation.yml +++ b/test/spec/crud/v1/write/replaceOne-collation.yml @@ -12,7 +12,7 @@ tests: arguments: filter: {x: 'PING'} replacement: {_id: 2, x: 'pong'} - collation: {locale: 'en_US', strength: 2} # https://docs.mongodb.com/manual/reference/collation/#collation-document + collation: {locale: 'en_US', strength: 2} # https://www.mongodb.com/docs/manual/reference/collation/#collation-document outcome: result: diff --git a/test/spec/crud/v1/write/updateMany-collation.yml b/test/spec/crud/v1/write/updateMany-collation.yml index 5a7048f09a9..b3737896497 100644 --- a/test/spec/crud/v1/write/updateMany-collation.yml +++ b/test/spec/crud/v1/write/updateMany-collation.yml @@ -15,7 +15,7 @@ tests: x: 'ping' update: $set: {x: 'pong'} - collation: { locale: 'en_US', strength: 2 } # https://docs.mongodb.com/manual/reference/collation/#collation-document + collation: { locale: 'en_US', strength: 2 } # https://www.mongodb.com/docs/manual/reference/collation/#collation-document outcome: result: diff --git a/test/spec/crud/v1/write/updateOne-collation.yml b/test/spec/crud/v1/write/updateOne-collation.yml index 0132152b09e..c20087176ed 100644 --- a/test/spec/crud/v1/write/updateOne-collation.yml +++ b/test/spec/crud/v1/write/updateOne-collation.yml @@ -13,7 +13,7 @@ tests: filter: {x: 'PING'} update: $set: {x: 'pong'} - collation: { locale: 'en_US', strength: 2} # https://docs.mongodb.com/manual/reference/collation/#collation-document + collation: { locale: 'en_US', strength: 2} # https://www.mongodb.com/docs/manual/reference/collation/#collation-document outcome: result: diff --git a/test/tools/mongodb-mock/src/utils.js b/test/tools/mongodb-mock/src/utils.js index 39092d4e05a..c285be25174 100644 --- a/test/tools/mongodb-mock/src/utils.js +++ b/test/tools/mongodb-mock/src/utils.js @@ -1,6 +1,6 @@ /* * MongoDB OPCODES - * reference: https://docs.mongodb.com/manual/reference/mongodb-wire-protocol/#request-opcodes + * reference: https://www.mongodb.com/docs/manual/reference/mongodb-wire-protocol/#request-opcodes */ const opcodes = { OP_REPLY: 1,