google-cloud-spanner 1.16.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e20c16755d63cea713e0e2b48f0ad0d470e24da1429e8aa1cb62945ee6388ddd
-  data.tar.gz: 347112cc47df35de0d4cbdb24b39447860ba4c6c5f477e46d9bdbb45ab464796
+  metadata.gz: 49b3d879f62998284edf63a941432c67a8caebf708f2ef4df883a3f336dbc758
+  data.tar.gz: e6768ee6037df38c765f888f64a4b29cc192b8a30a1bbcf02d01240c3c228621
 SHA512:
-  metadata.gz: 14ddd7286340c3520e2b1e0bedc018b48ceef0025fe78043f92c91af5af795e7f7eed027f61659fb232135cf45d6f249d083831bb95d960c622f2cf38dbf582e
-  data.tar.gz: 126b39a51fdd3a1673a1a8acd93548ad54ef29938b6dfc793bfd24f728eae6844ade5ca0e6780c3cfeae9aa22a31b307259585b14ec8da65e7e199c7c04393ee
+  metadata.gz: 3c456f4ee2482f6b0c488c749f11b508092b9c2a9befe8a4c44c74d6321c3dc1be43a6abd4cfec56c1ca7d2312feb79998383537ebd20bbe6f3d0be10f6cf576
+  data.tar.gz: b31fad2484409183d77bb00e11ba3526fdb9d5ae6817e8a95af51f61e09d7d3635ac7e58c99fbbb4b862b49a3092d59f7e88505aa86cb509ab1d23447ebfb060

data/AUTHENTICATION.md

@@ -76,7 +76,7 @@ The environment variables that google-cloud-spanner checks for project ID are:
 1. `SPANNER_PROJECT`
 2. `GOOGLE_CLOUD_PROJECT`
 
-The environment variables that google-cloud-spanner checks for credentials are configured on {Google::Cloud::Spanner::V1::Credentials}:
+The environment variables that google-cloud-spanner checks for credentials are configured on `Google::Cloud::Spanner::V1::Spanner::Credentials`:
 
 1. `SPANNER_CREDENTIALS` - Path to JSON file, or JSON contents
 2. `SPANNER_KEYFILE` - Path to JSON file, or JSON contents

data/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Release History
 
+### 2.0.0 / 2020-07-23
+
+This is a major update that removes the "low-level" client interface code, and
+instead adds `google-cloud-spanner-v1`, `google-cloud-spanner-admin-database-v1`,
+and `google-cloud-spanner-admin-instance-v1` as dependencies.
+The new dependencies are rewritten low-level clients, produced by a next-
+generation client code generator, with improved performance and stability.
+
+This change should have no effect on the high-level interface that most users
+will use. The one exception is that the (mostly undocumented) `client_config`
+argument, for adjusting low-level parameters such as RPC retry settings on
+client objects, has been removed. If you need to adjust these parameters, use
+the configuration interface in low-level clients.
+
+Substantial changes have been made in the low-level interfaces, however. If you
+are using the low-level classes under the old `Google::Spanner::V1` module,
+please review the docs for the new `google-cloud-spanner-v1` gem. In particular:
+
+* Some classes have been renamed, notably the client class itself.
+* The client constructor takes a configuration block instead of configuration
+  keyword arguments.
+* All RPC method arguments are now keyword arguments.
+
 ### 1.16.2 / 2020-05-28
 
 #### Documentation

data/lib/google-cloud-spanner.rb

@@ -43,8 +43,6 @@ module Google
     #   * `https://www.googleapis.com/auth/spanner`
     #   * `https://www.googleapis.com/auth/spanner.data`
     # @param [Integer] timeout Default timeout to use in requests. Optional.
-    # @param [Hash] client_config A hash of values to override the default
-    #   behavior of the API client. Optional.
     # @param [String] lib_name Library name. This will be added as a prefix
     #   to the API call tracking header `x-goog-api-client` with provided
     #   lib version for telemetry. Optional. For example prefix looks like
@@ -75,11 +73,9 @@ module Google
     #   platform_scope = "https://www.googleapis.com/auth/cloud-platform"
     #   spanner = gcloud.spanner scope: platform_scope
     #
