google-cloud-spanner 2.3.0 → 2.8.0

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

@@ -116,6 +116,7 @@ module Google
         #   | `BOOL`      | `true`/`false` | |
         #   | `INT64`     | `Integer`      | |
         #   | `FLOAT64`   | `Float`        | |
+        #   | `NUMERIC`   | `BigDecimal`   | |
         #   | `STRING`    | `String`       | |
         #   | `DATE`      | `Date`         | |
         #   | `TIMESTAMP` | `Time`, `DateTime` | |
@@ -141,6 +142,7 @@ module Google
         #   * `:BYTES`
         #   * `:DATE`
         #   * `:FLOAT64`
+        #   * `:NUMERIC`
         #   * `:INT64`
         #   * `:STRING`
         #   * `:TIMESTAMP`
@@ -163,6 +165,8 @@ module Google
         #   * `:optimizer_version` (String) The version of optimizer to use.
         #     Empty to use database default. "latest" to use the latest
         #     available optimizer version.
+        #   * `:optimizer_statistics_package` (String) Statistics package to
+        #     use. Empty to use the database default.
         # @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:
@@ -283,7 +287,10 @@ module Google
         #   db = spanner.client "my-instance", "my-database"
         #
         #   results = db.execute_query \
-        #     "SELECT * FROM users", query_options: { optimizer_version: "1" }
+        #     "SELECT * FROM users", query_options: {
+        #       optimizer_version: "1",
+        #       optimizer_statistics_package: "auto_20191128_14_47_22UTC"
+        #     }
         #
         #   results.rows.each do |row|
         #     puts "User #{row[:id]} is #{row[:name]}"
@@ -314,7 +321,7 @@ module Google
         #
         def execute_query sql, params: nil, types: nil, transaction: nil,
                           partition_token: nil, seqno: nil, query_options: nil,
-                          call_options: nil
+                          request_options: nil, call_options: nil
           ensure_service!
           if query_options.nil?
             query_options = @query_options
@@ -328,6 +335,7 @@ module Google
                                           partition_token: partition_token,
                                           seqno: seqno,
                                           query_options: query_options,
+                                          request_options: request_options,
                                           call_options: call_options
           @last_updated_at = Time.now
           results
@@ -369,7 +377,8 @@ module Google
         # @return [Array<Integer>] A list with the exact number of rows that
         #   were modified for each DML statement.
         #
-        def batch_update transaction, seqno, call_options: nil
+        def batch_update transaction, seqno, request_options: nil,
+                         call_options: nil
           ensure_service!
 
           raise ArgumentError, "block is required" unless block_given?
@@ -379,6 +388,7 @@ module Google
 
           results = service.execute_batch_dml path, transaction,
                                               batch.statements, seqno,
+                                              request_options: request_options,
                                               call_options: call_options
           @last_updated_at = Time.now
           results
@@ -434,13 +444,15 @@ module Google
         #   end
         #
         def read table, columns, keys: nil, index: nil, limit: nil,
-                 transaction: nil, partition_token: nil, call_options: nil
+                 transaction: nil, partition_token: nil, request_options: nil,
+                 call_options: nil
           ensure_service!
 
           results = Results.read service, path, table, columns,
                                  keys: keys, index: index, limit: limit,
                                  transaction: transaction,
                                  partition_token: partition_token,
+                                 request_options: request_options,
                                  call_options: call_options
           @last_updated_at = Time.now
           results
@@ -542,13 +554,15 @@ module Google
         #   puts commit_resp.timestamp
         #   puts commit_resp.stats.mutation_count
         #
-        def commit transaction_id: nil, commit_options: nil, call_options: nil
+        def commit transaction_id: nil, commit_options: nil,
+                   request_options: nil, call_options: nil
           ensure_service!
           commit = Commit.new
           yield commit
           commit_resp = service.commit path, commit.mutations,
                                        transaction_id: transaction_id,
                                        commit_options: commit_options,
+                                       request_options: request_options,
                                        call_options: call_options
           @last_updated_at = Time.now
           resp = CommitResponse.from_grpc commit_resp
@@ -573,6 +587,7 @@ module Google
         #   | `BOOL`      | `true`/`false` | |
         #   | `INT64`     | `Integer`      | |
         #   | `FLOAT64`   | `Float`        | |
+        #   | `NUMERIC`   | `BigDecimal`   | |
         #   | `STRING`    | `String`       | |
         #   | `DATE`      | `Date`         | |
         #   | `TIMESTAMP` | `Time`, `DateTime` | |
