google-cloud-spanner 2.31.0 → 2.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 747996c4ee90317631f8648dbc5abefec1ef5dec80ab4e867475dfc465671cf6
-  data.tar.gz: 7316c929b5c69c3595e35780fe13ced837091de64de0da2ad13e41c2ccab065e
+  metadata.gz: 8e4f1e2c9ad4832aa5ade2d7f086d0e9fd3f8f7c01a48147f0160ab8d4ed774a
+  data.tar.gz: a2f84a797e638ad1fb7538a861cd8b153dea2d0aaab0e6a89138c9592b37edf8
 SHA512:
-  metadata.gz: c5f2caed803fc1883c743c34b45a54383259d20749628d01af88cd94d6ac2b89195af9597d763a199b597066a1bee5999fa3b2c3e34b89b59d78c5e86a7cdee1
-  data.tar.gz: 8d40b705e2b0fa7b93f2aa334b8b034ad8cb320833d32d6c0bf7a1073966d6cc9d9b40192a86bd1d3fcacce64c020a60f7b4b4fa6b2b9ffdefbc6f308428b711
+  metadata.gz: f5e6a8a01519dc8bf7c87d81c1fd162c5297f5067c2fc7f42904aad8f59c13c322630841d20fc5433175c8cf3d4ef7afa52e01e0bf1171c35d27984e20d75d42
+  data.tar.gz: da60a3a4874ac6a695715f567baadd09de69c8691269a9dfd7c0f5011af80ff700feef8396fc79e97c22491b307c8f7e9b37742ba8bffc04706ee5560f80bbf8

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+### 2.32.0 (2025-12-04)
+
+#### Features
+
+* Add support for ReadLockMode ([#171](https://github.com/googleapis/ruby-spanner/issues/171)) 
+
 ### 2.31.0 (2025-12-02)
 
 #### Features

data/lib/google/cloud/spanner/client.rb

@@ -1105,6 +1105,13 @@ module Google
         #     * `:retry_codes` (`Array<String>`) - The error codes that should
         #       trigger a retry.
         #
+        # @param [Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite::ReadLockMode] read_lock_mode
+        #   The read lock mode for the transaction.
+        #   Can be one of the following:
+        #   * `:READ_LOCK_MODE_UNSPECIFIED` : The default unspecified read lock mode.
+        #   * `:PESSIMISTIC` : The pessimistic lock mode, where read locks are acquired immediately on read.
+        #   * `:OPTIMISTIC` : The optimistic lock mode, where locks for reads are not acquired on read
+        #       but instead on a commit to validate that the data has not changed since the transaction started.
         #
         # @return [Time, CommitResponse] The timestamp at which the operation
         #   committed. If commit options are set it returns {CommitResponse}.
@@ -1161,7 +1168,7 @@ module Google
         def upsert table, rows,
                    exclude_txn_from_change_streams: false,
                    isolation_level: nil, commit_options: nil, request_options: nil,
-                   call_options: nil
+                   call_options: nil, read_lock_mode: nil
           request_options = Convert.to_request_options \
             request_options, tag_type: :transaction_tag
 
@@ -1171,7 +1178,8 @@ module Google
                            isolation_level: isolation_level,
                            commit_options: commit_options,
                            request_options: request_options,
-                           call_options: call_options
+                           call_options: call_options,
+                           read_lock_mode: read_lock_mode
           end
         end
         alias save upsert
@@ -1257,6 +1265,15 @@ module Google
         #       trigger a retry.
         #
         #
+        # @param [Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite::ReadLockMode] read_lock_mode
+        #   The read lock mode for the transaction.
+        #   Can be one of the following:
+        #   * `:READ_LOCK_MODE_UNSPECIFIED` : The default unspecified read lock mode.
+        #   * `:PESSIMISTIC` : The pessimistic lock mode, where read locks are acquired immediately on read.
+        #   * `:OPTIMISTIC` : The optimistic lock mode, where locks for reads are not acquired on read
+        #       but instead on a commit to validate that the data has not changed since the transaction started.
+        #
+        #
         # @return [Time, CommitResponse] The timestamp at which the operation
         #   committed. If commit options are set it returns {CommitResponse}.
         #
@@ -1312,7 +1329,7 @@ module Google
         def insert table, rows,
                    exclude_txn_from_change_streams: false,
                    isolation_level: nil, commit_options: nil, request_options: nil,
-                   call_options: nil
+                   call_options: nil, read_lock_mode: nil
           request_options = Convert.to_request_options \
             request_options, tag_type: :transaction_tag
 
@@ -1322,7 +1339,8 @@ module Google
                            isolation_level: isolation_level,
                            commit_options: commit_options,
                            request_options: request_options,
-                           call_options: call_options
+                           call_options: call_options,
+                           read_lock_mode: read_lock_mode
           end
         end
 
@@ -1406,6 +1424,14 @@ module Google
         #     * `:retry_codes` (`Array<String>`) - The error codes that should
         #       trigger a retry.
         #
+        # @param [Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite::ReadLockMode] read_lock_mode
+        #   The read lock mode for the transaction.
+        #   Can be one of the following:
+        #   * `:READ_LOCK_MODE_UNSPECIFIED` : The default unspecified read lock mode.
+        #   * `:PESSIMISTIC` : The pessimistic lock mode, where read locks are acquired immediately on read.
+        #   * `:OPTIMISTIC` : The optimistic lock mode, where locks for reads are not acquired on read
+        #       but instead on a commit to validate that the data has not changed since the transaction started.
+        #
         #
         # @return [Time, CommitResponse] The timestamp at which the operation
         #   committed. If commit options are set it returns {CommitResponse}.
@@ -1461,7 +1487,7 @@ module Google
         def update table, rows,
                    exclude_txn_from_change_streams: false,
                    isolation_level: nil, commit_options: nil, request_options: nil,
-                   call_options: nil
+                   call_options: nil, read_lock_mode: nil
           request_options = Convert.to_request_options \
             request_options, tag_type: :transaction_tag
 
@@ -1471,7 +1497,8 @@ module Google
                            isolation_level: isolation_level,
                            commit_options: commit_options,
                            request_options: request_options,
-                           call_options: call_options
+                           call_options: call_options,
+                           read_lock_mode: read_lock_mode
           end
         end
 
@@ -1557,6 +1584,14 @@ module Google
         #     * `:retry_codes` (`Array<String>`) - The error codes that should
         #       trigger a retry.
         #
+        # @param [Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite::ReadLockMode] read_lock_mode
+        #   The read lock mode for the transaction.
+        #   Can be one of the following:
+        #   * `:READ_LOCK_MODE_UNSPECIFIED` : The default unspecified read lock mode.
+        #   * `:PESSIMISTIC` : The pessimistic lock mode, where read locks are acquired immediately on read.
+        #   * `:OPTIMISTIC` : The optimistic lock mode, where locks for reads are not acquired on read
+        #       but instead on a commit to validate that the data has not changed since the transaction started.
+        #
         #
         # @return [Time, CommitResponse] The timestamp at which the operation
         #   committed. If commit options are set it returns {CommitResponse}.
@@ -1612,14 +1647,15 @@ module Google
         def replace table, rows,
                     exclude_txn_from_change_streams: false,
                     isolation_level: nil, commit_options: nil, request_options: nil,
-                    call_options: nil
+                    call_options: nil, read_lock_mode: nil
           @pool.with_session do |session|
             session.replace table, rows,
                             exclude_txn_from_change_streams: exclude_txn_from_change_streams,
                             isolation_level: isolation_level,
                             commit_options: commit_options,
                             request_options: request_options,
-                            call_options: call_options
+                            call_options: call_options,
+                            read_lock_mode: read_lock_mode
           end
         end
 
@@ -1684,6 +1720,15 @@ module Google
         #     * `:retry_codes` (`Array<String>`) - The error codes that should
         #       trigger a retry.
         #
+        # @param [Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite::ReadLockMode] read_lock_mode
+        #   The read lock mode for the transaction.
+        #   Can be one of the following:
+        #   * `:READ_LOCK_MODE_UNSPECIFIED` : The default unspecified read lock mode.
+        #   * `:PESSIMISTIC` : The pessimistic lock mode, where read locks are acquired immediately on read.
+        #   * `:OPTIMISTIC` : The optimistic lock mode, where locks for reads are not acquired on read
+        #       but instead on a commit to validate that the data has not changed since the transaction started.
+        #
+        #
         # @return [Time, CommitResponse] The timestamp at which the operation
         #   committed. If commit options are set it returns {CommitResponse}.
         #
@@ -1732,7 +1777,7 @@ module Google
         def delete table, keys = [],
                    exclude_txn_from_change_streams: false,
                    isolation_level: nil, commit_options: nil, request_options: nil,
-                   call_options: nil
+                   call_options: nil, read_lock_mode: nil
           request_options = Convert.to_request_options \
             request_options, tag_type: :transaction_tag
 
@@ -1742,7 +1787,8 @@ module Google
                            isolation_level: isolation_level,
                            commit_options: commit_options,
                            request_options: request_options,
-                           call_options: call_options
+                           call_options: call_options,
+                           read_lock_mode: read_lock_mode
           end
         end
 
@@ -1805,6 +1851,15 @@ module Google
         # @yield [commit] The block for mutating the data.
         # @yieldparam [Google::Cloud::Spanner::Commit] commit The Commit object.
         #
+        # @param [Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite::ReadLockMode] read_lock_mode
+        #   The read lock mode for the transaction.
+        #   Can be one of the following:
+        #   * `:READ_LOCK_MODE_UNSPECIFIED` : The default unspecified read lock mode.
+        #   * `:PESSIMISTIC` : The pessimistic lock mode, where read locks are acquired immediately on read.
+        #   * `:OPTIMISTIC` : The optimistic lock mode, where locks for reads are not acquired on read
+        #       but instead on a commit to validate that the data has not changed since the transaction started.
+        #
+        #
         # @return [Time, CommitResponse] The timestamp at which the operation
         #   committed. If commit options are set it returns {CommitResponse}.
         #
@@ -1863,7 +1918,7 @@ module Google
         #
         def commit exclude_txn_from_change_streams: false,
                    isolation_level: nil, commit_options: nil, request_options: nil,
-                   call_options: nil, &block
+                   call_options: nil, read_lock_mode: nil, &block
           raise ArgumentError, "Must provide a block" unless block_given?
 
           request_options = Convert.to_request_options \
@@ -1876,6 +1931,7 @@ module Google
               commit_options: commit_options,
               request_options: request_options,
               call_options: call_options,
+              read_lock_mode: read_lock_mode,
               &block
             )
           end
@@ -2042,6 +2098,15 @@ module Google
         #     * `:retry_codes` (`Array<String>`) - The error codes that should
         #       trigger a retry.
         #
+        # @param [Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite::ReadLockMode] read_lock_mode
+        #   The read lock mode for the transaction.
+        #   Can be one of the following:
+        #   * `:READ_LOCK_MODE_UNSPECIFIED` : The default unspecified read lock mode.
+        #   * `:PESSIMISTIC` : The pessimistic lock mode, where read locks are acquired immediately on read.
+        #   * `:OPTIMISTIC` : The optimistic lock mode, where locks for reads are not acquired on read
+        #       but instead on a commit to validate that the data has not changed since the transaction started.
+        #
+        #
         # @yield [transaction] The block for reading and writing data.
         # @yieldparam [Google::Cloud::Spanner::Transaction] transaction The
         #   Transaction object.
@@ -2144,7 +2209,7 @@ module Google
         #   end
         #
         def transaction deadline: 120, exclude_txn_from_change_streams: false,
-                        commit_options: nil, request_options: nil, call_options: nil
+                        commit_options: nil, request_options: nil, call_options: nil, read_lock_mode: nil
           ensure_service!
           unless Thread.current[IS_TRANSACTION_RUNNING_KEY].nil?
             raise "Nested transactions are not allowed"
@@ -2158,7 +2223,8 @@ module Google
             request_options, tag_type: :transaction_tag
 
           @pool.with_session do |session|
-            tx = session.create_empty_transaction exclude_txn_from_change_streams: exclude_txn_from_change_streams
+            tx = session.create_empty_transaction \
+              exclude_txn_from_change_streams: exclude_txn_from_change_streams, read_lock_mode: read_lock_mode
             if request_options
               tx.transaction_tag = request_options[:transaction_tag]
             end
@@ -2175,7 +2241,8 @@ module Google
                 tx.safe_begin_transaction!(
                   exclude_from_change_streams: exclude_txn_from_change_streams,
                   request_options: request_options,
-                  call_options: call_options
+                  call_options: call_options,
+                  read_lock_mode: read_lock_mode
                 )
               end
 
@@ -2195,7 +2262,8 @@ module Google
                   commit_options: commit_options,
                   request_options: request_options,
                   call_options: call_options,
-                  precommit_token: tx.precommit_token
+                  precommit_token: tx.precommit_token,
+                  read_lock_mode: read_lock_mode
                 )
 
                 tx.precommit_token = commit_resp.precommit_token
