What's New

What's New in 6.5

The Node.js driver v6.5 release includes the following features:

• Updates bulk write operations to use the pkFactory class for document ID generation.

• Fixes the read preference that is sent with read operations to primaryPreferred when the driver is connected to a secondary node in the replica set.

• Fixes a memory leak in promise creation for socket operations.

• Reduces first-time connection latency when connecting to a DNS seedlist by querying the SRV and TXT records in parallel.

• Adds tracking to container metadata when running a client in Kubernetes or a container environment in the client.env.container field of the handshake document.

• Adds the original error document returned by the server to the errorResponse field of the MongoServerError document.

• Deprecates the CloseOptions interface which is unused by the driver.

To learn more about this release, see the v6.5.0 Release Highlights on GitHub.

What's New in 6.4

The Node.js driver v6.4 release includes the following features:

• When multiple mongos instances are available, different servers are used for read and write retry attempts.

• Caches AWS credentials at the client level, rather than for each authentication.

• Upgrades to using BSON 6.4.0. For details about the new BSON features, see the release notes for BSON 6.3.0 and BSON 6.4.0.

• Read operations that result in an ExceededTimeLimit error are retried.

• Fixes a request issue related to TLS sockets and KMS Providers.

• Fixes the base64 padding on the saslContinue command to allow for mongosh authentication.

• Types countDocuments using Filter<Schema> rather than Document, which enables autocompletion and helps prevent downstream typing issues.

• Fixes a type error in the $addToSet option of the bulkWrite command. The driver skips $addToSet validation you extend your types from Document or any, or use properties of any type.

• Fixes the ServerHeartbeatSucceeded and ServerHeartbeatFailed event heartbeat duration so that it does not include the time to create the socket.

• Appropriately emits errors from cursor transform streams, rather than absorbing them.

• Makes AWS session tokens optional when a username and password are provided, and allows AWS SDK to handle the authentication requests.

To learn more about this release, see the v6.4.0 Release Highlights on GitHub.

What's New in 6.3

The Node.js driver v6.3 release includes the following features:

• Adds the serverMonitoringMode client option to control the behavior of the monitoring connection among the nodes in a topology. This option takes a value of auto (default), poll, or stream. To learn more, see the entry for this option in the Connection Options guide.

  You can set the serverMonitoringMode option in a MongoClientOptions instance or as a connection string option. The following example shows how to create a client with the option set to stream:

  new MongoClient('<connection string>', { serverMonitoringMode: 'stream' });

• Fixes a connection leak when the serverApi client option is set.

• Deprecates the contentType and aliases GridFS options. To store the content type and aliases of a file, add contentType and aliases fields to the metadata document.

To learn more about this release, see the v6.3.0 Release Highlights.

What's New in 6.2

The Node.js driver v6.2 release includes the following features:

• Updates the bson package version to 6.2.0 to include color visualization of types, as shown in the following image:

  

  To learn more, see the bson v6.2.0 release notes.

• Ensures that the result.insertedIds property of a bulk write error type contains the _id values of successfully inserted documents. In previous versions, when a bulk write operation rejected an insert operation, the result.insertedIds property contained the _id values for all attempted inserts.

• Closes the implicit session created when running the findOne() method on a time series collection regardless of the outcome of the operation.

• Allows the creation of collections that have names that start or end with the . character. This change aligns the driver's database and collection name-checking behavior with the server's.

To learn more about this release, see the v6.2.0 Release Highlights.

What's New in 6.1

The Node.js driver v6.1 release includes the following features:

• Updates the bson package version to 6.1.0 to expose the Decimal128.fromStringWithRounding() method. To learn more, see the v6.1.0 bson release notes.

• Detects environment variables for region settings when authenticating by using the MONGODB-AWS authentication mechanism. To instruct the driver to use your region options, you must set both of the following environment variables:

  • AWS_STS_REGIONAL_ENDPOINTS

  • AWS_REGION

• Fixes a memory leak issue caused by recursive calls to the next() method of the ChangeStream type.

To learn more about this release, see the v6.1.0 Release Highlights.

What's New in 6.0

The Node.js driver v6.0 release includes the following features:

• Removal of support for the addUser() helper command. Use the createUser MongoDB Shell command instead.

• Removal of support for the collStats operation. Use the $collStats aggregation operator instead.

• The options field of the ConnectionPoolCreatedEvent type contains only the following fields, which are the non-default pool options:

  • maxConnecting

  • maxPoolSize

  • minPoolSize

  • maxIdleTimeMS

  • waitQueueTimeoutMS