@@ -633,13 +648,14 @@ module Google
         #   puts commit_resp.stats.mutation_count
         #
         def upsert table, *rows, transaction_id: nil, commit_options: nil,
-                   call_options: nil
+                   request_options: nil, call_options: nil
           opts = {
             transaction_id: transaction_id,
             commit_options: commit_options,
+            request_options: request_options,
             call_options: call_options
           }
-          commit opts do |c|
+          commit(**opts) do |c|
             c.upsert table, rows
           end
         end
@@ -662,6 +678,7 @@ module Google
         #   | `BOOL`      | `true`/`false` | |
         #   | `INT64`     | `Integer`      | |
         #   | `FLOAT64`   | `Float`        | |
+        #   | `NUMERIC`   | `BigDecimal`   | |
         #   | `STRING`    | `String`       | |
         #   | `DATE`      | `Date`         | |
         #   | `TIMESTAMP` | `Time`, `DateTime` | |
@@ -722,13 +739,14 @@ module Google
         #   puts commit_resp.stats.mutation_count
         #
         def insert table, *rows, transaction_id: nil, commit_options: nil,
-                   call_options: nil
+                   request_options: nil, call_options: nil
           opts = {
             transaction_id: transaction_id,
             commit_options: commit_options,
+            request_options: request_options,
             call_options: call_options
           }
-          commit opts do |c|
+          commit(**opts) do |c|
             c.insert table, rows
           end
         end
@@ -750,6 +768,7 @@ module Google
         #   | `BOOL`      | `true`/`false` | |
         #   | `INT64`     | `Integer`      | |
         #   | `FLOAT64`   | `Float`        | |
+        #   | `NUMERIC`   | `BigDecimal`   | |
         #   | `STRING`    | `String`       | |
         #   | `DATE`      | `Date`         | |
         #   | `TIMESTAMP` | `Time`, `DateTime` | |
@@ -810,13 +829,14 @@ module Google
         #   puts commit_resp.stats.mutation_count
         #
         def update table, *rows, transaction_id: nil, commit_options: nil,
-                   call_options: nil
+                   request_options: nil, call_options: nil
           opts = {
             transaction_id: transaction_id,
             commit_options: commit_options,
+            request_options: request_options,
             call_options: call_options
           }
-          commit opts do |c|
+          commit(**opts) do |c|
             c.update table, rows
           end
         end
@@ -840,6 +860,7 @@ module Google
         #   | `BOOL`      | `true`/`false` | |
         #   | `INT64`     | `Integer`      | |
         #   | `FLOAT64`   | `Float`        | |
+        #   | `NUMERIC`   | `BigDecimal`   | |
         #   | `STRING`    | `String`       | |
         #   | `DATE`      | `Date`         | |
         #   | `TIMESTAMP` | `Time`, `DateTime` | |
@@ -900,13 +921,14 @@ module Google
         #   puts commit_resp.stats.mutation_count
         #
         def replace table, *rows, transaction_id: nil, commit_options: nil,
-                    call_options: nil
+                    request_options: nil, call_options: nil
           opts = {
             transaction_id: transaction_id,
             commit_options: commit_options,
+            request_options: request_options,
             call_options: call_options
           }
-          commit opts do |c|
+          commit(**opts) do |c|
             c.replace table, rows
           end
         end
@@ -968,13 +990,14 @@ module Google
         #   puts commit_resp.stats.mutation_count
         #
         def delete table, keys = [], transaction_id: nil, commit_options: nil,
-                   call_options: nil
+                   request_options: nil, call_options: nil
           opts = {
             transaction_id: transaction_id,
             commit_options: commit_options,
+            request_options: request_options,
             call_options: call_options
           }
-          commit opts do |c|
+          commit(**opts) do |c|
             c.delete table, keys
           end
         end

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

@@ -83,6 +83,7 @@ module Google
         #   | `BOOL`      | `true`/`false` | |
         #   | `INT64`     | `Integer`      | |
         #   | `FLOAT64`   | `Float`        | |
+        #   | `NUMERIC`   | `BigDecimal`   | |
         #   | `STRING`    | `String`       | |
         #   | `DATE`      | `Date`         | |
         #   | `TIMESTAMP` | `Time`, `DateTime` | |
@@ -108,6 +109,7 @@ module Google
         #   * `:BYTES`
         #   * `:DATE`
         #   * `:FLOAT64`
