google-cloud-spanner 1.14.0 → 2.0.0

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

@@ -42,17 +42,22 @@ module Google
       #
       class Session
         ##
-        # @private The Google::Spanner::V1::Session object
+        # @private The `Google::Cloud::Spanner::V1::Session` object
         attr_accessor :grpc
 
         ##
         # @private The gRPC Service object.
         attr_accessor :service
 
+        ##
+        # @private The hash of query options.
+        attr_accessor :query_options
+
         # @private Creates a new Session instance.
-        def initialize grpc, service
+        def initialize grpc, service, query_options: nil
           @grpc = grpc
           @service = service
+          @query_options = query_options
         end
 
         # The unique identifier for the project.
@@ -145,11 +150,18 @@ module Google
         #     specified using a {Fields} object.
         #
         #   Types are optional.
-        # @param [Google::Spanner::V1::TransactionSelector] transaction The
+        # @param [Google::Cloud::Spanner::V1::TransactionSelector] transaction The
         #   transaction selector value to send. Only used for single-use
         #   transactions.
         # @param [Integer] seqno A per-transaction sequence number used to
         #   identify this request.
+        # @param [Hash] query_options A hash of values to specify the custom
+        #   query options for executing SQL query. Query options are optional.
+        #   The following settings can be provided:
+        #
+        #   * `:optimizer_version` (String) The version of optimizer to use.
+        #     Empty to use database default. "latest" to use the latest
+        #     available optimizer version.
         #
         # @return [Google::Cloud::Spanner::Results] The results of the query
         #   execution.
@@ -249,16 +261,35 @@ module Google
         #     puts "User #{row[:id]} is #{row[:name]}"
         #   end
         #
+        # @example Query using query options:
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   results = db.execute_query \
+        #     "SELECT * FROM users", query_options: { optimizer_version: "1" }
+        #
+        #   results.rows.each do |row|
+        #     puts "User #{row[:id]} is #{row[:name]}"
+        #   end
+        #
         def execute_query sql, params: nil, types: nil, transaction: nil,
-                          partition_token: nil, seqno: nil
+                          partition_token: nil, seqno: nil, query_options: nil
           ensure_service!
-
+          if query_options.nil?
+            query_options = @query_options
+          else
+            query_options = @query_options.merge query_options unless @query_options.nil?
+          end
           results = Results.execute_query service, path, sql,
                                           params: params,
                                           types: types,
                                           transaction: transaction,
                                           partition_token: partition_token,
-                                          seqno: seqno
+                                          seqno: seqno,
+                                          query_options: query_options
           @last_updated_at = Time.now
           results
         end
@@ -266,7 +297,7 @@ module Google
         ##
         # Executes DML statements in a batch.
         #
-        # @param [Google::Spanner::V1::TransactionSelector] transaction The
+        # @param [Google::Cloud::Spanner::V1::TransactionSelector] transaction The
         #   transaction selector value to send. Only used for single-use
         #   transactions.
         # @param [Integer] seqno A per-transaction sequence number used to
@@ -315,7 +346,7 @@ 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 [Google::Spanner::V1::TransactionSelector] transaction The
+        # @param [Google::Cloud::Spanner::V1::TransactionSelector] transaction The
         #   transaction selector value to send. Only used for single-use
         #   transactions.
         #
@@ -644,8 +675,8 @@ module Google
         rescue Google::Cloud::NotFoundError
           labels = @grpc.labels.to_h unless @grpc.labels.to_h.empty?
           @grpc = service.create_session \
