feat: allow sending request tags for snapshot queries

google-cloud-spanner/lib/google/cloud/spanner/snapshot.rb

@@ -131,6 +131,18 @@ def timestamp
         #     available optimizer version.
         #   * `:optimizer_statistics_package` (String) Statistics package to
         #     use. Empty to use the database default.
+        # @param [Hash] request_options Common request options.
+        #
+        #   * `:priority` (Symbol) The relative priority for requests.
+        #     The priority acts as a hint to the Cloud Spanner scheduler
+        #     and does not guarantee priority or order of execution.
+        #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
+        #     `:PRIORITY_HIGH`. If priority not set then default is
+        #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A per-request tag which can be applied to
+        #     queries or reads, used for statistics collection. Tag must be a
+        #     valid identifier of the form: `[a-zA-Z][a-zA-Z0-9_\-]` between 2
+        #     and 64 characters in length.
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -304,13 +316,17 @@ def timestamp
         #   end
         #
         def execute_query sql, params: nil, types: nil, query_options: nil,
-                          call_options: nil, directed_read_options: nil
+                          request_options: nil, call_options: nil,
+                          directed_read_options: nil
           ensure_session!
 
           params, types = Convert.to_input_params_and_types params, types
+          request_options = Convert.to_request_options request_options,
+                                                       tag_type: :request_tag
           session.execute_query sql, params: params, types: types,
                                      transaction: tx_selector,
                                      query_options: query_options,
+                                     request_options: request_options,
                                      call_options: call_options,
                                      directed_read_options: directed_read_options || @directed_read_options
         end
@@ -334,6 +350,18 @@ def execute_query sql, params: nil, types: nil, query_options: nil,
         #   Optional.
         # @param [Integer] limit If greater than zero, no more than this number
         #   of rows will be returned. The default is no limit.
+        # @param [Hash] request_options Common request options.
+        #
+        #   * `:priority` (Symbol) The relative priority for requests.
+        #     The priority acts as a hint to the Cloud Spanner scheduler
+        #     and does not guarantee priority or order of execution.
+        #     Valid values are `:PRIORITY_LOW`, `:PRIORITY_MEDIUM`,
+        #     `:PRIORITY_HIGH`. If priority not set then default is
+        #     `PRIORITY_UNSPECIFIED` is equivalent to `:PRIORITY_HIGH`.
+        #   * `:tag` (String) A per-request tag which can be applied to
+        #     queries or reads, used for statistics collection. Tag must be a
+        #     valid identifier of the form: `[a-zA-Z][a-zA-Z0-9_\-]` between 2
+        #     and 64 characters in length.
         # @param [Hash] call_options A hash of values to specify the custom
         #   call options, e.g., timeout, retries, etc. Call options are
         #   optional. The following settings can be provided:
@@ -380,14 +408,15 @@ def execute_query sql, params: nil, types: nil, query_options: nil,
         #   end
         #
         def read table, columns, keys: nil, index: nil, limit: nil,
-                 call_options: nil, directed_read_options: nil
+                 request_options: nil, call_options: nil, directed_read_options: nil
           ensure_session!
 
           columns = Array(columns).map(&:to_s)
           keys = Convert.to_key_set keys
 
           session.read table, columns, keys: keys, index: index, limit: limit,
                                        transaction: tx_selector,
+                                       request_options: request_options,
                                        call_options: call_options,
                                        directed_read_options: directed_read_options || @directed_read_options
         end

google-cloud-spanner/test/google/cloud/spanner/snapshot/execute_query_test.rb

@@ -324,6 +324,42 @@
     assert_results results
   end
 
+  describe "request options" do
+    it "can execute a query with priority option" do
+      mock = Minitest::Mock.new
+      session.service.mocked_service = mock
+
+      request_options = { priority: :PRIORITY_MEDIUM }
+
+      expect_execute_streaming_sql results_enum, session.path, "SELECT * FROM users",
+                                   transaction: tx_selector,
+                                   request_options: request_options,
+                                   options: default_options
+
+      results = snapshot.execute_query "SELECT * FROM users", request_options: request_options
+
+      mock.verify
+      assert_results results
+    end
+
+    it "can execute a query with request tag" do
+      mock = Minitest::Mock.new
+      session.service.mocked_service = mock
+
+      request_options = { request_tag: "Tag-1" }
+
+      expect_execute_streaming_sql results_enum, session.path, "SELECT * FROM users",
+                                  transaction: tx_selector,
+                                  request_options: request_options,
+                                  options: default_options
+
+      results = snapshot.execute_query "SELECT * FROM users", request_options: request_options
+
+      mock.verify
+      assert_results results
+    end
+  end
+
   def assert_results results
     _(results).must_be_kind_of Google::Cloud::Spanner::Results
 

google-cloud-spanner/test/google/cloud/spanner/snapshot/read_test.rb

@@ -280,6 +280,52 @@
     assert_results results
   end
 
+  describe "request options" do
+    it "can execute a query with priority option" do
+      columns = [:id, :name, :active, :age, :score, :updated_at, :birthday, :avatar, :project_ids]
+
+      request_options = { priority: :PRIORITY_MEDIUM }
+
+      mock = Minitest::Mock.new
+      mock.expect :streaming_read, results_enum, [{
+        session: session_grpc.name, table: "my-table",
+        columns: ["id", "name", "active", "age", "score", "updated_at", "birthday", "avatar", "project_ids"],
+        key_set: Google::Cloud::Spanner::V1::KeySet.new(keys: [Google::Cloud::Spanner::Convert.object_to_grpc_value([1]).list_value, Google::Cloud::Spanner::Convert.object_to_grpc_value([2]).list_value, Google::Cloud::Spanner::Convert.object_to_grpc_value([3]).list_value]),
+        transaction: tx_selector, index: nil, limit: nil, resume_token: nil, partition_token: nil,
+        request_options: request_options, order_by: nil, lock_hint: nil
+      }, default_options]
+      session.service.mocked_service = mock
+
+      results = snapshot.read "my-table", columns, keys: [1, 2, 3], request_options: request_options
+
+      mock.verify
+
+      assert_results results
+    end
+
+    it "can execute a query with request tag" do
+      columns = [:id, :name, :active, :age, :score, :updated_at, :birthday, :avatar, :project_ids]
+
+       request_options = { request_tag: "Tag-1" }
+
+      mock = Minitest::Mock.new
+      mock.expect :streaming_read, results_enum, [{
+        session: session_grpc.name, table: "my-table",
+        columns: ["id", "name", "active", "age", "score", "updated_at", "birthday", "avatar", "project_ids"],
+        key_set: Google::Cloud::Spanner::V1::KeySet.new(keys: [Google::Cloud::Spanner::Convert.object_to_grpc_value([1]).list_value, Google::Cloud::Spanner::Convert.object_to_grpc_value([2]).list_value, Google::Cloud::Spanner::Convert.object_to_grpc_value([3]).list_value]),
+        transaction: tx_selector, index: nil, limit: nil, resume_token: nil, partition_token: nil,
+        request_options: request_options, order_by: nil, lock_hint: nil
+      }, default_options]
+      session.service.mocked_service = mock
+
+      results = snapshot.read "my-table", columns, keys: [1, 2, 3], request_options: request_options
+
+      mock.verify
+
+      assert_results results
+    end
+  end
+
   def assert_results results
     _(results).must_be_kind_of Google::Cloud::Spanner::Results