-    def spanner scope: nil, timeout: nil, client_config: nil, lib_name: nil,
-                lib_version: nil
+    def spanner scope: nil, timeout: nil, lib_name: nil, lib_version: nil
       Google::Cloud.spanner @project, @keyfile, scope: scope,
                                                 timeout: (timeout || @timeout),
-                                                client_config: client_config,
                                                 lib_name: lib_name,
                                                 lib_version: lib_version
     end
@@ -107,8 +103,6 @@ module Google
     #   * `https://www.googleapis.com/auth/spanner`
     #   * `https://www.googleapis.com/auth/spanner.data`
     # @param [Integer] timeout Default timeout to use in requests. Optional.
-    # @param [Hash] client_config A hash of values to override the default
-    #   behavior of the API client. Optional.
     # @param [String] lib_name Library name. This will be added as a prefix
     #   to the API call tracking header `x-goog-api-client` with provided
     #   lib version for telemetry. Optional. For example prefix looks like
@@ -132,13 +126,11 @@ module Google
     #   spanner = Google::Cloud.spanner
     #
     def self.spanner project_id = nil, credentials = nil, scope: nil,
-                     timeout: nil, client_config: nil, lib_name: nil,
-                     lib_version: nil
+                     timeout: nil, lib_name: nil, lib_version: nil
       require "google/cloud/spanner"
       Google::Cloud::Spanner.new project_id: project_id,
                                  credentials: credentials,
                                  scope: scope, timeout: timeout,
-                                 client_config: client_config,
                                  lib_name: lib_name, lib_version: lib_version
     end
   end
@@ -169,16 +161,21 @@ Google::Cloud.configure.add_config! :spanner do |config|
     query_options
   end
 
+  default_scopes = [
+    "https://www.googleapis.com/auth/cloud-platform",
+    "https://www.googleapis.com/auth/spanner.admin",
+    "https://www.googleapis.com/auth/spanner.data"
+  ]
+
   config.add_field! :project_id, default_project, match: String, allow_nil: true
   config.add_alias! :project, :project_id
   config.add_field! :credentials, default_creds,
                     match: [String, Hash, Google::Auth::Credentials],
                     allow_nil: true
   config.add_alias! :keyfile, :credentials
-  config.add_field! :scope, nil, match: [String, Array]
+  config.add_field! :scope, default_scopes, match: [String, Array]
   config.add_field! :timeout, nil, match: Integer
-  config.add_field! :client_config, nil, match: Hash
-  config.add_field! :endpoint, nil, match: String
+  config.add_field! :endpoint, "spanner.googleapis.com", match: String
   config.add_field! :emulator_host, default_emulator, match: String, allow_nil: true
   config.add_field! :lib_name, nil, match: String, allow_nil: true
   config.add_field! :lib_version, nil, match: String, allow_nil: true

data/lib/google/cloud/spanner.rb

@@ -59,8 +59,6 @@ module Google
       #   * `https://www.googleapis.com/auth/spanner`
       #   * `https://www.googleapis.com/auth/spanner.data`
       # @param [Integer] timeout Default timeout to use in requests. Optional.
-      # @param [Hash] client_config A hash of values to override the default
-      #   behavior of the API client. Optional.
       # @param [String] endpoint Override of the endpoint host name. Optional.
       #   If the param is nil, uses the default endpoint.
       # @param [String] project Alias for the `project_id` argument. Deprecated.
@@ -91,12 +89,11 @@ module Google
       #   spanner = Google::Cloud::Spanner.new
       #
       def self.new project_id: nil, credentials: nil, scope: nil, timeout: nil,
-                   client_config: nil, endpoint: nil, project: nil, keyfile: nil,
+                   endpoint: nil, project: nil, keyfile: nil,
                    emulator_host: nil, lib_name: nil, lib_version: nil
         project_id    ||= (project || default_project_id)
         scope         ||= configure.scope
         timeout       ||= configure.timeout
-        client_config ||= configure.client_config
         endpoint      ||= configure.endpoint
         credentials   ||= (keyfile || default_credentials(scope: scope))
         emulator_host ||= configure.emulator_host
