google-cloud-spanner 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a644a78d0458b414ee8e19707abfe33b7d34b730af57feb623053929120d9425
-  data.tar.gz: db692fd3ac651dea2aaa178e4d6a117bb790cb10fb4571a0f991d940a8d558db
+  metadata.gz: d3ee5ad839567f029c785341f244eb62658f9091b21c80726d01818e9dc3a101
+  data.tar.gz: 0053e507b34ab229c633a813fdf06cd178b59ede0837cfe80eb5585441b05bac
 SHA512:
-  metadata.gz: bfbc02dc59071018e559f8062b43dfa3dbd2700ee9da873abce56cdb44ca7a987465e3a567a592f3944a5b16d7995516b34d92be3bf30f810258b5b5c8d6c911
-  data.tar.gz: eb58bcc4cf290b9419fa7ecd627898014f39eed6e18150236e7a62a1623fdbd16f4f8cf135cb483c6f278032f83b019a9ea6478814658a9aa8dd58b9a6fc0b78
+  metadata.gz: dff7a09f65d4365463441c63a743983ea7df392f7d42e7cdaf854890318a6b6b5067a193fbf292ac48e001e6a1eaa9df0d55b99193baa77178b9382479c8f7e4
+  data.tar.gz: da5288b36a9b8dc7c1dc26d6b92d51198f0acdea029ad2c9519f45671cb3f251d04e7b78562f1e87545ba825aa17e940d73a87b7b52fdd77b792630abbe6d17b

data/lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb

@@ -73,6 +73,7 @@ module Google
                 "https://www.googleapis.com/auth/spanner.admin"
               ].freeze
 
+              # @private
               class OperationsClient < Google::Longrunning::OperationsClient
                 SERVICE_ADDRESS = SERVICE_ADDRESS
               end

data/lib/google/cloud/spanner/admin/instance/v1/instance_admin_client.rb

@@ -93,6 +93,7 @@ module Google
                 "https://www.googleapis.com/auth/spanner.admin"
               ].freeze
 
+              # @private
               class OperationsClient < Google::Longrunning::OperationsClient
                 SERVICE_ADDRESS = SERVICE_ADDRESS
               end

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

@@ -33,8 +33,7 @@ module Google
       # request can then be executed independently over each partition while
       # observing the same snapshot of the database. A BatchSnapshot can also be
       # shared across multiple processes/machines by passing around its
-      # serialized value and then recreating the transaction using
-      # {BatchClient#dump}.
+      # serialized value and then recreating the transaction using {#dump}.
       #
       # Unlike locking read-write transactions, BatchSnapshot will never abort.
       # They can fail if the chosen read timestamp is garbage collected; however
@@ -291,7 +290,7 @@ module Google
         end
 
         ##
-        # Execute the partition to return a {ResultSet}. The result returned
+        # Execute the partition to return a {Results}. The result returned
         # could be zero or more rows. The row metadata may be absent if no rows
         # are returned.
         #

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

@@ -701,10 +701,10 @@ module Google
         # accepts only mutations and makes a single API request.
         #
         # **Note:** This method does not feature replay protection present in
-        # {Transaction#commit} (See {#transaction}). This method makes a single
-        # RPC, whereas {Transaction#commit} requires two RPCs (one of which may
-        # be performed in advance), and so this method may be appropriate for
-        # latency sensitive and/or high throughput blind changes.
+        # {#transaction}. This method makes a single RPC, whereas {#transaction}
+        # requires two RPCs (one of which may be performed in advance), and so
+        # this method may be appropriate for latency sensitive and/or high
+        # throughput blind changes.
         #
         # @yield [commit] The block for mutating the data.
         # @yieldparam [Google::Cloud::Spanner::Commit] commit The Commit object.

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

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 
-require "googleauth"
+require "google/cloud/spanner/v1/credentials"
 
 module Google
   module Cloud
@@ -37,21 +37,7 @@ module Google
       #
       #   spanner.project_id #=> "my-project"
       #
