Skip to content

Commit 9789120

Browse files
authored
RUBY-1384 Document Session#start_transaction options (#985)
1 parent e03f0ba commit 9789120

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

lib/mongo/session.rb

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -471,6 +471,21 @@ def explicit?
471471
# @example Start a new transaction
472472
# session.start_transaction(options)
473473
#
474+
# @param [ Hash ] options The options for the transaction being started.
475+
#
476+
# @option options [ Hash ] read_concern The read concern options hash, with the following
477+
# optional keys:
478+
# - *:level* -- the read preference level as a symbol; valid values are *:local*, *:majority*,
479+
# and *:snapshot*
480+
# - *:after_cluster_time* -- the cluster time BSON::Document or hash specifying which cluster
481+
# time reads should occur after
482+
# @option options [ Hash ] :write_concern The write concern options. Can be :w =>
483+
# Integer|String, :fsync => Boolean, :j => Boolean.
484+
# @option options [ Hash ] :read The read preference options. The hash may have the following
485+
# items:
486+
# - *:mode* -- read preference specified as a symbol; the only valid value is
487+
# *:primary*.
488+
#
474489
# @raise [ InvalidTransactionOperation ] If a transaction is already in
475490
# progress or if the write concern is unacknowledged.
476491
#

0 commit comments

Comments
 (0)