• The driver asynchronously reads files set in the tlsCAFile and tlsCertificateKeyFile connection options when you call the MongoClient.connect() method, not when you create a MongoClient instance.

• Removal of the keepAlive and keepAliveInitialDelay connection options. The value of keepAlive is permanently set to true and the value of keepAliveInitialDelay is set to 300000 milliseconds (300 seconds).

  To learn how to set keepalive settings at a system level, see the Does TCP keepalive time affect MongoDB Deployments? FAQ entry in the Server manual.

• Removes the following options for the Db.command() method:

  • willRetryWrite

  • omitReadPreference

  • writeConcern

  • explain

  • readConcern

  • collation

  • maxTimeMS

  • comment

  • retryWrites

  • dbName

  • authdb

  • noResponse

  Although you cannot pass these options to the Db.command() method, you can still set them in the command document. To learn more, see the Command Options section of the Run a Command guide.

To learn more about this release, see the v6.0.0 Release Highlights.

What's New in 5.9

The Node.js driver v5.9 release includes the following features:

• Fixed a memory leak introduced in v5.7.

• The Decimal128 constructor and fromString() methods now throw an exception when they detect a loss of precision of more than 34 significant digits. The Decimal128 class exposes a new fromStringWithRounding() static method that uses the rounding behavior from previous versions of the driver. For more information, see the Release Notes for v5.5 of the js-bson package on GitHub.

• Added support for detecting the AWS_STS_REGIONAL_ENDPOINTS and AWS_REGION environment variables and setting the appropriate options when calling the fromNodeProviderChain() method in the AWS SDK.

To learn more about this release, see the v5.9.0 Release Highlights.

What's New in 5.8

The Node.js driver v5.8 release includes the following features:

• Support for Kerberos versions 1.x and 2.x.

• Deprecation errors are not emitted for the tlsCertificateFile property when you set the tlsCertificateKeyFile property.

• Removes credential availability in the ConnectionPoolCreatedEvent type. You can still access credentials through the credentials property of a MongoOptions instance.

• Lowers the @aws-sdk/credential-providers version to 3.188.0 and zstd to ^1.0.0.

To learn more about this release, see the v5.8.0 Release Highlights.

What's New in 5.7

The Node.js driver v5.7 release includes the following features:

• A new option for compound operation methods. The includeResultMetaData option allows you to specify whether to include information about the operation result. See the Built-in Methods section of the Compound Operations guide for more information.

• Support for change stream split events which enables processing change stream documents that exceed the 16MB maximum BSON size limit.

• An API to manage Search indexes from within your application. To learn more, see Search Indexes.

To learn more about this release, see the v5.7.0 Release Highlights.

What's New in 5.6

The Node.js driver v5.6 release includes the following features:

• The driver now supports Node.js v20.

• The driver can return a cursor as the response to a server command when you call the runCursorCommand() method. To learn more about this feature, see the runCursorCommand API documentation.

• Support for specifying time series collection creation options bucketMaxSpanSeconds and bucketRoundingSeconds. To learn more about these time series collection options, see Set Granularity for Time Series Data in the Server manual.

To learn more about this release, see the v5.6.0 Release Highlights.

What's New in 5.5

New features of the 5.5 Node.js driver release include:

• The driver now accurately detects Function-as-a-Service (FaaS) environments in AWS by considering AWS environment variables only if they begin with AWS_Lambda_.

• You must upgrade mongodb-client-encryption to version 2.8.0 or later if you want to create an encrypted collection by using the Queryable Encryption feature.

To learn more about this release, see the v5.5.0 Release Highlights.

What's New in 5.4

New features of the 5.4 Node.js driver release include:

• The ChangeStream.tryNext method now uses the schema-specific TChange generic type instead of the Document interface.

To learn more, see the v5.4.0 Release Highlights.

What's New in 5.3

New features of the 5.3 Node.js driver release include:

• Client metadata now includes function as a service (FaaS) environment information and alternative runtime detection.

• The driver now allows SRV record addresses that contain a trailing dot.

• UpdateResult.upsertedId now returns null when no documents are updated.

To learn more, see the v5.3.0 Release Highlights.

What's New in 5.2

New features of the 5.2 Node.js driver release include:

• The driver now supports automatically obtaining Azure credentials when using automatic Queryable Encryption.

To learn more, see the v5.2.0 Release Highlights.

What's New in 5.1

New features of the 5.1 Node.js driver release include:

• The driver now supports automatic serialization of JavaScript bigint to BSON.Long. It also supports the deserialization of BSON.Long values returned from the server to bigint values when the useBigInt64 flag is passed as true.

To learn more, see the v5.1.0 Release Highlights.

What's New in 5.0

New features of the 5.0 Node.js driver release include:

• By default, the driver no longer checks types referenced in dot notation unless the StrictFilter type annotation is explicitly used. To learn more about this change, see the Typescript fundamentals page.

  Note

  This change is for Typescript only, and does not affect queries or operations at runtime.

• Optional installation of @aws-sdk/credential-providers as a peer dependency.

  • The driver no longer includes AWS SDK modules by default. Use the following npm command to install the SDK:

    npm install --save "@aws-sdk/credential-providers@^3.201.0"

    If you install the SDK, npm notifies you if the version of the SDK you installed is incompatible with the driver. Once you install the dependency successfully, the driver uses the AWS SDK itself to manage credentials from the environment.

What's New in 4.17

New features of the 4.17 Node.js driver release include:

• Adds the mongodb-js/saslprep package as a driver dependency.

• Improves compatibility with the Queryable Encryption feature.

To learn more, see the v4.17.0 Release Highlights.

What's New in 4.16

New features of the 4.16 Node.js driver release include:

• Includes Function-as-a-Service (FaaS) platform information in the driver handshake metadata.

• Identifies Deno runtime usage in the client metadata.

To learn more, see the v4.16.0 Release Highlights.

What's New in 4.15

New features of the 4.15 Node.js driver release include:

• Support for AWS IAM roles for service accounts.

To learn more, see the v4.15.0 Release Highlights.

What's New in 4.14

New features of the 4.14 Node.js driver release include:

• Fixed a memory leak introduced in v4.13.

• Deprecated methods and options that reference the legacy Logger.

What's New in 4.13

New features of the 4.13 Node.js driver release include:

• Automatic cancellation of in-flight operations in the connection pool when the driver encounters network timeout errors.

• Disabled causal consistency in implicit sessions to prevent conflicting with the linearizable and available read concern settings.

• Fixed a potential memory leak by ensuring that the driver destroys MessageStream instances whenever their connections are destroyed.

What's New in 4.12

New features of the 4.12 Node.js driver release include:

• Redefinition of the ChangeStream class as an async iterable. You can use ChangeStream instances in any context that expects an AsyncIterator.

  • Notably, change streams can now be used in Javascript for-await loops:

    const changeStream = myColl.watch();
    for await (const change of changeStream) {
      console.log("Received change: ", change);
    }

• Fix to server monitoring when the driver skips monitoring events. In this release, the driver always updates its view of the topology when processing monitoring events.

• Performance improvements with buffering as a result of modification to data structures used internally in the driver.

To learn more, see the v4.12.0 Release Highlights.

What's New in 4.11

interface Author {
    name: string;
    bestBook: Book;
}
interface Book {
    title: string;
    author: Author;
 }

myColl.findOne({ 'bestBook.author.bestBook.title': 25 });

myColl.findOne({
    'bestBook.author.bestBook.author.bestBook.author.bestBook.author.bestBook.author.name': 25
});

What's New in 4.10

New features of the 4.10 Node.js driver release include:

• Callback Deprecation

  • Callbacks are now deprecated in favor of Promises. Callbacks will be removed in the next major release. The Node driver team recommends migrating to promises where possible:

    • Use async/await syntax.

    • Use the Node.js callbackify utility:

      require('util').callbackify(() => myColl.findOne())(callback)

    • Use then syntax:

      myColl.findOne().then(res => callback(null, res), err => callback(err))

  • If you are unable to migrate to Promises in a large codebase, you can use the legacy Node.js driver with optional callback support.

To learn more, see v4.10.0 Release Highlights.

What's New in 4.9

New features of the 4.9 Node.js driver release include:

• Fixed an inconsistency with writeConcern options in the type definitions.

• Included the latest BSON release, which adds automatic UUID support. See the BSON release notes here.

To learn more, see v4.9.0 Release Highlights.

What's New in 4.8

New features of the 4.8 Node.js driver release include:

• Added auto-completion and type safety for nested keys in an update filter

• client.startSession() can now be called before connecting to MongoDB

• estimatedDocumentCount() method can now accept a comment

To learn more, see v4.8.0 Release Highlights.

What's New in 4.7

New features of the 4.7 Node.js driver release include:

• The MongoClient.connect() method is now optional when connecting to your MongoDB instance

• Ability to compress messages with the Zstandard compression algorithm