-      class Credentials < Google::Auth::Credentials
-        SCOPE = %w[https://www.googleapis.com/auth/cloud-platform
-                   https://www.googleapis.com/auth/spanner.data].freeze
-        PATH_ENV_VARS = %w[SPANNER_CREDENTIALS
-                           SPANNER_KEYFILE
-                           GOOGLE_CLOUD_CREDENTIALS
-                           GOOGLE_CLOUD_KEYFILE
-                           GCLOUD_KEYFILE].freeze
-        JSON_ENV_VARS = %w[SPANNER_CREDENTIALS_JSON
-                           SPANNER_KEYFILE_JSON
-                           GOOGLE_CLOUD_CREDENTIALS_JSON
-                           GOOGLE_CLOUD_KEYFILE_JSON
-                           GCLOUD_KEYFILE_JSON].freeze
-        DEFAULT_PATHS = \
-          ["~/.config/gcloud/application_default_credentials.json"].freeze
+      class Credentials < Google::Cloud::Spanner::V1::Credentials
       end
     end
   end

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

@@ -150,7 +150,7 @@ module Google
             end)
             databases.instance_variable_set :@instance_id, instance_id
             token = grpc.next_page_token
-            token = nil if token == ""
+            token = nil if token == "".freeze
             databases.instance_variable_set :@token,   token
             databases.instance_variable_set :@service, service
             databases.instance_variable_set :@max,     max

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

@@ -245,7 +245,7 @@ module Google
         #     puts database.database_id
         #   end
         #
-        # @example Retrieve all: (See {Instance::Config::List::List#all})
+        # @example Retrieve all: (See {Instance::Config::List#all})
         #   require "google/cloud/spanner"
         #
         #   spanner = Google::Cloud::Spanner.new

data/lib/google/cloud/spanner/instance/config/list.rb

@@ -149,7 +149,7 @@ module Google
                 Instance::Config.from_grpc config
               end)
               token = grpc.next_page_token
-              token = nil if token == ""
+              token = nil if token == "".freeze
               configs.instance_variable_set :@token,   token
               configs.instance_variable_set :@service, service
               configs.instance_variable_set :@max,     max

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

@@ -146,7 +146,7 @@ module Google
               Instance.from_grpc instance, service
             end)
             token = grpc.next_page_token
-            token = nil if token == ""
+            token = nil if token == "".freeze
             instances.instance_variable_set :@token,   token
             instances.instance_variable_set :@service, service
             instances.instance_variable_set :@max,     max

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

@@ -115,7 +115,7 @@ module Google
         #     puts instance.instance_id
         #   end
         #
-        # @example Retrieve all: (See {Instance::Config::List::List#all})
+        # @example Retrieve all: (See {Instance::Config::List#all})
         #   require "google/cloud/spanner"
         #
         #   spanner = Google::Cloud::Spanner.new
@@ -249,7 +249,7 @@ module Google
         #     puts config.instance_config_id
         #   end
         #
-        # @example Retrieve all: (See {Instance::Config::List::List#all})
+        # @example Retrieve all: (See {Instance::Config::List#all})
         #   require "google/cloud/spanner"
         #
         #   spanner = Google::Cloud::Spanner.new
@@ -318,7 +318,7 @@ module Google
         #     puts database.database_id
         #   end
         #
-        # @example Retrieve all: (See {Instance::Config::List::List#all})
+        # @example Retrieve all: (See {Instance::Config::List#all})
         #   require "google/cloud/spanner"
         #
         #   spanner = Google::Cloud::Spanner.new

data/lib/google/cloud/spanner/v1/credentials.rb

@@ -0,0 +1,41 @@
+# Copyright 2018 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "googleauth"
+
+module Google
+  module Cloud
+    module Spanner
+      module V1
+        class Credentials < Google::Auth::Credentials
+          SCOPE = [
+            "https://www.googleapis.com/auth/cloud-platform",
+            "https://www.googleapis.com/auth/spanner.data"
+          ].freeze
+          PATH_ENV_VARS = %w(SPANNER_CREDENTIALS
+                             SPANNER_KEYFILE
+                             GOOGLE_CLOUD_CREDENTIALS
+                             GOOGLE_CLOUD_KEYFILE
+                             GCLOUD_KEYFILE)
+          JSON_ENV_VARS = %w(SPANNER_CREDENTIALS_JSON
+                             SPANNER_KEYFILE_JSON
+                             GOOGLE_CLOUD_CREDENTIALS_JSON
+                             GOOGLE_CLOUD_KEYFILE_JSON
+                             GCLOUD_KEYFILE_JSON)
+          DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"]
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/spanner/v1/doc/google/protobuf/empty.rb