+        #   * `:NUMERIC`
         #   * `:INT64`
         #   * `:STRING`
         #   * `:TIMESTAMP`
@@ -125,6 +127,8 @@ module Google
         #   * `:optimizer_version` (String) The version of optimizer to use.
         #     Empty to use database default. "latest" to use the latest
         #     available optimizer version.
+        #   * `:optimizer_statistics_package` (String) Statistics package to
+        #     use. Empty to use the database default.
         # @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:
@@ -249,7 +253,10 @@ module Google
         #
         #   db.snapshot do |snp|
         #     results = snp.execute_query \
-        #       "SELECT * FROM users", query_options: { optimizer_version: "1" }
+        #       "SELECT * FROM users", query_options: {
+        #         optimizer_version: "1",
+        #         optimizer_statistics_package: "auto_20191128_14_47_22UTC"
+        #       }
         #
         #     results.rows.each do |row|
         #       puts "User #{row[:id]} is #{row[:name]}"
@@ -373,12 +380,13 @@ module Google
         #   Hash values must contain the type value. If a Hash is used the
         #   fields will be created using the same order as the Hash keys.
         #
-        #   Supported type values incude:
+        #   Supported type values include:
         #
         #   * `:BOOL`
         #   * `:BYTES`
         #   * `:DATE`
         #   * `:FLOAT64`
+        #   * `:NUMERIC`
         #   * `:INT64`
         #   * `:STRING`
         #   * `:TIMESTAMP`

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

@@ -49,7 +49,10 @@ module Google
       #   end
       #
       class Status
-        attr_reader :code, :description, :message, :details
+        attr_reader :code
+        attr_reader :description
+        attr_reader :message
+        attr_reader :details
 
         ##
         # @private Creates a Status object.

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

@@ -113,6 +113,7 @@ module Google
         #   | `BOOL`      | `true`/`false` | |
         #   | `INT64`     | `Integer`      | |
         #   | `FLOAT64`   | `Float`        | |
+        #   | `NUMERIC`   | `BigDecimal`   | |
         #   | `STRING`    | `String`       | |
         #   | `DATE`      | `Date`         | |
         #   | `TIMESTAMP` | `Time`, `DateTime` | |
@@ -138,6 +139,7 @@ module Google
         #   * `:BYTES`
         #   * `:DATE`
         #   * `:FLOAT64`
+        #   * `:NUMERIC`
         #   * `:INT64`
         #   * `:STRING`
         #   * `:TIMESTAMP`
@@ -155,6 +157,16 @@ module Google
         #   * `:optimizer_version` (String) The version of optimizer to use.
         #     Empty to use database default. "latest" to use the latest
         #     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` (String) 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`.
         # @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:
@@ -280,7 +292,10 @@ module Google
         #
         #   db.transaction do |tx|
         #     results = tx.execute_query \
-        #       "SELECT * FROM users", query_options: { optimizer_version: "1" }
+        #       "SELECT * FROM users", query_options: {
+        #       optimizer_version: "1",
+        #       optimizer_statistics_package: "auto_20191128_14_47_22UTC"
+        #     }
         #
         #     results.rows.each do |row|
         #       puts "User #{row[:id]} is #{row[:name]}"
@@ -312,7 +327,7 @@ module Google
         #   end
         #
         def execute_query sql, params: nil, types: nil, query_options: nil,
-                          call_options: nil
+                          request_options: nil, call_options: nil
           ensure_session!
 
           @seqno += 1
@@ -321,6 +336,7 @@ module Google
           session.execute_query sql, params: params, types: types,
                                      transaction: tx_selector, seqno: @seqno,
                                      query_options: query_options,
+                                     request_options: request_options,
                                      call_options: call_options
         end
         alias execute execute_query
@@ -350,6 +366,7 @@ module Google
         #   | `BOOL`      | `true`/`false` | |
         #   | `INT64`     | `Integer`      | |
         #   | `FLOAT64`   | `Float`        | |
+        #   | `NUMERIC`   | `BigDecimal`   | |
         #   | `STRING`    | `String`       | |
         #   | `DATE`      | `Date`         | |
         #   | `TIMESTAMP` | `Time`, `DateTime` | |
@@ -376,6 +393,7 @@ module Google
         #   * `:BYTES`
         #   * `:DATE`
         #   * `:FLOAT64`