@@ -122,8 +119,8 @@ module Google
         Spanner::Project.new(
           Spanner::Service.new(
             project_id, credentials,
-            host: endpoint, timeout: timeout, client_config: client_config,
-            lib_name: lib_name, lib_version: lib_version
+            host: endpoint, timeout: timeout, lib_name: lib_name,
+            lib_version: lib_version
           ),
           query_options: configure.query_options
         )
@@ -145,8 +142,6 @@ module Google
       # * `scope` - (String, Array<String>) The OAuth 2.0 scopes controlling
       #   the set of resources and operations that the connection can access.
       # * `timeout` - (Integer) Default timeout to use in requests.
-      # * `client_config` - (Hash) A hash of values to override the default
-      #   behavior of the API client.
       # * `endpoint` - (String) Override of the endpoint host name, or `nil`
       #   to use the default endpoint.
       # * `emulator_host` - (String) Host name of the emulator. Defaults to
@@ -184,4 +179,7 @@ module Google
       end
     end
   end
+
+  # @private
+  Spanner = Cloud::Spanner unless const_defined? :Spanner
 end

data/lib/google/cloud/spanner/admin/database/credentials.rb

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-require "googleauth"
+require "google/cloud/spanner/admin/database/v1/database_admin/credentials"
 
 module Google
   module Cloud
@@ -23,7 +23,7 @@ module Google
           ##
           # @deprecated Use version-specific credentials classes
           #
-          Credentials = Google::Cloud::Spanner::Admin::Database::V1::Credentials
+          Credentials = V1::DatabaseAdmin::Credentials
         end
       end
     end

data/lib/google/cloud/spanner/admin/instance/credentials.rb

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-require "googleauth"
+require "google/cloud/spanner/admin/instance/v1/instance_admin/credentials"
 
 module Google
   module Cloud
@@ -23,7 +23,7 @@ module Google
           ##
           # @deprecated Use version-specific credentials classes
           #
-          Credentials = Google::Cloud::Spanner::Admin::Instance::V1::Credentials
+          Credentials = V1::InstanceAdmin::Credentials
         end
       end
     end

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

@@ -296,7 +296,7 @@ module Google
         ##
         # @private
         # Creates a new Backup instance from a
-        # {Google::Spanner::Admin::Database::V1::Backup}.
+        # `Google::Cloud::Spanner::Admin::Database::V1::Backup`.
         def self.from_grpc grpc, service
           new grpc, service
         end

data/lib/google/cloud/spanner/backup/job.rb

@@ -53,7 +53,7 @@ module Google
         #
         class Job
           ##
-          # @private The Google::Gax::Operation gRPC object.
+          # @private The `Gapic::Operation` gRPC object.
           attr_accessor :grpc
 
           ##
@@ -260,7 +260,7 @@ module Google
           end
 
           ##
-          # @private New Backup::Job from a Google::Gax::Operation object.
+          # @private New Backup::Job from a `Gapic::Operation` object.
           def self.from_grpc grpc, service
             new.tap do |job|
               job.instance_variable_set :@grpc, grpc

data/lib/google/cloud/spanner/backup/job/list.rb

@@ -146,7 +146,7 @@ module Google
             # @private
             #
             # New Backup::Job::List from a
-            # Google::Gax::PagedEnumerable<Google::Longrunning::Operation>
+            # `Gapic::PagedEnumerable<Google::Longrunning::Operation>`
             # object. Operation object is a backup operation.
             #
             def self.from_grpc grpc, service
@@ -154,7 +154,7 @@ module Google
                 service.databases.instance_variable_get "@operations_client"
               jobs = new(Array(grpc.response.operations).map do |job_grpc|
                 Job.from_grpc \
-                  Google::Gax::Operation.new(job_grpc, operations_client),
+                  Gapic::Operation.new(job_grpc, operations_client),
                   service
               end)
               jobs.grpc = grpc

data/lib/google/cloud/spanner/backup/list.rb

@@ -143,8 +143,7 @@ module Google
           ##
           # @private
           # New Backup::List from a