@@ -0,0 +1,28 @@
+# Copyright 2018 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Protobuf
+    # A generic empty message that you can re-use to avoid defining duplicated
+    # empty messages in your APIs. A typical example is to use it as the request
+    # or the response type of an API method. For instance:
+    #
+    #     service Foo {
+    #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+    #     }
+    #
+    # The JSON representation for +Empty+ is empty JSON object +{}+.
+    class Empty; end
+  end
+end

data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/mutation.rb

@@ -73,6 +73,8 @@ module Google
         # @!attribute [rw] key_set
         #   @return [Google::Spanner::V1::KeySet]
         #     Required. The primary keys of the rows within {Google::Spanner::V1::Mutation::Delete#table table} to delete.
+        #     Delete is idempotent. The transaction will succeed even if some or all
+        #     rows do not exist.
         class Delete; end
       end
     end

data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/spanner.rb

@@ -14,17 +14,6 @@
 
 module Google
   module Spanner
-    ##
-    # # Cloud Spanner API Contents
-    #
-    # | Class | Description |
-    # | ----- | ----------- |
-    # | [SpannerClient][] | Cloud Spanner API |
-    # | [Data Types][] | Data types for Google::Cloud::Spanner::V1 |
-    #
-    # [SpannerClient]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-spanner/latest/google/spanner/v1/spannerclient
-    # [Data Types]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-spanner/latest/google/spanner/v1/datatypes
-    #
     module V1
       # The request for {Google::Spanner::V1::Spanner::CreateSession CreateSession}.
       # @!attribute [rw] database
@@ -188,11 +177,17 @@ module Google
       # PartitionReadRequest.
       # @!attribute [rw] partition_size_bytes
       #   @return [Integer]
+      #     **Note:** This hint is currently ignored by PartitionQuery and
+      #     PartitionRead requests.
+      #
       #     The desired data size for each partition generated.  The default for this
       #     option is currently 1 GiB.  This is only a hint. The actual size of each
       #     partition may be smaller or larger than this size request.
       # @!attribute [rw] max_partitions
       #   @return [Integer]
+      #     **Note:** This hint is currently ignored by PartitionQuery and
+      #     PartitionRead requests.
+      #
       #     The desired maximum number of partitions to return.  For example, this may
       #     be set to the number of workers available.  The default for this option
       #     is currently 10,000. The maximum value is currently 200,000.  This is only

data/lib/google/cloud/spanner/v1/doc/google/spanner/v1/type.rb