@@ -2216,7 +2284,8 @@ module Google
               previous_transaction_id = tx.transaction_id if tx.existing_transaction?
               tx = session.create_empty_transaction(
                 exclude_txn_from_change_streams: exclude_txn_from_change_streams,
-                previous_transaction_id: previous_transaction_id
+                previous_transaction_id: previous_transaction_id,
+                read_lock_mode: read_lock_mode
               )
               if request_options
                 tx.transaction_tag = request_options[:transaction_tag]

data/lib/google/cloud/spanner/service.rb

@@ -540,12 +540,14 @@ module Google
         def commit session_name, mutations = [],
                    transaction_id: nil, exclude_txn_from_change_streams: false,
                    isolation_level: nil, commit_options: nil, request_options: nil,
-                   call_options: nil, precommit_token: nil
+                   call_options: nil, precommit_token: nil, read_lock_mode: nil
           route_to_leader = LARHeaders.commit
           tx_opts = nil
           if transaction_id.nil?
             tx_opts = V1::TransactionOptions.new(
-              read_write: V1::TransactionOptions::ReadWrite.new,
+              read_write: V1::TransactionOptions::ReadWrite.new(
+                read_lock_mode: read_lock_mode
+              ),
               exclude_txn_from_change_streams: exclude_txn_from_change_streams,
               isolation_level: isolation_level
             )
