BPA User Guide MongoDB Upgrade v5.1

• Introduction
• Updating Versions
• Depreciating Variables
• Removing Callback
• Updating the Delete Query
• Updating Query Changes
• Updating the db.addUser() Function
• Updating Methods
• Updating GridFS

Introduction

BPA v4.1.2 includes an upgrade to MongoDB v7, as MongoDB v5 is approaching end of life. This document provides details for upgrading the MongoDB version in microservices.

Updating Versions

Update the following package versions in microservices:

• “mongodb”: “^3.1.13” to “mongodb”: “^6.8.0”
• “mongoose”: “5.8.7” to “mongoose”: “^8.5.1”

Depreciating Variables

The following variables are deprecated in MongoDB v7:

• ssl
• useNewUrlParser
• useUnifiedTopology
• useFindAndModify
• useCreateIndex
• sslValidate

Replace ssl with tls as shown in the following example:

if (process.env.MONGO_SSL == "true") { 
  //options.ssl = true; 
  options.tls = true;
  options.tlsAllowInvalidCertificates = true;
}

Removing Callback

Callback in MongoDB queries has been deprecated in MongoDB v7. The updated query displays in green below.

Updating the Delete Query

After performing the delete query, the response variable should use deletedCount in place of n (e.g., replace result.n with result.deletedCount).

Updating Query Changes

After performing the update operation, the response variable should use modifiedCount in place of n/nModified (e.g., Replace devices.n / devices.nModified to devices.modifiedCount in as shown below).

Updating the db.addUser() Function

Replace the db.addUser() function with db.command(createUse: “username”) as shown in the following example.

Updating Methods

Update the following methods deprecated in MongoDB v7 as indicated below.

Updating GridFS

In MongoDB v7, the GridFSBucket class is used to interact with GridFS, a specification for storing and retrieving large files. The GridFSBucket class provides methods to upload, download, and manage files in GridFS. 

Replace gridfs-stream by importing GridFSBucket from MongoDB. Refer to the following images to view the changes.