Navigation
This is an upcoming (i.e. in progress) version of the manual.

Mongo.setCausalConsistency()

On this page

Definition

Mongo.setCausalConsistency(<boolean>)

New in version 3.6.

Enables or disables causal consistency on the connection object. Causal consistency is disabled on the connection object by default.

Note

The Mongo connection object may have causal consistency disabled even though sessions may have causal consistency enabled or vice versa. See Mongo.startSession().

To enable causal consistency for the connection object, call the method without any argument:

var conn = Mongo("localhost:27017");
conn.setCausalConsistency();

The method also can accept a boolean argument:

  • true to enable causal consistency:

    conn.setCausalConsistency(true);
    
  • false to disable causal consistency:

    conn.setCausalConsistency(false);
    

Example

The following mongo shell operation enables causal consistency on the Mongo connection object associated with the mongo shell’s global db variable:

db.getMongo().setCausalConsistency();

To check if causal consistency is enabled for a connection, use the Mongo.isCausalConsistency() method. For example:

db.getMongo().isCausalConsistency();