• Added support for the maxConnecting connection option

• Ability for change stream documents to show your documents before and after an update

• Added support for new change stream fields related to Cluster to Cluster Replication

• The estimatedDocumentCount() method now uses the $count database command

• Improved connecting to MongoDB in the AWS Lambda Init phase

What's New in 4.6

New features of the 4.6 Node.js driver release include:

• Improved the ChangeStreamDocument in TypeScript.

• Even distribution of server selection based on load across servers.

To learn more, see v4.6.0 Release Highlights.

What's New in 4.5

See v4.5.0 Release Highlights on GitHub.

What's New in 4.4

New features of the 4.4 Node.js driver release include:

• KMIP provider support when using CSFLE.

• TLS support when using CSFLE.

• Hostname canonicalization now accepts "none", "forward", and "forwardAndReverse" as authMechanismProperties when using GSSAPI.

• In the 4.0.0 release of the driver, the deprecated collection.count() method was inadvertently changed to behave like collection.countDocuments(). In this release, the collection.count() method is updated to match legacy behavior:

  • If a query is provided, collection.count() behaves the same as collection.countDocuments() and performs a collection scan.

  • If no query is provided, collection.count() behaves the same as collection.estimatedDocumentCount() and relies on collection metadata.

  Important

  Deprecation Notice

  The cursor.count() method is deprecated and will be removed in the next major version, along with collection.count(). Use the collection.estimatedDocumentCount() or collection.countDocuments() methods instead.

What's New in 4.3

New features of the 4.3 Node.js driver release include:

• SOCKS5 support

• Option to disable UTF-8 validation

• Type inference for nested documents

What's New in 4.2

New features of the 4.2 Node.js driver release include:

• srvMaxHosts and srvServiceName DNS seedlist connection options

What's New in 4.1

New features of the 4.1 Node.js driver release include:

• Added load balanced connection support for all cluster types including the beta Serverless platform.

• Added support for the advanceClusterTime() method to determine if the ClientSession should update its cluster time.

What's New in 4.0

New features of the 4.0 Node.js driver release include:

const fc = myColl.find({a: 2.3}).skip(1)
for await (const doc of fc) {
  console.log(doc)
  fc.limit(1) // incorrect usage, cursor already executing
}

const cursor = myColl.find({});
const stream = cursor.stream();
stream.on("data", data => console.log);
stream.on("error", () => client.close());

const collections = (await db.listCollections({}, { nameOnly: true })
  .toArray()).map(
    ({name}) => name
  );
if (!collections.includes(myNewCollectionName)) {
  throw new Error(`${myNewCollectionName} doesn't exist`);
}

// old way
const gs = new GridStore(db, filename, mode[, options])
// new way
const bucket = new GridFSBucket(client.db('test')[,options])

bucket.openDownloadStreamByName(filename, { start: 0, end: 100 })

await client.connect();
const filename = 'test.txt'; // whatever local file name you want
const db = client.db();
const bucket = new GridFSBucket(db);
fs.createReadStream(filename)
  .pipe(bucket.openUploadStream(filename))
  .on('error', console.error)
  .on('finish', () => {
    console.log('done writing to db!');
    bucket
      .find()
      .toArray()
      .then(files => {
        console.log(files);
        bucket
          .openDownloadStreamByName(filename)
          .pipe(fs.createWriteStream('downloaded_' + filename))
          .on('error', console.error)
          .on('finish', () => {
            console.log('done downloading!');
            client.close();
          });
      });
  });

// old way
GridStore.unlink(db, name, callback);
// new way
bucket.delete(file_id);

const fileMetaDataList: GridFSFile[] = bucket.find({}).toArray();

What's New in 3.7

New features of the 3.7 Node.js driver release include:

• Added support for load balancer mode while enabling the useUnifiedTopology option

• Added support for Stable API while enabling the useUnifiedTopology option

What's New in 3.6

New features of the 3.6 Node.js driver release include:

• Added support for the MONGODB-AWS authentication mechanism using Amazon Web Services (AWS) Identity and Access Management (IAM) credentials

• The find() method supports allowDiskUse() for sorts that require too much memory to execute in RAM

• The update() and replaceOne() methods support index hints

• A reduction in recovery time for topology changes and failover events

• Improvements in validation testing for the default writeConcern

• Authentication requires fewer round trips to the server, resulting in faster connection setup

• Shorter Salted Challenge Response Authentication Mechanism (SCRAM) conversations

• Ability to create collections and indexes for multiple document transactions

• Running validation for a collection in the background