Package com.mongodb

Class ClientSessionOptions

java.lang.Object

com.mongodb.ClientSessionOptions

@Immutable
public final class ClientSessionOptions
extends Object

The options to apply to a ClientSession.

Since:

3.6

See Also:

ClientSession

MongoDB documentation

Causal Consistency

Since server release

3.6

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClientSessionOptions.Builder	A builder for instances of ClientSession

Method Summary

Modifier and Type	Method	Description
static ClientSessionOptions.Builder	builder()	Gets an instance of a builder
static ClientSessionOptions.Builder	builder(ClientSessionOptions options)	Gets an instance of a builder initialized with the given options
boolean	equals(Object o)
TransactionOptions	getDefaultTransactionOptions()	Gets the default transaction options for the session.
int	hashCode()
Boolean	isCausallyConsistent()	Whether operations using the session should causally consistent with each other.
Boolean	isSnapshot()	Whether read operations using this session should all share the same snapshot.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

isCausallyConsistent

@Nullable
public Boolean isCausallyConsistent()

Whether operations using the session should causally consistent with each other.

Returns:

whether operations using the session should be causally consistent. A null value indicates to use the global default, which is currently true.

MongoDB documentation

Causal Consistency

isSnapshot

@Nullable
public Boolean isSnapshot()

Whether read operations using this session should all share the same snapshot.

Returns:

whether read operations using this session should all share the same snapshot. A null value indicates to use the global default, which is false.

Since:

4.3

MongoDB documentation

Snapshot reads

Since server release

5.0

getDefaultTransactionOptions

public TransactionOptions getDefaultTransactionOptions()

Gets the default transaction options for the session.

Returns:

the default transaction options for the session

Since:

3.8

Since server release

4.0

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static ClientSessionOptions.Builder builder()

Gets an instance of a builder

Returns:

a builder instance

builder

public static ClientSessionOptions.Builder builder(ClientSessionOptions options)

Gets an instance of a builder initialized with the given options

Parameters:

options - the options with which to initialize the builder

Returns:

a builder instance

Since:

3.8