Package com.mongodb

Class TransactionOptions

java.lang.Object
com.mongodb.TransactionOptions
@Immutable public final class TransactionOptions extends Object
Options to apply to transactions. The default values for the options depend on context. For options specified per-transaction, the default values come from the default transaction options. For the default transaction options themselves, the default values come from the MongoClient on which the session was started.
Since:
3.8
See Also:
Since server release
4.0

  • Method Details

    • getReadConcern

      @Nullable public ReadConcern getReadConcern()
      Gets the read concern.
      Returns:
      the read concern

    • getWriteConcern

      @Nullable public WriteConcern getWriteConcern()
      Gets the write concern.
      Returns:
      the write concern

    • getReadPreference

      @Nullable public ReadPreference getReadPreference()
      Gets the read preference.
      Returns:
      the write concern

    • getMaxCommitTime

      @Nullable public Long getMaxCommitTime(TimeUnit timeUnit)
      Gets the maximum amount of time to allow a single commitTransaction command to execute. The default is null, which places no limit on the execution time.
      Parameters:
      timeUnit - the time unit to return the result in
      Returns:
      the maximum execution time in the given time unit
      Since:
      3.11
      Since server release
      4.2

    • getTimeout

      @Nullable @Alpha(CLIENT) public Long getTimeout(TimeUnit timeUnit)
      The time limit for the full execution of the transaction.

      If set the following deprecated options will be ignored: waitQueueTimeoutMS, socketTimeoutMS, wTimeoutMS, maxTimeMS and maxCommitTimeMS

      Parameters:
      timeUnit - the time unit
      Returns:
      the timeout in the given time unit
      Since:
      5.2

    • builder

      public static TransactionOptions.Builder builder()
      Gets an instance of a builder
      Returns:
      a builder instance

    • merge

      public static TransactionOptions merge(TransactionOptions options, TransactionOptions defaultOptions)
      Merge the two provided transaction options, with the first taking precedence over the second.
      Parameters:
      options - the transaction options, which take precedence for any property that is non-null
      defaultOptions - the default transaction options
      Returns:
      the merged transaction options

    • 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