@@ -0,0 +1,110 @@
+# Copyright 2018 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Spanner
+    module V1
+      # +Type+ indicates the type of a Cloud Spanner value, as might be stored in a
+      # table cell or returned from an SQL query.
+      # @!attribute [rw] code
+      #   @return [Google::Spanner::V1::TypeCode]
+      #     Required. The {Google::Spanner::V1::TypeCode TypeCode} for this type.
+      # @!attribute [rw] array_element_type
+      #   @return [Google::Spanner::V1::Type]
+      #     If {Google::Spanner::V1::Type#code code} == {Google::Spanner::V1::TypeCode::ARRAY ARRAY}, then +array_element_type+
+      #     is the type of the array elements.
+      # @!attribute [rw] struct_type
+      #   @return [Google::Spanner::V1::StructType]
+      #     If {Google::Spanner::V1::Type#code code} == {Google::Spanner::V1::TypeCode::STRUCT STRUCT}, then +struct_type+
+      #     provides type information for the struct's fields.
+      class Type; end
+
+      # +StructType+ defines the fields of a {Google::Spanner::V1::TypeCode::STRUCT STRUCT} type.
+      # @!attribute [rw] fields
+      #   @return [Array<Google::Spanner::V1::StructType::Field>]
+      #     The list of fields that make up this struct. Order is
+      #     significant, because values of this struct type are represented as
+      #     lists, where the order of field values matches the order of
+      #     fields in the {Google::Spanner::V1::StructType StructType}. In turn, the order of fields
+      #     matches the order of columns in a read request, or the order of
+      #     fields in the +SELECT+ clause of a query.
+      class StructType
+        # Message representing a single field of a struct.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     The name of the field. For reads, this is the column name. For
+        #     SQL queries, it is the column alias (e.g., +"Word"+ in the
+        #     query +"SELECT 'hello' AS Word"+), or the column name (e.g.,
+        #     +"ColName"+ in the query +"SELECT ColName FROM Table"+). Some
+        #     columns might have an empty name (e.g., !"SELECT
+        #     UPPER(ColName)"+). Note that a query result can contain
+        #     multiple fields with the same name.
+        # @!attribute [rw] type
+        #   @return [Google::Spanner::V1::Type]
+        #     The type of the field.
+        class Field; end
+      end
+
+      # +TypeCode+ is used as part of {Google::Spanner::V1::Type Type} to
+      # indicate the type of a Cloud Spanner value.
+      #
+      # Each legal value of a type can be encoded to or decoded from a JSON
+      # value, using the encodings described below. All Cloud Spanner values can
+      # be +null+, regardless of type; +null+s are always encoded as a JSON
+      # +null+.
+      module TypeCode
+        # Not specified.
+        TYPE_CODE_UNSPECIFIED = 0
+
+        # Encoded as JSON +true+ or +false+.
+        BOOL = 1
+
+        # Encoded as +string+, in decimal format.
+        INT64 = 2
+
+        # Encoded as +number+, or the strings +"NaN"+, +"Infinity"+, or
+        # +"-Infinity"+.
+        FLOAT64 = 3
+
+        # Encoded as +string+ in RFC 3339 timestamp format. The time zone
+        # must be present, and must be +"Z"+.
+        #
+        # If the schema has the column option
+        # +allow_commit_timestamp=true+, the placeholder string
+        # +"spanner.commit_timestamp()"+ can be used to instruct the system
+        # to insert the commit timestamp associated with the transaction
+        # commit.
+        TIMESTAMP = 4
+
+        # Encoded as +string+ in RFC 3339 date format.
+        DATE = 5
+
+        # Encoded as +string+.
+        STRING = 6
+
+        # Encoded as a base64-encoded +string+, as described in RFC 4648,
+        # section 4.
+        BYTES = 7
+
+        # Encoded as +list+, where the list elements are represented
+        # according to {Google::Spanner::V1::Type#array_element_type array_element_type}.
+        ARRAY = 8
+
+        # Encoded as +list+, where list element +i+ is represented according
+        # to [struct_type.fields[i]][google.spanner.v1.StructType.fields].
+        STRUCT = 9
+      end
+    end
+  end
+end

data/lib/google/cloud/spanner/v1/spanner_client.rb

@@ -25,7 +25,7 @@ require "pathname"
 require "google/gax"
 
 require "google/spanner/v1/spanner_pb"
-require "google/cloud/spanner/credentials"
+require "google/cloud/spanner/v1/credentials"
 
 module Google
   module Cloud
@@ -47,6 +47,9 @@ module Google
           # The default port of the service.
           DEFAULT_SERVICE_PORT = 443
 
+          # The default set of gRPC interceptors.
+          GRPC_INTERCEPTORS = []
+
           DEFAULT_TIMEOUT = 30
 
           PAGE_DESCRIPTORS = {
@@ -62,7 +65,6 @@ module Google
           # this service.
           ALL_SCOPES = [
             "https://www.googleapis.com/auth/cloud-platform",
-            "https://www.googleapis.com/auth/spanner.admin",
             "https://www.googleapis.com/auth/spanner.data"
           ].freeze
 
@@ -131,11 +133,18 @@ module Google
           #   or the specified config is missing data points.
           # @param timeout [Numeric]
           #   The default timeout, in seconds, for calls made through this client.
+          # @param metadata [Hash]
+          #   Default metadata to be sent with each request. This can be overridden on a per call basis.
+          # @param exception_transformer [Proc]
+          #   An optional proc that intercepts any exceptions raised during an API call to inject
+          #   custom error handling.
           def initialize \
               credentials: nil,
               scopes: ALL_SCOPES,
               client_config: {},
               timeout: DEFAULT_TIMEOUT,
+              metadata: nil,
+              exception_transformer: nil,
               lib_name: nil,
               lib_version: ""
             # These require statements are intentionally placed here to initialize
@@ -144,10 +153,10 @@ module Google
             require "google/gax/grpc"
             require "google/spanner/v1/spanner_services_pb"
 
-            credentials ||= Google::Cloud::Spanner::Credentials.default
+            credentials ||= Google::Cloud::Spanner::V1::Credentials.default
 
             if credentials.is_a?(String) || credentials.is_a?(Hash)
-              updater_proc = Google::Cloud::Spanner::Credentials.new(credentials).updater_proc
+              updater_proc = Google::Cloud::Spanner::V1::Credentials.new(credentials).updater_proc
             end
             if credentials.is_a?(GRPC::Core::Channel)
               channel = credentials
@@ -171,6 +180,7 @@ module Google
             google_api_client.freeze
 
             headers = { :"x-goog-api-client" => google_api_client }
+            headers.merge!(metadata) unless metadata.nil?
             client_config_file = Pathname.new(__dir__).join(
               "spanner_client_config.json"
             )
@@ -183,13 +193,14 @@ module Google
                 timeout,
                 page_descriptors: PAGE_DESCRIPTORS,
                 errors: Google::Gax::Grpc::API_ERRORS,
-                kwargs: headers
+                metadata: headers
               )
             end
 
             # Allow overriding the service path/port in subclasses.
             service_path = self.class::SERVICE_ADDRESS
             port = self.class::DEFAULT_SERVICE_PORT