@@ -640,7 +642,8 @@ module Google
                               call_options: nil,
                               route_to_leader: nil,
                               mutation_key: nil,
-                              previous_transaction_id: nil
+                              previous_transaction_id: nil,
+                              read_lock_mode: nil
           read_write = if previous_transaction_id.nil?
                          V1::TransactionOptions::ReadWrite.new
                        else
@@ -649,6 +652,10 @@ module Google
                          )
                        end
 
+          unless read_lock_mode.nil?
+            read_write.read_lock_mode = read_lock_mode
+          end
+
           tx_opts = V1::TransactionOptions.new(
             read_write: read_write,
             exclude_txn_from_change_streams: exclude_txn_from_change_streams

data/lib/google/cloud/spanner/session.rb

@@ -648,6 +648,15 @@ module Google
         #     * `:retry_codes` (`Array<String>`) - The error codes that should
         #       trigger a retry.
         #
+        # @param [Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite::ReadLockMode] read_lock_mode
+        #   The read lock mode for the transaction.
+        #   Can be one of the following:
+        #   * `:READ_LOCK_MODE_UNSPECIFIED` : The default unspecified read lock mode.
+        #   * `:PESSIMISTIC` : The pessimistic lock mode, where read locks are acquired immediately on read.
+        #   * `:OPTIMISTIC` : The optimistic lock mode, where locks for reads are not acquired on read
+        #       but instead on a commit to validate that the data has not changed since the transaction started.
+        #
+        #
         # @yield [commit] The block for mutating the data.
         # @yieldparam [Google::Cloud::Spanner::Commit] commit The Commit object.
         #
@@ -684,7 +693,7 @@ module Google
         #
         def commit transaction_id: nil, exclude_txn_from_change_streams: false,
                    isolation_level: nil, commit_options: nil, request_options: nil,
-                   call_options: nil
+                   call_options: nil, read_lock_mode: nil
           ensure_service!
           commit = Commit.new
           yield commit
@@ -698,6 +707,7 @@ module Google
                                          transaction_id: transaction_id,
                                          exclude_txn_from_change_streams: exclude_txn_from_change_streams,
                                          isolation_level: isolation_level,
+                                         read_lock_mode: read_lock_mode,
                                          commit_options: commit_options,
                                          request_options: request_options,
                                          call_options: call_options,
@@ -888,6 +898,15 @@ module Google
         #     * `:retry_codes` (`Array<String>`) - The error codes that should
         #       trigger a retry.
         #
+        # @param [Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite::ReadLockMode] read_lock_mode
+        #   The read lock mode for the transaction.
+        #   Can be one of the following:
+        #   * `:READ_LOCK_MODE_UNSPECIFIED` : The default unspecified read lock mode.
+        #   * `:PESSIMISTIC` : The pessimistic lock mode, where read locks are acquired immediately on read.
+        #   * `:OPTIMISTIC` : The optimistic lock mode, where locks for reads are not acquired on read
+        #       but instead on a commit to validate that the data has not changed since the transaction started.
+        #
+        #
         # @return [Time, CommitResponse] The timestamp at which the operation
         #   committed. If commit options are set it returns {CommitResponse}.
         #
@@ -919,14 +938,15 @@ module Google
         def upsert table, *rows,
                    transaction_id: nil, exclude_txn_from_change_streams: false,
                    isolation_level: nil, commit_options: nil, request_options: nil,
-                   call_options: nil
+                   call_options: nil, read_lock_mode: nil
           opts = {
             transaction_id: transaction_id,
             exclude_txn_from_change_streams: exclude_txn_from_change_streams,
             isolation_level: isolation_level,
             commit_options: commit_options,
             request_options: request_options,
-            call_options: call_options
+            call_options: call_options,
+            read_lock_mode: read_lock_mode
           }
           commit(**opts) do |c|
             c.upsert table, rows
@@ -1012,6 +1032,15 @@ module Google
         #     * `:retry_codes` (`Array<String>`) - The error codes that should
         #       trigger a retry.
         #
+        # @param [Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite::ReadLockMode] read_lock_mode
+        #   The read lock mode for the transaction.
+        #   Can be one of the following:
+        #   * `:READ_LOCK_MODE_UNSPECIFIED` : The default unspecified read lock mode.
+        #   * `:PESSIMISTIC` : The pessimistic lock mode, where read locks are acquired immediately on read.
+        #   * `:OPTIMISTIC` : The optimistic lock mode, where locks for reads are not acquired on read
+        #       but instead on a commit to validate that the data has not changed since the transaction started.
+        #
+        #
         # @return [Time, CommitResponse] The timestamp at which the operation
         #   committed. If commit options are set it returns {CommitResponse}.
         #
@@ -1043,14 +1072,15 @@ module Google
         def insert table, *rows,
                    transaction_id: nil, exclude_txn_from_change_streams: false,
                    isolation_level: nil, commit_options: nil, request_options: nil,
-                   call_options: nil
+                   call_options: nil, read_lock_mode: nil
           opts = {
             transaction_id: transaction_id,
             exclude_txn_from_change_streams: exclude_txn_from_change_streams,
             isolation_level: isolation_level,
             commit_options: commit_options,
             request_options: request_options,
-            call_options: call_options
+            call_options: call_options,
+            read_lock_mode: read_lock_mode
           }
           commit(**opts) do |c|
             c.insert table, rows
@@ -1135,6 +1165,15 @@ module Google
         #     * `:retry_codes` (`Array<String>`) - The error codes that should
         #       trigger a retry.
         #
+        # @param [Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite::ReadLockMode] read_lock_mode
+        #   The read lock mode for the transaction.
+        #   Can be one of the following:
+        #   * `:READ_LOCK_MODE_UNSPECIFIED` : The default unspecified read lock mode.
+        #   * `:PESSIMISTIC` : The pessimistic lock mode, where read locks are acquired immediately on read.
+        #   * `:OPTIMISTIC` : The optimistic lock mode, where locks for reads are not acquired on read
+        #       but instead on a commit to validate that the data has not changed since the transaction started.
+        #
+        #
         # @return [Time, CommitResponse] The timestamp at which the operation
         #   committed. If commit options are set it returns {CommitResponse}.
         #
@@ -1166,14 +1205,15 @@ module Google
         def update table, *rows,
                    transaction_id: nil, exclude_txn_from_change_streams: false,
                    isolation_level: nil, commit_options: nil, request_options: nil,
-                   call_options: nil
+                   call_options: nil, read_lock_mode: nil
           opts = {
             transaction_id: transaction_id,
             exclude_txn_from_change_streams: exclude_txn_from_change_streams,
             isolation_level: isolation_level,
             commit_options: commit_options,
             request_options: request_options,
-            call_options: call_options
+            call_options: call_options,
+            read_lock_mode: read_lock_mode
           }
           commit(**opts) do |c|
             c.update table, rows
@@ -1261,6 +1301,15 @@ module Google
         #     * `:retry_codes` (`Array<String>`) - The error codes that should
         #       trigger a retry.
         #
+        # @param [Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite::ReadLockMode] read_lock_mode
+        #   The read lock mode for the transaction.
+        #   Can be one of the following:
+        #   * `:READ_LOCK_MODE_UNSPECIFIED` : The default unspecified read lock mode.
+        #   * `:PESSIMISTIC` : The pessimistic lock mode, where read locks are acquired immediately on read.
+        #   * `:OPTIMISTIC` : The optimistic lock mode, where locks for reads are not acquired on read
+        #       but instead on a commit to validate that the data has not changed since the transaction started.
+        #
+        #
         # @return [Time, CommitResponse] The timestamp at which the operation
         #   committed. If commit options are set it returns {CommitResponse}.
         #
@@ -1291,14 +1340,16 @@ module Google
         #
         def replace table, *rows,
                     transaction_id: nil, exclude_txn_from_change_streams: false,
-                    isolation_level: nil, commit_options: nil, request_options: nil, call_options: nil
+                    isolation_level: nil, commit_options: nil, request_options: nil,
+                    call_options: nil, read_lock_mode: nil
           opts = {
             transaction_id: transaction_id,
             exclude_txn_from_change_streams: exclude_txn_from_change_streams,
             isolation_level: isolation_level,
             commit_options: commit_options,
             request_options: request_options,
-            call_options: call_options
+            call_options: call_options,
+            read_lock_mode: read_lock_mode
           }
           commit(**opts) do |c|
             c.replace table, rows
@@ -1364,6 +1415,15 @@ module Google
         #     * `:retry_codes` (`Array<String>`) - The error codes that should
         #       trigger a retry.
         #
+        # @param [Google::Cloud::Spanner::V1::TransactionOptions::ReadWrite::ReadLockMode] read_lock_mode
+        #   The read lock mode for the transaction.
+        #   Can be one of the following:
+        #   * `:READ_LOCK_MODE_UNSPECIFIED` : The default unspecified read lock mode.
+        #   * `:PESSIMISTIC` : The pessimistic lock mode, where read locks are acquired immediately on read.
+        #   * `:OPTIMISTIC` : The optimistic lock mode, where locks for reads are not acquired on read
+        #       but instead on a commit to validate that the data has not changed since the transaction started.
+        #
+        #
         # @return [Time, CommitResponse] The timestamp at which the operation
         #   committed. If commit options are set it returns {CommitResponse}.
         #
@@ -1392,14 +1452,15 @@ module Google
         def delete table, keys = [],
                    transaction_id: nil, exclude_txn_from_change_streams: false,
                    isolation_level: nil, commit_options: nil, request_options: nil,
-                   call_options: nil
+                   call_options: nil, read_lock_mode: nil
           opts = {
             transaction_id: transaction_id,
             exclude_txn_from_change_streams: exclude_txn_from_change_streams,
             isolation_level: isolation_level,
             commit_options: commit_options,
             request_options: request_options,
-            call_options: call_options
+            call_options: call_options,
+            read_lock_mode: read_lock_mode
           }
           commit(**opts) do |c|
             c.delete table, keys
@@ -1423,12 +1484,15 @@ module Google
         #   or write transactions from being tracked in change streams.
         # @private
         # @return [::Google::Cloud::Spanner::Transaction]
-        def create_transaction exclude_txn_from_change_streams: false
+        def create_transaction exclude_txn_from_change_streams: false, read_lock_mode: nil
           route_to_leader = LARHeaders.begin_transaction true
           tx_grpc = service.begin_transaction path,
                                               route_to_leader: route_to_leader,
-                                              exclude_txn_from_change_streams: exclude_txn_from_change_streams
-          Transaction.from_grpc tx_grpc, self, exclude_txn_from_change_streams: exclude_txn_from_change_streams
+                                              exclude_txn_from_change_streams: exclude_txn_from_change_streams,
+                                              read_lock_mode: read_lock_mode
+          Transaction.from_grpc \
+            tx_grpc, self,
+            exclude_txn_from_change_streams: exclude_txn_from_change_streams, read_lock_mode: read_lock_mode
         end
 
         # Creates a new empty transaction wrapper without a server-side object.
@@ -1444,9 +1508,10 @@ module Google
         #   of a new ReadWrite transaction when retry is attempted.
         # @private
         # @return [::Google::Cloud::Spanner::Transaction] The new *empty-wrapper* transaction object.
-        def create_empty_transaction exclude_txn_from_change_streams: false, previous_transaction_id: nil
+        def create_empty_transaction exclude_txn_from_change_streams: false, previous_transaction_id: nil,
+                                     read_lock_mode: nil
           Transaction.from_grpc nil, self, exclude_txn_from_change_streams: exclude_txn_from_change_streams,
-previous_transaction_id: previous_transaction_id
+previous_transaction_id: previous_transaction_id, read_lock_mode: read_lock_mode
         end
 
         # If the session is non-multiplexed, keeps the session alive by executing `"SELECT 1"`.

data/lib/google/cloud/spanner/transaction.rb

@@ -111,6 +111,9 @@ module Google
         # @return [::String, nil]
         attr_reader :previous_transaction_id
 
+        # @private Whether to add a read lock mode on the transaction.
+        attr_accessor :read_lock_mode
+
         # Creates a new `Spanner::Transaction` instance from a `V1::Transaction` object.
         # @param grpc [::Google::Cloud::Spanner::V1::Transaction] Underlying `V1::Transaction` object.
         # @param session [::Google::Cloud::Spanner::Session] The session this transaction is running in.
@@ -123,10 +126,11 @@ module Google
         #   of a new ReadWrite transaction when retry is attempted.
         # @private
         # @return [::Google::Cloud::Spanner::Transaction]
-        def initialize grpc, session, exclude_txn_from_change_streams, previous_transaction_id: nil
+        def initialize grpc, session, exclude_txn_from_change_streams, previous_transaction_id: nil, read_lock_mode: nil
           @grpc = grpc
           @session = session
           @exclude_txn_from_change_streams = exclude_txn_from_change_streams
+          @read_lock_mode = read_lock_mode
 
           # throwing away empty strings for simplicity
           unless previous_transaction_id.nil? || previous_transaction_id.empty?
@@ -136,6 +140,7 @@ module Google
           @commit = Commit.new
           @seqno = 0
           @exclude_txn_from_change_streams = false
+          @read_lock_mode = nil
 
           # Mutex to enfore thread safety for transaction creation and query executions.
           #
@@ -1250,8 +1255,10 @@ module Google
         #   of a new ReadWrite transaction when retry is attempted.
         # @private
         # @return [::Google::Cloud::Spanner::Transaction]
-        def self.from_grpc grpc, session, exclude_txn_from_change_streams: false, previous_transaction_id: nil
-          new grpc, session, exclude_txn_from_change_streams, previous_transaction_id: previous_transaction_id
+        def self.from_grpc grpc, session, exclude_txn_from_change_streams: false, previous_transaction_id: nil,
+                           read_lock_mode: nil
+          new grpc, session, exclude_txn_from_change_streams, previous_transaction_id: previous_transaction_id,
+read_lock_mode: read_lock_mode
         end
 
         ##
@@ -1278,7 +1285,8 @@ module Google
         # @private
         # @return [::Google::Cloud::Spanner::V1::Transaction, nil] The new transaction
         #   object, or `nil` if a transaction already exists.
-        def safe_begin_transaction! exclude_from_change_streams: false, request_options: nil, call_options: nil
+        def safe_begin_transaction! exclude_from_change_streams: false, request_options: nil, call_options: nil,
+                                    read_lock_mode: nil
           # If a read-write transaction on a multiplexed session commit mutations
           # without performing any reads or queries, one of the mutations from the mutation set
           # must be sent as a mutation key for `BeginTransaction`.
@@ -1299,7 +1307,8 @@ module Google
               call_options: call_options,
               route_to_leader: route_to_leader,
               mutation_key: mutation_key,
-              previous_transaction_id: previous_transaction_id
+              previous_transaction_id: previous_transaction_id,
+              read_lock_mode: read_lock_mode
             )
           end
         end
@@ -1343,7 +1352,7 @@ module Google
         #   or write transactions from being tracked in change streams.
         # @private
         # @return [::Google::Cloud::Spanner::V1::TransactionSelector]
-        def tx_selector exclude_txn_from_change_streams: false
+        def tx_selector exclude_txn_from_change_streams: false, read_lock_mode: nil
           return V1::TransactionSelector.new id: transaction_id if existing_transaction?
 
           read_write = if @previous_transaction_id.nil?
@@ -1354,6 +1363,10 @@ module Google
                          )
                        end
 
+          unless read_lock_mode.nil?
+            read_write.read_lock_mode = read_lock_mode
+          end
+
           V1::TransactionSelector.new(
             begin: V1::TransactionOptions.new(
               read_write: read_write,

data/lib/google/cloud/spanner/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Spanner
-      VERSION = "2.31.0".freeze
+      VERSION = "2.32.0".freeze
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-spanner
 version: !ruby/object:Gem::Version
-  version: 2.31.0
+  version: 2.32.0
 platform: ruby
 authors:
 - Mike Moore