+        #   * `:NUMERIC`
         #   * `:INT64`
         #   * `:STRING`
         #   * `:TIMESTAMP`
@@ -391,6 +409,16 @@ module Google
         #   * `:optimizer_version` (String) The version of optimizer to use.
         #     Empty to use database default. "latest" to use the latest
         #     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` (String) 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`.
         # @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:
@@ -441,7 +469,10 @@ module Google
         #   db.transaction do |tx|
         #     row_count = tx.execute_update(
         #       "UPDATE users SET name = 'Charlie' WHERE id = 1",
-        #       query_options: { optimizer_version: "1" }
+        #       query_options: {
+        #         optimizer_version: "1",
+        #         optimizer_statistics_package: "auto_20191128_14_47_22UTC"
+        #       }
         #     )
         #   end
         #
@@ -468,9 +499,10 @@ module Google
         #   end
         #
         def execute_update sql, params: nil, types: nil, query_options: nil,
-                           call_options: nil
+                           request_options: nil, call_options: nil
           results = execute_query sql, params: params, types: types,
                                   query_options: query_options,
+                                  request_options: request_options,
                                   call_options: call_options
           # Stream all PartialResultSet to get ResultSetStats
           results.rows.to_a
@@ -485,6 +517,14 @@ module Google
         ##
         # Executes DML statements in a batch.
         #
+        # @param [Hash] request_options Common request options.
+        #
+        #   * `:priority` (String) 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`.
         # @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:
@@ -554,10 +594,11 @@ module Google
         #     end
         #   end
         #
-        def batch_update call_options: nil, &block
+        def batch_update request_options: nil, call_options: nil, &block
           ensure_session!
           @seqno += 1
           session.batch_update tx_selector, @seqno,
+                               request_options: request_options,
                                call_options: call_options, &block
         end
 
@@ -577,6 +618,14 @@ module Google
         #   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` (String) 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`.
         # @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:
@@ -609,7 +658,7 @@ module Google
         #   end
         #
         def read table, columns, keys: nil, index: nil, limit: nil,
-                 call_options: nil
+                 request_options: nil, call_options: nil
           ensure_session!
 
           columns = Array(columns).map(&:to_s)
@@ -617,6 +666,7 @@ module Google
 
           session.read table, columns, keys: keys, index: index, limit: limit,
                                        transaction: tx_selector,
+                                       request_options: request_options,
                                        call_options: call_options
         end
 
@@ -641,6 +691,7 @@ module Google
         #   | `BOOL`      | `true`/`false` | |
         #   | `INT64`     | `Integer`      | |
         #   | `FLOAT64`   | `Float`        | |
+        #   | `NUMERIC`   | `BigDecimal`   | |
         #   | `STRING`    | `String`       | |
         #   | `DATE`      | `Date`         | |
         #   | `TIMESTAMP` | `Time`, `DateTime` | |
@@ -687,6 +738,7 @@ module Google
         #   | `BOOL`      | `true`/`false` | |
         #   | `INT64`     | `Integer`      | |
         #   | `FLOAT64`   | `Float`        | |
+        #   | `NUMERIC`   | `BigDecimal`   | |
         #   | `STRING`    | `String`       | |
         #   | `DATE`      | `Date`         | |
         #   | `TIMESTAMP` | `Time`, `DateTime` | |
@@ -732,6 +784,7 @@ module Google
         #   | `BOOL`      | `true`/`false` | |
         #   | `INT64`     | `Integer`      | |
         #   | `FLOAT64`   | `Float`        | |
+        #   | `NUMERIC`   | `BigDecimal`   | |
         #   | `STRING`    | `String`       | |
         #   | `DATE`      | `Date`         | |
         #   | `TIMESTAMP` | `Time`, `DateTime` | |
@@ -779,6 +832,7 @@ module Google
         #   | `BOOL`      | `true`/`false` | |
         #   | `INT64`     | `Integer`      | |
         #   | `FLOAT64`   | `Float`        | |
+        #   | `NUMERIC`   | `BigDecimal`   | |
         #   | `STRING`    | `String`       | |
         #   | `DATE`      | `Date`         | |
         #   | `TIMESTAMP` | `Time`, `DateTime` | |
@@ -880,6 +934,7 @@ module Google
         #   * `:BYTES`
         #   * `:DATE`
         #   * `:FLOAT64`
+        #   * `:NUMERIC`
         #   * `:INT64`
         #   * `:STRING`
         #   * `:TIMESTAMP`