-          # Google::Gax::PagedEnumerable<Google::Spanner::Admin::Database::\
-          #   V1::Backup>
+          # `Gapic::PagedEnumerable<Google::Cloud::Spanner::Admin::Database::V1::Backup>`
           # object.
           def self.from_grpc grpc, service
             backups = List.new(Array(grpc.response.backups).map do |backup|

data/lib/google/cloud/spanner/backup/restore/job.rb

@@ -53,7 +53,7 @@ module Google
           #
           class Job
             ##
-            # @private The Google::Gax::Operation gRPC object.
+            # @private The `Gapic::Operation` gRPC object.
             attr_accessor :grpc
 
             ##
@@ -231,7 +231,7 @@ module Google
             end
 
             ##
-            # @private New Restore::Job from a Google::Gax::Operation object.
+            # @private New Restore::Job from a `Gapic::Operation` object.
             def self.from_grpc grpc, service
               new.tap do |job|
                 job.instance_variable_set :@grpc, grpc

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

@@ -407,8 +407,8 @@ module Google
         def session
           ensure_service!
           grpc = @project.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: @session_labels
           Session.from_grpc grpc, @project.service, query_options: @query_options

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

@@ -207,7 +207,7 @@ module Google
                               max_partitions: max_partitions
           results.partitions.map do |grpc|
             # Convert partition protos to execute sql request protos
-            execute_sql_grpc = Google::Spanner::V1::ExecuteSqlRequest.new(
+            execute_sql_grpc = V1::ExecuteSqlRequest.new(
               {
                 session: session.path,
                 sql: sql,
@@ -282,7 +282,7 @@ module Google
 
           results.partitions.map do |grpc|
             # Convert partition protos to read request protos
-            read_grpc = Google::Spanner::V1::ReadRequest.new(
+            read_grpc = V1::ReadRequest.new(
               {
                 session: session.path,
                 table: table,
@@ -663,17 +663,15 @@ module Google
         def self.load data, service: nil, query_options: nil
           data = JSON.parse data, symbolize_names: true unless data.is_a? Hash
 
-          session_grpc = Google::Spanner::V1::Session.decode \
-            Base64.decode64(data[:session])
-          transaction_grpc = Google::Spanner::V1::Transaction.decode \
-            Base64.decode64(data[:transaction])
+          session_grpc = V1::Session.decode Base64.decode64(data[:session])
+          transaction_grpc = V1::Transaction.decode Base64.decode64(data[:transaction])
 
           from_grpc transaction_grpc, Session.from_grpc(session_grpc, service, query_options: query_options)
         end
 
         ##
         # @private Creates a new BatchSnapshot instance from a
-        # Google::Spanner::V1::Transaction.
+        # `Google::Cloud::Spanner::V1::Transaction`.
         def self.from_grpc grpc, session
           new grpc, session
         end
@@ -682,7 +680,7 @@ module Google
 
         # The TransactionSelector to be used for queries
         def tx_selector
-          Google::Spanner::V1::TransactionSelector.new id: transaction_id
+          V1::TransactionSelector.new id: transaction_id
         end
 
         ##

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

@@ -155,7 +155,7 @@ module Google
               Convert.to_input_params_and_types params, types
             # param_types is a grpc map field, can't be nil
             converted_types ||= {}
-            Google::Spanner::V1::ExecuteBatchDmlRequest::Statement.new(
+            V1::ExecuteBatchDmlRequest::Statement.new(
               sql: sql,
               params: converted_params,
               param_types: converted_types

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

@@ -1336,8 +1336,8 @@ module Google
         def create_new_session
           ensure_service!
           grpc = @project.service.create_session \
-            Admin::Database::V1::DatabaseAdminClient.database_path(
-              project_id, instance_id, database_id
+            Admin::Database::V1::DatabaseAdmin::Paths.database_path(
+              project: project_id, instance: instance_id, database: database_id
             ),
             labels: @session_labels
           Session.from_grpc grpc, @project.service, query_options: @query_options
@@ -1364,8 +1364,8 @@ module Google
         def batch_create_sessions session_count
           ensure_service!
           resp = @project.service.batch_create_sessions \
-            Admin::Database::V1::DatabaseAdminClient.database_path(
-              project_id, instance_id, database_id
+            Admin::Database::V1::DatabaseAdmin::Paths.database_path(
+              project: project_id, instance: instance_id, database: database_id
             ),
             session_count,
             labels: @session_labels
@@ -1421,9 +1421,9 @@ module Google
           bounded_staleness = Convert.number_to_duration \
             opts[:bounded_staleness] || opts[:max_staleness]
 
-          Google::Spanner::V1::TransactionSelector.new(single_use:
-            Google::Spanner::V1::TransactionOptions.new(read_only:
-              Google::Spanner::V1::TransactionOptions::ReadOnly.new({
+          V1::TransactionSelector.new(single_use:
+            V1::TransactionOptions.new(read_only:
+              V1::TransactionOptions::ReadOnly.new({
                 strong: opts[:strong],
                 read_timestamp: exact_timestamp,
                 exact_staleness: exact_staleness,
@@ -1435,7 +1435,7 @@ module Google
 
         def pdml_transaction session
           pdml_tx_grpc = @project.service.create_pdml session.path
-          Google::Spanner::V1::TransactionSelector.new id: pdml_tx_grpc.id
+          V1::TransactionSelector.new id: pdml_tx_grpc.id
         end
 
         ##

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

@@ -96,8 +96,8 @@ module Google
           rows.delete_if(&:nil?)
           rows.delete_if(&:empty?)
           @mutations += rows.map do |row|
-            Google::Spanner::V1::Mutation.new(
-              insert_or_update: Google::Spanner::V1::Mutation::Write.new(
+            V1::Mutation.new(
+              insert_or_update: V1::Mutation::Write.new(
                 table: table, columns: row.keys.map(&:to_s),
                 values: [Convert.object_to_grpc_value(row.values).list_value]
               )
@@ -154,8 +154,8 @@ module Google
           rows.delete_if(&:nil?)
           rows.delete_if(&:empty?)
           @mutations += rows.map do |row|
-            Google::Spanner::V1::Mutation.new(
-              insert: Google::Spanner::V1::Mutation::Write.new(
+            V1::Mutation.new(
+              insert: V1::Mutation::Write.new(
                 table: table, columns: row.keys.map(&:to_s),
                 values: [Convert.object_to_grpc_value(row.values).list_value]
               )
@@ -211,8 +211,8 @@ module Google
           rows.delete_if(&:nil?)
           rows.delete_if(&:empty?)
           @mutations += rows.map do |row|
-            Google::Spanner::V1::Mutation.new(
-              update: Google::Spanner::V1::Mutation::Write.new(
+            V1::Mutation.new(
+              update: V1::Mutation::Write.new(
                 table: table, columns: row.keys.map(&:to_s),
                 values: [Convert.object_to_grpc_value(row.values).list_value]
               )
@@ -270,8 +270,8 @@ module Google
           rows.delete_if(&:nil?)
           rows.delete_if(&:empty?)
           @mutations += rows.map do |row|
-            Google::Spanner::V1::Mutation.new(
-              replace: Google::Spanner::V1::Mutation::Write.new(
+            V1::Mutation.new(
+              replace: V1::Mutation::Write.new(
                 table: table, columns: row.keys.map(&:to_s),
                 values: [Convert.object_to_grpc_value(row.values).list_value]
               )
@@ -306,8 +306,8 @@ module Google
         #
         def delete table, keys = []
           @mutations += [
-            Google::Spanner::V1::Mutation.new(
-              delete: Google::Spanner::V1::Mutation::Delete.new(
+            V1::Mutation.new(
+              delete: V1::Mutation::Delete.new(
                 table: table, key_set: key_set(keys)
               )
             )
@@ -323,20 +323,20 @@ module Google
         protected
 
         def key_set keys
-          return Google::Spanner::V1::KeySet.new all: true if keys.nil?
+          return V1::KeySet.new all: true if keys.nil?
           keys = [keys] unless keys.is_a? Array
-          return Google::Spanner::V1::KeySet.new all: true if keys.empty?
+          return V1::KeySet.new all: true if keys.empty?
           if keys_are_ranges? keys
             key_ranges = keys.map do |r|
               Convert.to_key_range r
             end
-            return Google::Spanner::V1::KeySet.new ranges: key_ranges
+            return V1::KeySet.new ranges: key_ranges
           end
           key_list = keys.map do |key|
             key = [key] unless key.is_a? Array
             Convert.object_to_grpc_value(key).list_value
           end
-          Google::Spanner::V1::KeySet.new keys: key_list
+          V1::KeySet.new keys: key_list
         end
 
         def keys_are_ranges? keys