-            Admin::Database::V1::DatabaseAdminClient.database_path(
-              project_id, instance_id, database_id
+            V1::Spanner::Paths.database_path(
+              project: project_id, instance: instance_id, database: database_id
             ),
             labels: labels
           @last_updated_at = Time.now
@@ -662,8 +693,8 @@ module Google
         rescue Google::Cloud::NotFoundError
           labels = @grpc.labels.to_h unless @grpc.labels.to_h.empty?
           @grpc = service.create_session \
-            Admin::Database::V1::DatabaseAdminClient.database_path(
-              project_id, instance_id, database_id
+            V1::Spanner::Paths.database_path(
+              project: project_id, instance: instance_id, database: database_id
             ),
             labels: labels
           false
@@ -687,9 +718,9 @@ module Google
 
         ##
         # @private Creates a new Session instance from a
-        # Google::Spanner::V1::Session.
-        def self.from_grpc grpc, service
-          new grpc, service
+        # `Google::Cloud::Spanner::V1::Session`.
+        def self.from_grpc grpc, service, query_options: nil
+          new grpc, service, query_options: query_options
         end
 
         ##

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

@@ -118,6 +118,14 @@ module Google
         #     specified using a {Fields} object.
         #
         #   Types are optional.
+        # @param [Hash] query_options A hash of values to specify the custom
+        #   query options for executing SQL query. Query options are optional.
+        #   The following settings can be provided:
+        #
+        #   * `:optimizer_version` (String) The version of optimizer to use.
+        #     Empty to use database default. "latest" to use the latest
+        #     available optimizer version.
+        #
         # @return [Google::Cloud::Spanner::Results] The results of the query
         #   execution.
         #
@@ -220,13 +228,28 @@ module Google
         #     end
         #   end
         #
-        def execute_query sql, params: nil, types: nil
+        # @example Query using query options:
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   db.snapshot do |snp|
+        #     results = snp.execute_query \
+        #       "SELECT * FROM users", query_options: { optimizer_version: "1" }
+        #
+        #     results.rows.each do |row|
+        #       puts "User #{row[:id]} is #{row[:name]}"
+        #     end
+        #   end
+        #
+        def execute_query sql, params: nil, types: nil, query_options: nil
           ensure_session!
 
           params, types = Convert.to_input_params_and_types params, types
-
           session.execute_query sql, params: params, types: types,
-                                     transaction: tx_selector
+                                     transaction: tx_selector,
+                                     query_options: query_options
         end
         alias execute execute_query
         alias query execute_query
@@ -391,7 +414,7 @@ module Google
 
         ##
         # @private Creates a new Snapshot instance from a
-        # Google::Spanner::V1::Transaction.
+        # `Google::Cloud::Spanner::V1::Transaction`.
         def self.from_grpc grpc, session
           new.tap do |s|
             s.instance_variable_set :@grpc,    grpc
@@ -404,7 +427,7 @@ module Google
         # The TransactionSelector to be used for queries
         def tx_selector
           return nil if transaction_id.nil?
-          Google::Spanner::V1::TransactionSelector.new id: transaction_id
+          V1::TransactionSelector.new id: transaction_id
         end
 
         ##

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

@@ -148,6 +148,14 @@ module Google
         #     specified using a {Fields} object.
         #
         #   Types are optional.
+        # @param [Hash] query_options A hash of values to specify the custom
+        #   query options for executing SQL query. Query options are optional.
+        #   The following settings can be provided:
+        #
+        #   * `:optimizer_version` (String) The version of optimizer to use.
+        #     Empty to use database default. "latest" to use the latest
+        #     available optimizer version.
+        #
         # @return [Google::Cloud::Spanner::Results] The results of the query
         #   execution.
         #
@@ -251,15 +259,30 @@ module Google
         #     end
         #   end
         #
-        def execute_query sql, params: nil, types: nil
+        # @example Query using query options:
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   db.transaction do |tx|
+        #     results = tx.execute_query \
+        #       "SELECT * FROM users", query_options: { optimizer_version: "1" }
+        #
+        #     results.rows.each do |row|
+        #       puts "User #{row[:id]} is #{row[:name]}"
+        #     end
+        #   end
+        #
+        def execute_query sql, params: nil, types: nil, query_options: nil
           ensure_session!
 
           @seqno += 1
 
           params, types = Convert.to_input_params_and_types params, types
-
           session.execute_query sql, params: params, types: types,
-                                     transaction: tx_selector, seqno: @seqno
+                                     transaction: tx_selector, seqno: @seqno,
+                                     query_options: query_options
         end
         alias execute execute_query
         alias query execute_query
@@ -322,6 +345,13 @@ module Google
         #     `[:INT64]`.
         #   * {Fields} - Nested Structs are specified by providing a Fields
         #     object.
+        # @param [Hash] query_options A hash of values to specify the custom
+        #   query options for executing SQL query. Query options are optional.
+        #   The following settings can be provided:
+        #
+        #   * `:optimizer_version` (String) The version of optimizer to use.
+        #     Empty to use database default. "latest" to use the latest
+        #     available optimizer version.
         #
         # @return [Integer] The exact number of rows that were modified.
         #
@@ -350,8 +380,22 @@ module Google
         #     )
         #   end
         #
-        def execute_update sql, params: nil, types: nil
-          results = execute_query sql, params: params, types: types
+        # @example Update using query options
+        #   require "google/cloud/spanner"
+        #
+        #   spanner = Google::Cloud::Spanner.new
+        #   db = spanner.client "my-instance", "my-database"
+        #
+        #   db.transaction do |tx|
+        #     row_count = tx.execute_update(
+        #       "UPDATE users SET name = 'Charlie' WHERE id = 1",
+        #       query_options: { optimizer_version: "1" }
+        #     )
+        #   end
+        #
+        def execute_update sql, params: nil, types: nil, query_options: nil
+          results = execute_query sql, params: params, types: types,
+                                  query_options: query_options
           # Stream all PartialResultSet to get ResultSetStats
           results.rows.to_a
           # Raise an error if there is not a row count returned
@@ -876,7 +920,7 @@ module Google
 
         ##
         # @private Creates a new Transaction instance from a
-        # Google::Spanner::V1::Transaction.
+        # `Google::Cloud::Spanner::V1::Transaction`.
         def self.from_grpc grpc, session
           new.tap do |s|
             s.instance_variable_set :@grpc,    grpc
@@ -889,7 +933,7 @@ module Google
         # The TransactionSelector to be used for queries
         def tx_selector
           return nil if transaction_id.nil?
-          Google::Spanner::V1::TransactionSelector.new id: transaction_id
+          V1::TransactionSelector.new id: transaction_id
         end
 
         ##

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-spanner
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-18 00:00:00.000000000 Z
+date: 2020-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -17,82 +17,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: google-gax
+  name: google-cloud-spanner-admin-database-v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: googleapis-common-protos
+  name: google-cloud-spanner-admin-instance-v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.9
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.3.9
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: googleapis-common-protos-types
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.4
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.4
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: grpc-google-iam-v1
+  name: google-cloud-spanner-v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.9
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.9
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -127,14 +101,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.14'
 - !ruby/object:Gem::Dependency
   name: minitest-autotest
   requirement: !ruby/object:Gem::Requirement
@@ -253,14 +227,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.0
+        version: 1.28.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.0
+        version: 1.28.0
 - !ruby/object:Gem::Dependency
   name: grpc-tools
   requirement: !ruby/object:Gem::Requirement
@@ -295,37 +269,13 @@ files:
 - TROUBLESHOOTING.md
 - lib/google-cloud-spanner.rb
 - lib/google/cloud/spanner.rb
-- lib/google/cloud/spanner/admin/database.rb
 - lib/google/cloud/spanner/admin/database/credentials.rb
-- lib/google/cloud/spanner/admin/database/v1.rb
-- lib/google/cloud/spanner/admin/database/v1/credentials.rb
-- lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb
-- lib/google/cloud/spanner/admin/database/v1/database_admin_client_config.json
-- lib/google/cloud/spanner/admin/database/v1/doc/google/iam/v1/iam_policy.rb
-- lib/google/cloud/spanner/admin/database/v1/doc/google/iam/v1/options.rb
-- lib/google/cloud/spanner/admin/database/v1/doc/google/iam/v1/policy.rb
-- lib/google/cloud/spanner/admin/database/v1/doc/google/longrunning/operations.rb
-- lib/google/cloud/spanner/admin/database/v1/doc/google/protobuf/any.rb
-- lib/google/cloud/spanner/admin/database/v1/doc/google/protobuf/empty.rb
-- lib/google/cloud/spanner/admin/database/v1/doc/google/rpc/status.rb
-- lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/spanner_database_admin.rb
-- lib/google/cloud/spanner/admin/database/v1/doc/google/type/expr.rb
-- lib/google/cloud/spanner/admin/instance.rb
 - lib/google/cloud/spanner/admin/instance/credentials.rb
-- lib/google/cloud/spanner/admin/instance/v1.rb
-- lib/google/cloud/spanner/admin/instance/v1/credentials.rb
-- lib/google/cloud/spanner/admin/instance/v1/doc/google/iam/v1/iam_policy.rb
-- lib/google/cloud/spanner/admin/instance/v1/doc/google/iam/v1/options.rb
-- lib/google/cloud/spanner/admin/instance/v1/doc/google/iam/v1/policy.rb
-- lib/google/cloud/spanner/admin/instance/v1/doc/google/longrunning/operations.rb
-- lib/google/cloud/spanner/admin/instance/v1/doc/google/protobuf/any.rb
-- lib/google/cloud/spanner/admin/instance/v1/doc/google/protobuf/empty.rb
-- lib/google/cloud/spanner/admin/instance/v1/doc/google/protobuf/field_mask.rb
-- lib/google/cloud/spanner/admin/instance/v1/doc/google/rpc/status.rb
-- lib/google/cloud/spanner/admin/instance/v1/doc/google/spanner/admin/instance/v1/spanner_instance_admin.rb
-- lib/google/cloud/spanner/admin/instance/v1/doc/google/type/expr.rb
-- lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb
-- lib/google/cloud/spanner/admin/instance/v1/instance_admin_client_config.json
+- lib/google/cloud/spanner/backup.rb
+- lib/google/cloud/spanner/backup/job.rb
+- lib/google/cloud/spanner/backup/job/list.rb
+- lib/google/cloud/spanner/backup/list.rb
+- lib/google/cloud/spanner/backup/restore/job.rb
 - lib/google/cloud/spanner/batch_client.rb
 - lib/google/cloud/spanner/batch_snapshot.rb
 - lib/google/cloud/spanner/batch_update.rb
@@ -336,8 +286,11 @@ files:
 - lib/google/cloud/spanner/credentials.rb
 - lib/google/cloud/spanner/data.rb
 - lib/google/cloud/spanner/database.rb
+- lib/google/cloud/spanner/database/backup_info.rb
 - lib/google/cloud/spanner/database/job.rb
+- lib/google/cloud/spanner/database/job/list.rb
 - lib/google/cloud/spanner/database/list.rb
+- lib/google/cloud/spanner/database/restore_info.rb
 - lib/google/cloud/spanner/errors.rb
 - lib/google/cloud/spanner/fields.rb
 - lib/google/cloud/spanner/instance.rb
@@ -356,36 +309,7 @@ files:
 - lib/google/cloud/spanner/snapshot.rb
 - lib/google/cloud/spanner/status.rb
 - lib/google/cloud/spanner/transaction.rb
-- lib/google/cloud/spanner/v1.rb
-- lib/google/cloud/spanner/v1/credentials.rb
-- lib/google/cloud/spanner/v1/doc/google/protobuf/any.rb
-- lib/google/cloud/spanner/v1/doc/google/protobuf/duration.rb
-- lib/google/cloud/spanner/v1/doc/google/protobuf/empty.rb
-- lib/google/cloud/spanner/v1/doc/google/protobuf/struct.rb
-- lib/google/cloud/spanner/v1/doc/google/protobuf/timestamp.rb
-- lib/google/cloud/spanner/v1/doc/google/rpc/status.rb
-- lib/google/cloud/spanner/v1/doc/google/spanner/v1/keys.rb
-- lib/google/cloud/spanner/v1/doc/google/spanner/v1/mutation.rb
-- lib/google/cloud/spanner/v1/doc/google/spanner/v1/query_plan.rb
-- lib/google/cloud/spanner/v1/doc/google/spanner/v1/result_set.rb
-- lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb
-- lib/google/cloud/spanner/v1/doc/google/spanner/v1/transaction.rb
-- lib/google/cloud/spanner/v1/doc/google/spanner/v1/type.rb
-- lib/google/cloud/spanner/v1/spanner_client.rb
-- lib/google/cloud/spanner/v1/spanner_client_config.json
 - lib/google/cloud/spanner/version.rb
-- lib/google/spanner/admin/database/v1/spanner_database_admin_pb.rb
-- lib/google/spanner/admin/database/v1/spanner_database_admin_services_pb.rb
-- lib/google/spanner/admin/instance/v1/spanner_instance_admin_pb.rb
-- lib/google/spanner/admin/instance/v1/spanner_instance_admin_services_pb.rb
-- lib/google/spanner/v1/keys_pb.rb
-- lib/google/spanner/v1/mutation_pb.rb
-- lib/google/spanner/v1/query_plan_pb.rb
-- lib/google/spanner/v1/result_set_pb.rb
-- lib/google/spanner/v1/spanner_pb.rb
-- lib/google/spanner/v1/spanner_services_pb.rb
-- lib/google/spanner/v1/transaction_pb.rb
-- lib/google/spanner/v1/type_pb.rb
 homepage: https://github.com/googleapis/google-cloud-ruby/tree/master/google-cloud-spanner
 licenses:
 - Apache-2.0
@@ -405,7 +329,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Spanner API