+            interceptors = self.class::GRPC_INTERCEPTORS
             @spanner_stub = Google::Gax::Grpc.create_stub(
               service_path,
               port,
@@ -197,60 +208,74 @@ module Google
               channel: channel,
               updater_proc: updater_proc,
               scopes: scopes,
+              interceptors: interceptors,
               &Google::Spanner::V1::Spanner::Stub.method(:new)
             )
 
             @create_session = Google::Gax.create_api_call(
               @spanner_stub.method(:create_session),
-              defaults["create_session"]
+              defaults["create_session"],
+              exception_transformer: exception_transformer
             )
             @get_session = Google::Gax.create_api_call(
               @spanner_stub.method(:get_session),
-              defaults["get_session"]
+              defaults["get_session"],
+              exception_transformer: exception_transformer
             )
             @list_sessions = Google::Gax.create_api_call(
               @spanner_stub.method(:list_sessions),
-              defaults["list_sessions"]
+              defaults["list_sessions"],
+              exception_transformer: exception_transformer
             )
             @delete_session = Google::Gax.create_api_call(
               @spanner_stub.method(:delete_session),
-              defaults["delete_session"]
+              defaults["delete_session"],
+              exception_transformer: exception_transformer
             )
             @execute_sql = Google::Gax.create_api_call(
               @spanner_stub.method(:execute_sql),
-              defaults["execute_sql"]
+              defaults["execute_sql"],
+              exception_transformer: exception_transformer
             )
             @execute_streaming_sql = Google::Gax.create_api_call(
               @spanner_stub.method(:execute_streaming_sql),
-              defaults["execute_streaming_sql"]
+              defaults["execute_streaming_sql"],
+              exception_transformer: exception_transformer
             )
             @read = Google::Gax.create_api_call(
               @spanner_stub.method(:read),
-              defaults["read"]
+              defaults["read"],
+              exception_transformer: exception_transformer
             )
             @streaming_read = Google::Gax.create_api_call(
               @spanner_stub.method(:streaming_read),
-              defaults["streaming_read"]
+              defaults["streaming_read"],
+              exception_transformer: exception_transformer
             )
             @begin_transaction = Google::Gax.create_api_call(
               @spanner_stub.method(:begin_transaction),
-              defaults["begin_transaction"]
+              defaults["begin_transaction"],
+              exception_transformer: exception_transformer
             )
             @commit = Google::Gax.create_api_call(
               @spanner_stub.method(:commit),
-              defaults["commit"]
+              defaults["commit"],
+              exception_transformer: exception_transformer
             )
             @rollback = Google::Gax.create_api_call(
               @spanner_stub.method(:rollback),
-              defaults["rollback"]
+              defaults["rollback"],
+              exception_transformer: exception_transformer
             )
             @partition_query = Google::Gax.create_api_call(
               @spanner_stub.method(:partition_query),
-              defaults["partition_query"]
+              defaults["partition_query"],
+              exception_transformer: exception_transformer
             )
             @partition_read = Google::Gax.create_api_call(
               @spanner_stub.method(:partition_read),
-              defaults["partition_read"]
+              defaults["partition_read"],
+              exception_transformer: exception_transformer
             )
           end
 
