On this page本页内容
config
DatabaseBefore you attempt any upgrade, please familiarize yourself with the content of this document.
If you need guidance on upgrading to 4.2, MongoDB offers major version upgrade services to help ensure a smooth transition without interruption to your MongoDB application.
When upgrading, consider the following:
To upgrade an existing MongoDB deployment to 4.2, you must be running a 4.0-series release.
To upgrade from a version earlier than the 4.0-series, you must successively upgrade major releases until you have upgraded to 4.0-series. For example, if you are running a 3.6-series, you must upgrade first to 4.0 before you can upgrade to 4.2.
Before you upgrade MongoDB, check that you're using a MongoDB 4.2-compatible driver. Consult the driver documentation for your specific driver to verify compatibility with MongoDB 4.2.
Upgraded deployments that run on incompatible drivers might encounter unexpected or undefined behavior.
Before beginning your upgrade, see the Compatibility Changes in MongoDB 4.2 document to ensure that your applications and deployments are compatible with MongoDB 4.2. Resolve the incompatibilities in your deployment before starting the upgrade.
Before upgrading MongoDB, always test your application in a staging environment before deploying the upgrade to your production environment.
Once upgraded to 4.2, if you need to downgrade, we recommend downgrading to the latest patch release of 4.0.
Starting in MongoDB 3.6, MongoDB enables support for "majority"
read concern by default.
You can disable read concern "majority"
to prevent the storage cache pressure from immobilizing a three-member replica set with a primary-secondary-arbiter (PSA) architecture or a sharded cluster with a three-member PSA shards.
Disabling "majority"
read concern affects support for transactions on sharded clusters. Specifically:
"snapshot"
if the transaction involves a shard that has disabled read concern "majority"."majority"
.However, it does not affect transactions on replica sets. For transactions on replica sets, you can specify read concern "majority"
(or "snapshot"
or "local"
) for multi-document transactions even if read concern "majority"
is disabled.
Disabling "majority"
read concern prevents collMod
commands which modify an index from rolling back. If such an operation needs to be rolled back, you must resync the affected nodes with the primary node.
Disabling "majority"
read concern disables support for Change Streams for MongoDB 4.0 and earlier. For MongoDB 4.2+, disabling read concern "majority"
has no effect on change streams availability.
When upgraded to 4.2 with read concern "majority" disabled, you can use change streams for your deployment.
MongoDB 4.2 uses the version 1 (i.e. v1
) change streams resume tokens, introduced in version 4.0.7.
The resume token _data
type depends on the MongoDB versions and, in some cases, the feature compatibility version (fcv) at the time of the change stream's opening/resumption (i.e. a change in fcv value does not affect the resume tokens for already opened change streams):
MongoDB Version | Feature Compatibility Version | Resume Token _data Type |
---|---|---|
MongoDB 4.2 and later | "4.2" or "4.0" | Hex-encoded string (v1 ) |
MongoDB 4.0.7 and later | "4.0" or "3.6" | Hex-encoded string (v1 ) |
MongoDB 4.0.6 and earlier | "4.0" | Hex-encoded string (v0 ) |
MongoDB 4.0.6 and earlier | "3.6" | BinData |
MongoDB 3.6 | "3.6" | BinData |
During the upgrade process, the members of the sharded clusters will continue to produce v0
tokens until the first mongos
instance is upgraded. The upgrade mongos
instances will begin producing v1
change stream resume tokens. These cannot be used to resume a stream on a mongos
which has not yet been upgraded.
To upgrade a sharded cluster to 4.2, all members of the cluster must be at least version 4.0. The upgrade process checks all components of the cluster and will produce warnings if any component is running version earlier than 4.0.
MongoDB 4.2 removes support for the deprecated MMAPv1 storage engine.
If your 4.0 deployment uses MMAPv1, you must change the 4.0 deployment to WiredTiger Storage Engine before upgrading to MongoDB 4.2. For details, see Change Sharded Cluster to WiredTiger.
With MongoDB 4.2, the mongod
and mongos
processes will not start with MMAPv1 Specific Configuration Options. Previous versions of MongoDB running WiredTiger ignored MMAPv1 configurations options if they were specified. With MongoDB 4.2, you must remove these from your configuration.
The 4.0 sharded cluster must have featureCompatibilityVersion
set to 4.0
.
To ensure that all members of the sharded cluster have featureCompatibilityVersion
set to 4.0
, connect to each shard replica set member and each config server replica set member and check the featureCompatibilityVersion
:
For a sharded cluster that has access control enabled, to run the following command against a shard replica set member, you must connect to the member as a shard local user.
db.adminCommand( { getParameter: 1, featureCompatibilityVersion: 1 } )
All members should return a result that includes "featureCompatibilityVersion" : { "version" : "4.0" }
.
To set or update featureCompatibilityVersion
, run the following command on the mongos
:
db.adminCommand( { setFeatureCompatibilityVersion: "4.0" } )
For more information, see setFeatureCompatibilityVersion
.
For shards and config servers, ensure that no replica set member is in ROLLBACK
or RECOVERING
state.
config
DatabaseOptional but Recommended. As a precaution, take a backup of the config
database before upgrading the sharded cluster.
For PowerPC Only
For hashed indexes, MongoDB 4.2 ensures that the hashed value for the floating point value 2 63 on PowerPC is consistent with other platforms.
Although hashed indexes on a field that may contain floating point values greater than 2 63 is an unsupported configuration, clients may still insert documents where the indexed field has the value 2 63.
If the current MongoDB 4.0 sharded cluster on PowerPC has hashed shard key values for 2 63, then, before upgrading:
mongoexport
with the --query
to select the documents with 2 63 in the shard key field.After you upgrade following the procedure below, you will import the deleted documents.
To list all hashed indexes for your deployment and find documents whose indexed field contains the value 2 63 Hashed Indexes and PowerPC check.
If you installed MongoDB from the MongoDB apt
, yum
, dnf
, or zypper
repositories, you should upgrade to 4.2 using your package manager.
Follow the appropriate 4.2 installation instructions for your Linux system. This will involve adding a repository for the new release, then performing the actual upgrade process.
If you have not installed MongoDB using a package manager, you can manually download the MongoDB binaries from the MongoDB Download Center.
See 4.2 installation instructions for more information.
Connect a mongo
shell to a mongos
instance in the sharded cluster, and run sh.stopBalancer()
to disable the balancer:
sh.stopBalancer()
If a migration is in progress, the system will complete the in-progress migration before stopping the balancer. You can run sh.isBalancerRunning()
to check the balancer's current state.
To verify that the balancer is disabled, run sh.getBalancerState()
, which returns false if the balancer is disabled:
sh.getBalancerState()
For more information on disabling the balancer, see Disable the Balancer.
Upgrade the secondary members of the replica set one at a time:
mongod
instance and replace the 4.0 binary with the 4.2 binary.Start the 4.2 binary with the --configsvr
, --replSet
, and --port
. Include any other options as used by the deployment.
mongod --configsvr --replSet <replSetName> --port <port> --dbpath <path> --bind_ip localhost,<ip address>
If using a configuration file, update the file to specify sharding.clusterRole: configsvr
, replication.replSetName
, net.port
, and net.bindIp
, then start the 4.2 binary:
sharding: clusterRole: configsvr replication: replSetName: <string> net: port: <port> bindIp: localhost,<ip address> storage: dbpath: <path>
Include any other settings as appropriate for your deployment.
Wait for the member to recover to SECONDARY
state before upgrading the next secondary member. To check the member's state, issue rs.status()
in the mongo
shell.
Repeat for each secondary member.
Step down the replica set primary.
Connect a mongo
shell to the primary and use rs.stepDown()
to step down the primary and force an election of a new primary:
rs.stepDown()
rs.status()
shows that the primary has stepped down and another member has assumed PRIMARY
state, shut down the stepped-down primary and replace the mongod
binary with the 4.2 binary.Start the 4.2 binary with the --configsvr
, --replSet
, --port
, and --bind_ip
options. Include any optional command line options used by the previous deployment:
mongod --configsvr --replSet <replSetName> --port <port> --dbpath <path> --bind_ip localhost,<ip address>
If using a configuration file, update the file to specify sharding.clusterRole: configsvr
, replication.replSetName
, net.port
, and net.bindIp
, then start the 4.2 binary:
sharding: clusterRole: configsvr replication: replSetName: <string> net: port: <port> bindIp: localhost,<ip address> storage: dbpath: <path>
Include any other configuration as appropriate for your deployment.
Upgrade the shards one at a time.
For each shard replica set:
Upgrade the secondary members of the replica set one at a time:
mongod
instance and replace the 4.0
binary with the 4.2 binary.Start the 4.2 binary with the --shardsvr
, --replSet
, --port
, and --bind_ip
options. Include any additional command line options as appropriate for your deployment:
mongod --shardsvr --replSet <replSetName> --port <port> --dbpath <path> --bind_ip localhost,<ip address>
If using a configuration file, update the file to include sharding.clusterRole: shardsvr
, replication.replSetName
, net.port
, and net.bindIp
, then start the 4.2 binary:
sharding: clusterRole: shardsvr replication: replSetName: <string> net: port: <port> bindIp: localhost,<ip address> storage: dbpath: <path>
Include any other configuration as appropriate for your deployment.
Wait for the member to recover to SECONDARY
state before upgrading the next secondary member. To check the member's state, you can issue rs.status()
in the mongo
shell.
Repeat for each secondary member.
Step down the replica set primary.
Connect a mongo
shell to the primary and use rs.stepDown()
to step down the primary and force an election of a new primary:
rs.stepDown()
When rs.status()
shows that the primary has stepped down and another member has assumed PRIMARY
state, upgrade the stepped-down primary:
mongod
binary with the 4.2 binary.Start the 4.2 binary with the --shardsvr
, --replSet
, --port
, and --bind_ip
options. Include any additional command line options as appropriate for your deployment:
mongod --shardsvr --replSet <replSetName> --port <port> --dbpath <path> --bind_ip localhost,<ip address>
If using a configuration file, update the file to specify sharding.clusterRole: shardsvr
, replication.replSetName
, net.port
, and net.bindIp
, then start the 4.2 binary:
sharding: clusterRole: shardsvr replication: replSetName: <string> net: port: <port> bindIp: localhost,<ip address> storage: dbpath: <path>
Include any other configuration as appropriate for your deployment.
mongos
instances.Replace each mongos
instance with the 4.2 binary and restart. Include any other configuration as appropriate for your deployment.
The --bind_ip
option must be specified when the sharded cluster members are run on different hosts or if remote clients connect to the sharded cluster. For more information, see Localhost Binding Compatibility Changes.
mongos --configdb csReplSet/<rsconfigsver1:port1>,<rsconfigsver2:port2>,<rsconfigsver3:port3> --bind_ip localhost,<ip address>
Using a 4.2 mongo
shell, connect to a mongos
in the cluster and run sh.startBalancer()
to re-enable the balancer:
sh.startBalancer()
Starting in MongoDB 4.2, sh.startBalancer()
also enables auto-splitting for the sharded cluster.
If you do not wish to enable auto-splitting while the balancer is enabled, you must also run sh.disableAutoSplit()
.
For more information about re-enabling the balancer, see Enable the Balancer.
At this point, you can run the 4.2 binaries without the 4.2 features that are incompatible with 4.0.
To enable these 4.2 features, set the feature compatibility version (FCV
) to 4.2.
Enabling these backwards-incompatible features can complicate the downgrade process since you must remove any persisted backwards-incompatible features before you downgrade.
It is recommended that after upgrading, you allow your deployment to run without enabling these features for a burn-in period to ensure the likelihood of downgrade is minimal. When you are confident that the likelihood of downgrade is minimal, enable these features.
On a mongos
instance, run the setFeatureCompatibilityVersion
command in the admin
database:
db.adminCommand( { setFeatureCompatibilityVersion: "4.2" } )
This command must perform writes to an internal system collection. If for any reason the command does not complete successfully, you can safely retry the command on the mongos
as the operation is idempotent.
TLS
Options Replace Deprecated SSL
Optionsnet.ssl
Options configuration file options.To avoid deprecation messages, use the new TLS
options for the mongod, the mongos, and the mongo shell.mongod
and mongos
configuration file options, refer to the configuration file page.tls
options, refer to the connection string page.retryWrites=true
option. The retryWrites=true
option can be omitted in applications that use drivers compatible with MongoDB 4.2 and higher.retryWrites=false
in the connection string.If on PowerPC, you had found hashed index field with the value 2 63,