Specify How CRUD Operations Run on Replica Sets

Overview

In this guide, you can learn how to use the write concern, read concern, and read preference configurations to modify the way that MongoDB runs create, read, update, and delete (CRUD) operations on replica sets.

You can set write concern, read concern, and read preference options at the following levels:

• Client, which sets the default for all operation executions unless overridden

• Session

• Transaction

• Database

• Collection

This list also indicates the increasing order of precedence of the option settings. For example, if you set a read concern level for a transaction, it will override a read concern level set for the client.

These options allow you to customize the causal consistency and availability of the data in your replica sets.

Write Concern

The write concern specifies the level of acknowledgement requested from MongoDB for write operations, such as an insert or update, before the operation successfully returns. Operations that do not specify an explicit write concern inherit the global default write concern settings.

For more information, see Write Concern in the Server manual. For detailed API documentation, see the WriteConcern API documentation.

The following table describes the WriteConcern parameters:

myDB.myCollection.insertOne(
   { name: "anotherDocumentName" },
   { writeConcern:
     { w: 2, wtimeoutMS: 5000 }
   }
);

const newWriteConcern = WriteConcern.fromOptions(myDB);
const myDoc = { name: "New Document" };
WriteConcern.apply(myDoc,newWriteConcern);

Read Concern

The read concern specifies the following behaviors:

• Level of causal consistency across replica sets

• Isolation guarantees maintained during a query

You can specify the read concern setting by using the level parameter. The default read concern level is local. This means that the client returns the data from the replica set member that the client is connected to, with no guarantee that the data has been written to all replica set members. Note that lower read concern level requirements may reduce latency.

For more information about read concerns or read concern levels, see Read Concern in the Server manual. For more detail on the ReadConcern type and definitions of the read concern levels, see the ReadConcern in the API documentation.

const pipeline = [
   {"$match": {
     category: "KITCHENWARE",
   }},
   {"$unset": [
     "_id",
     "category",
   ]}
 ];
result = await myDB.collection("mycollection")
   .aggregate(
     pipeline,
     { readConcern:
       { level: "available" }
     }
   );

const options = { readConcern: { level: "local" } };
const myDB = client.db("mydb", options);

Read Preference

The read preference determines which member of a replica set MongoDB reads when running a query. You can also customize how the server evaluates members.

For more detailed API documentation, see the ReadPreference API documentation.

The following table describes the ReadPreference parameters:

const transactionOptions = {
   readPreference: "primary",
   readConcern: { level: "local" },
   writeConcern: { w: "majority" },
};
const session = client.startSession();
session.startTransaction(transactionOptions);
// ...
await session.commitTransaction();
await session.endSession();

const uri = "mongodb+srv://<user>:<password>@<cluster-url>?readPreference=secondary&maxStalenessSeconds=120";
const client = new MongoClient(uri);

API Documentation

To learn more about the methods and types mentioned in this guide, see the following API documentation:

• API WriteConcern

• API ReadConcern

• API ReadPreference