@@ -285,25 +310,29 @@ module Google
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Spanner::V1::Session]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
           # @return [Google::Spanner::V1::Session]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/spanner/v1"
+          #   require "google/cloud/spanner"
           #
-          #   spanner_client = Google::Cloud::Spanner::V1.new
+          #   spanner_client = Google::Cloud::Spanner.new(version: :v1)
           #   formatted_database = Google::Cloud::Spanner::V1::SpannerClient.database_path("[PROJECT]", "[INSTANCE]", "[DATABASE]")
           #   response = spanner_client.create_session(formatted_database)
 
           def create_session \
               database,
               session: nil,
-              options: nil
+              options: nil,
+              &block
             req = {
               database: database,
               session: session
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Spanner::V1::CreateSessionRequest)
-            @create_session.call(req, options)
+            @create_session.call(req, options, &block)
           end
 
           # Gets a session. Returns +NOT_FOUND+ if the session does not exist.
@@ -315,23 +344,27 @@ module Google
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Spanner::V1::Session]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
           # @return [Google::Spanner::V1::Session]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/spanner/v1"
+          #   require "google/cloud/spanner"
           #
-          #   spanner_client = Google::Cloud::Spanner::V1.new
+          #   spanner_client = Google::Cloud::Spanner.new(version: :v1)
           #   formatted_name = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
           #   response = spanner_client.get_session(formatted_name)
 
           def get_session \
               name,
-              options: nil
+              options: nil,
+              &block
             req = {
               name: name
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Spanner::V1::GetSessionRequest)
-            @get_session.call(req, options)
+            @get_session.call(req, options, &block)
           end
 
           # Lists all sessions in a given database.
@@ -358,6 +391,9 @@ module Google
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Gax::PagedEnumerable<Google::Spanner::V1::Session>]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
           # @return [Google::Gax::PagedEnumerable<Google::Spanner::V1::Session>]
           #   An enumerable of Google::Spanner::V1::Session instances.
           #   See Google::Gax::PagedEnumerable documentation for other
@@ -365,9 +401,9 @@ module Google
           #   object.
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/spanner/v1"
+          #   require "google/cloud/spanner"
           #
-          #   spanner_client = Google::Cloud::Spanner::V1.new
+          #   spanner_client = Google::Cloud::Spanner.new(version: :v1)
           #   formatted_database = Google::Cloud::Spanner::V1::SpannerClient.database_path("[PROJECT]", "[INSTANCE]", "[DATABASE]")
           #
           #   # Iterate over all results.
@@ -387,14 +423,15 @@ module Google
               database,
               page_size: nil,
               filter: nil,
-              options: nil
+              options: nil,
+              &block
             req = {
               database: database,
               page_size: page_size,
               filter: filter
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Spanner::V1::ListSessionsRequest)
-            @list_sessions.call(req, options)
+            @list_sessions.call(req, options, &block)
           end
 
           # Ends a session, releasing server resources associated with it.
@@ -404,22 +441,26 @@ module Google
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result []
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/spanner/v1"
+          #   require "google/cloud/spanner"
           #
-          #   spanner_client = Google::Cloud::Spanner::V1.new
+          #   spanner_client = Google::Cloud::Spanner.new(version: :v1)
           #   formatted_name = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
           #   spanner_client.delete_session(formatted_name)
 
           def delete_session \
               name,
-              options: nil
+              options: nil,
+              &block
             req = {
               name: name
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Spanner::V1::DeleteSessionRequest)
-            @delete_session.call(req, options)
+            @delete_session.call(req, options, &block)
             nil
           end
 
@@ -491,12 +532,15 @@ module Google
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Spanner::V1::ResultSet]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
           # @return [Google::Spanner::V1::ResultSet]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/spanner/v1"
+          #   require "google/cloud/spanner"
           #
-          #   spanner_client = Google::Cloud::Spanner::V1.new
+          #   spanner_client = Google::Cloud::Spanner.new(version: :v1)
           #   formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
           #
           #   # TODO: Initialize +sql+:
@@ -512,7 +556,8 @@ module Google
               resume_token: nil,
               query_mode: nil,
               partition_token: nil,
-              options: nil
+              options: nil,
+              &block
             req = {
               session: session,
               sql: sql,
@@ -524,7 +569,7 @@ module Google
               partition_token: partition_token
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Spanner::V1::ExecuteSqlRequest)
-            @execute_sql.call(req, options)
+            @execute_sql.call(req, options, &block)
           end
 
           # Like {Google::Spanner::V1::Spanner::ExecuteSql ExecuteSql}, except returns the result
@@ -594,9 +639,9 @@ module Google
           #
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/spanner/v1"
+          #   require "google/cloud/spanner"
           #
-          #   spanner_client = Google::Cloud::Spanner::V1.new
+          #   spanner_client = Google::Cloud::Spanner.new(version: :v1)
           #   formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
           #
           #   # TODO: Initialize +sql+:
@@ -693,12 +738,15 @@ module Google
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Spanner::V1::ResultSet]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
           # @return [Google::Spanner::V1::ResultSet]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/spanner/v1"
+          #   require "google/cloud/spanner"
           #
-          #   spanner_client = Google::Cloud::Spanner::V1.new
+          #   spanner_client = Google::Cloud::Spanner.new(version: :v1)
           #   formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
           #
           #   # TODO: Initialize +table+:
@@ -721,7 +769,8 @@ module Google
               limit: nil,
               resume_token: nil,
               partition_token: nil,
-              options: nil
+              options: nil,
+              &block
             req = {
               session: session,
               table: table,
@@ -734,7 +783,7 @@ module Google
               partition_token: partition_token
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Spanner::V1::ReadRequest)
-            @read.call(req, options)
+            @read.call(req, options, &block)
           end
 
           # Like {Google::Spanner::V1::Spanner::Read Read}, except returns the result set as a
@@ -798,9 +847,9 @@ module Google
           #
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/spanner/v1"
+          #   require "google/cloud/spanner"
           #
-          #   spanner_client = Google::Cloud::Spanner::V1.new
+          #   spanner_client = Google::Cloud::Spanner.new(version: :v1)
           #   formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
           #
           #   # TODO: Initialize +table+:
@@ -855,12 +904,15 @@ module Google
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Spanner::V1::Transaction]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
           # @return [Google::Spanner::V1::Transaction]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/spanner/v1"
+          #   require "google/cloud/spanner"
           #
-          #   spanner_client = Google::Cloud::Spanner::V1.new
+          #   spanner_client = Google::Cloud::Spanner.new(version: :v1)
           #   formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
           #
           #   # TODO: Initialize +options_+:
@@ -870,13 +922,14 @@ module Google
           def begin_transaction \
               session,
               options_,
-              options: nil
+              options: nil,
+              &block
             req = {
               session: session,
               options: options_
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Spanner::V1::BeginTransactionRequest)
-            @begin_transaction.call(req, options)
+            @begin_transaction.call(req, options, &block)
           end
 
           # Commits a transaction. The request includes the mutations to be
@@ -913,12 +966,15 @@ module Google
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Spanner::V1::CommitResponse]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
           # @return [Google::Spanner::V1::CommitResponse]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/spanner/v1"
+          #   require "google/cloud/spanner"
           #
-          #   spanner_client = Google::Cloud::Spanner::V1.new
+          #   spanner_client = Google::Cloud::Spanner.new(version: :v1)
           #   formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
           #
           #   # TODO: Initialize +mutations+:
@@ -930,7 +986,8 @@ module Google
               mutations,
               transaction_id: nil,
               single_use_transaction: nil,
-              options: nil
+              options: nil,
+              &block
             req = {
               session: session,
               mutations: mutations,
@@ -938,7 +995,7 @@ module Google
               single_use_transaction: single_use_transaction
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Spanner::V1::CommitRequest)
-            @commit.call(req, options)
+            @commit.call(req, options, &block)
           end
 
           # Rolls back a transaction, releasing any locks it holds. It is a good
@@ -957,11 +1014,14 @@ module Google
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result []
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/spanner/v1"
+          #   require "google/cloud/spanner"
           #
-          #   spanner_client = Google::Cloud::Spanner::V1.new
+          #   spanner_client = Google::Cloud::Spanner.new(version: :v1)
           #   formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
           #
           #   # TODO: Initialize +transaction_id+:
@@ -971,13 +1031,14 @@ module Google
           def rollback \
               session,
               transaction_id,
-              options: nil
+              options: nil,
+              &block
             req = {
               session: session,
               transaction_id: transaction_id
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Spanner::V1::RollbackRequest)
-            @rollback.call(req, options)
+            @rollback.call(req, options, &block)
             nil
           end
 
@@ -1039,12 +1100,15 @@ module Google
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Spanner::V1::PartitionResponse]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
           # @return [Google::Spanner::V1::PartitionResponse]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/spanner/v1"
+          #   require "google/cloud/spanner"
           #
-          #   spanner_client = Google::Cloud::Spanner::V1.new
+          #   spanner_client = Google::Cloud::Spanner.new(version: :v1)
           #   formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
           #
           #   # TODO: Initialize +sql+:
@@ -1058,7 +1122,8 @@ module Google
               params: nil,
               param_types: nil,
               partition_options: nil,
-              options: nil
+              options: nil,
+              &block
             req = {
               session: session,
               sql: sql,
@@ -1068,7 +1133,7 @@ module Google
               partition_options: partition_options
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Spanner::V1::PartitionQueryRequest)
-            @partition_query.call(req, options)
+            @partition_query.call(req, options, &block)
           end
 
           # Creates a set of partition tokens that can be used to execute a read
@@ -1113,12 +1178,15 @@ module Google
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
+          # @yield [result, operation] Access the result along with the RPC operation
+          # @yieldparam result [Google::Spanner::V1::PartitionResponse]
+          # @yieldparam operation [GRPC::ActiveCall::Operation]
           # @return [Google::Spanner::V1::PartitionResponse]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/spanner/v1"
+          #   require "google/cloud/spanner"
           #
-          #   spanner_client = Google::Cloud::Spanner::V1.new
+          #   spanner_client = Google::Cloud::Spanner.new(version: :v1)
           #   formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
           #
           #   # TODO: Initialize +table+:
@@ -1136,7 +1204,8 @@ module Google
               index: nil,
               columns: nil,
               partition_options: nil,
-              options: nil
+              options: nil,
+              &block
             req = {
               session: session,
               table: table,
@@ -1147,7 +1216,7 @@ module Google
               partition_options: partition_options
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Spanner::V1::PartitionReadRequest)
-            @partition_read.call(req, options)
+            @partition_read.call(req, options, &block)
           end
         end
       end

data/lib/google/cloud/spanner/v1/spanner_client_config.json

@@ -88,7 +88,7 @@
           "retry_params_name": "default"
         },
         "PartitionQuery": {
-          "timeout_millis": 3600000,
+          "timeout_millis": 30000,
           "retry_codes_name": "idempotent",
           "retry_params_name": "default"
         },

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

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-spanner
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-28 00:00:00.000000000 Z
+date: 2018-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -137,6 +137,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -255,7 +269,9 @@ files:
 - 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/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/spanner/v1/keys.rb
@@ -264,7 +280,7 @@ files:
 - 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/overview.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

data/lib/google/cloud/spanner/v1/doc/overview.rb

@@ -1,55 +0,0 @@
-# Copyright 2018 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-module Google
-  module Cloud
-    # rubocop:disable LineLength
-
-    ##
-    # # Ruby Client for Cloud Spanner API ([GA](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
-    #
-    # [Cloud Spanner API][Product Documentation]:
-    # Cloud Spanner is a managed, mission-critical, globally consistent and
-    # scalable relational database service.
-    # - [Product Documentation][]
-    #
-    # ## Quick Start
-    # In order to use this library, you first need to go through the following
-    # steps:
-    #
-    # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
-    # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
-    # 3. [Enable the Cloud Spanner API.](https://console.cloud.google.com/apis/api/spanner)
-    # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
-    #
-    # ### Installation
-    # ```
-    # $ gem install google-cloud-spanner
-    # ```
-    #
-    # ### Next Steps
-    # - Read the [Cloud Spanner API Product documentation][Product Documentation]
-    #   to learn more about the product and see How-to Guides.
-    # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
-    #   to see the full list of Cloud APIs that we cover.
-    #
-    # [Product Documentation]: https://cloud.google.com/spanner
-    #
-    #
-    module Spanner
-      module V1
-      end
-    end
-  end
-end