google-cloud-spanner-v1 0.2.3 → 0.6.1

data/lib/google/spanner/v1/spanner_services_pb.rb

@@ -30,7 +30,7 @@ module Google
           # transactions on data stored in Cloud Spanner databases.
           class Service
 
-            include GRPC::GenericService
+            include ::GRPC::GenericService
 
             self.marshal_class_method = :encode
             self.unmarshal_class_method = :decode
@@ -134,6 +134,12 @@ module Google
             # transactions. However, it can also happen for a variety of other
             # reasons. If `Commit` returns `ABORTED`, the caller should re-attempt
             # the transaction from the beginning, re-using the same session.
+            #
+            # On very rare occasions, `Commit` might return `UNKNOWN`. This can happen,
+            # for example, if the client job experiences a 1+ hour networking failure.
+            # At that point, Cloud Spanner has lost track of the transaction outcome and
+            # we recommend that you perform another read from the database to see the
+            # state of things as they are now.
             rpc :Commit, ::Google::Cloud::Spanner::V1::CommitRequest, ::Google::Cloud::Spanner::V1::CommitResponse
             # Rolls back a transaction, releasing any locks it holds. It is a good
             # idea to call this for any transaction that includes one or more

data/proto_docs/google/api/field_behavior.rb

@@ -54,6 +54,12 @@ module Google
       # This indicates that the field may be set once in a request to create a
       # resource, but may not be changed thereafter.
       IMMUTABLE = 5
+
+      # Denotes that a (repeated) field is an unordered list.
+      # This indicates that the service may provide the elements of the list
+      # in any arbitrary order, rather than the order the user originally
+      # provided. Additionally, the list's order may or may not be stable.
+      UNORDERED_LIST = 6
     end
   end
 end

data/proto_docs/google/protobuf/any.rb

@@ -57,10 +57,13 @@ module Google
     #  Example 4: Pack and unpack a message in Go
     #
     #      foo := &pb.Foo{...}
-    #      any, err := ptypes.MarshalAny(foo)
+    #      any, err := anypb.New(foo)
+    #      if err != nil {
+    #        ...
+    #      }
     #      ...
     #      foo := &pb.Foo{}
-    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
+    #      if err := any.UnmarshalTo(foo); err != nil {
     #        ...
     #      }
     #

data/proto_docs/google/protobuf/timestamp.rb

@@ -70,7 +70,16 @@ module Google
     #         .setNanos((int) ((millis % 1000) * 1000000)).build();
     #
     #
-    # Example 5: Compute Timestamp from current time in Python.
+    # Example 5: Compute Timestamp from Java `Instant.now()`.
+    #
+    #     Instant now = Instant.now();
+    #
+    #     Timestamp timestamp =
+    #         Timestamp.newBuilder().setSeconds(now.getEpochSecond())
+    #             .setNanos(now.getNano()).build();
+    #
+    #
+    # Example 6: Compute Timestamp from current time in Python.
     #
     #     timestamp = Timestamp()
     #     timestamp.GetCurrentTime()

data/proto_docs/google/spanner/v1/commit_response.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Spanner
+      module V1
+        # The response for {::Google::Cloud::Spanner::V1::Spanner::Client#commit Commit}.
+        # @!attribute [rw] commit_timestamp
+        #   @return [::Google::Protobuf::Timestamp]
+        #     The Cloud Spanner timestamp at which the transaction committed.
+        # @!attribute [rw] commit_stats
+        #   @return [::Google::Cloud::Spanner::V1::CommitResponse::CommitStats]
+        #     The statistics about this Commit. Not returned by default.
+        #     For more information, see
+        #     {::Google::Cloud::Spanner::V1::CommitRequest#return_commit_stats CommitRequest.return_commit_stats}.
+        class CommitResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Additional statistics about a commit.
+          # @!attribute [rw] mutation_count
+          #   @return [::Integer]
+          #     The total number of mutations for the transaction. Knowing the
+          #     `mutation_count` value can help you maximize the number of mutations
+          #     in a transaction and minimize the number of API round trips. You can
+          #     also monitor this value to prevent transactions from exceeding the system
+          #     [limit](http://cloud.google.com/spanner/quotas#limits_for_creating_reading_updating_and_deleting_data).
+          #     If the number of mutations exceeds the limit, the server returns
+          #     [INVALID_ARGUMENT](http://cloud.google.com/spanner/docs/reference/rest/v1/Code#ENUM_VALUES.INVALID_ARGUMENT).
+          class CommitStats
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/spanner/v1/spanner.rb

@@ -62,10 +62,9 @@ module Google
         end
 
         # A session in the Cloud Spanner API.
-        # @!attribute [rw] name
+        # @!attribute [r] name
         #   @return [::String]
-        #     The name of the session. This is always system-assigned; values provided
-        #     when creating a session are ignored.
+        #     Output only. The name of the session. This is always system-assigned.
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     The labels for the session.
@@ -77,10 +76,10 @@ module Google
         #      * No more than 64 labels can be associated with a given session.
         #
         #     See https://goo.gl/xmQnxf for more information on and examples of labels.
-        # @!attribute [rw] create_time
+        # @!attribute [r] create_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. The timestamp when the session is created.
-        # @!attribute [rw] approximate_last_use_time
+        # @!attribute [r] approximate_last_use_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. The approximate timestamp when the session is last used. It is
         #     typically earlier than the actual last use time.
@@ -160,6 +159,68 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Common request options for various APIs.
+        # @!attribute [rw] priority
+        #   @return [::Google::Cloud::Spanner::V1::RequestOptions::Priority]
+        #     Priority for the request.
+        # @!attribute [rw] request_tag
+        #   @return [::String]
+        #     A per-request tag which can be applied to queries or reads, used for
+        #     statistics collection.
+        #     Both request_tag and transaction_tag can be specified for a read or query
+        #     that belongs to a transaction.
+        #     This field is ignored for requests where it's not applicable (e.g.
+        #     CommitRequest).
+        #     Legal characters for `request_tag` values are all printable characters
+        #     (ASCII 32 - 126) and the length of a request_tag is limited to 50
+        #     characters. Values that exceed this limit are truncated.
+        # @!attribute [rw] transaction_tag
+        #   @return [::String]
+        #     A tag used for statistics collection about this transaction.
+        #     Both request_tag and transaction_tag can be specified for a read or query
+        #     that belongs to a transaction.
+        #     The value of transaction_tag should be the same for all requests belonging
+        #     to the same transaction.
+        #     If this request doesn’t belong to any transaction, transaction_tag will be
+        #     ignored.
+        #     Legal characters for `transaction_tag` values are all printable characters
+        #     (ASCII 32 - 126) and the length of a transaction_tag is limited to 50
+        #     characters. Values that exceed this limit are truncated.
+        class RequestOptions
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The relative priority for requests. Note that priority is not applicable
+          # for {::Google::Cloud::Spanner::V1::Spanner::Client#begin_transaction BeginTransaction}.
+          #
+          # The priority acts as a hint to the Cloud Spanner scheduler and does not
+          # guarantee priority or order of execution. For example:
+          #
+          # * Some parts of a write operation always execute at `PRIORITY_HIGH`,
+          #   regardless of the specified priority. This may cause you to see an
+          #   increase in high priority workload even when executing a low priority
+          #   request. This can also potentially cause a priority inversion where a
+          #   lower priority request will be fulfilled ahead of a higher priority
+          #   request.
+          # * If a transaction contains multiple operations with different priorities,
+          #   Cloud Spanner does not guarantee to process the higher priority
+          #   operations first. There may be other constraints to satisfy, such as
+          #   order of operations.
+          module Priority
+            # `PRIORITY_UNSPECIFIED` is equivalent to `PRIORITY_HIGH`.
+            PRIORITY_UNSPECIFIED = 0
+
+            # This specifies that the request is low priority.
+            PRIORITY_LOW = 1
+
+            # This specifies that the request is medium priority.
+            PRIORITY_MEDIUM = 2
+
+            # This specifies that the request is high priority.
+            PRIORITY_HIGH = 3
+          end
+        end
+
         # The request for {::Google::Cloud::Spanner::V1::Spanner::Client#execute_sql ExecuteSql} and
         # {::Google::Cloud::Spanner::V1::Spanner::Client#execute_streaming_sql ExecuteStreamingSql}.
         # @!attribute [rw] session
@@ -185,8 +246,9 @@ module Google
         #     Parameter names and values that bind to placeholders in the SQL string.
         #
         #     A parameter placeholder consists of the `@` character followed by the
-        #     parameter name (for example, `@firstName`). Parameter names can contain
-        #     letters, numbers, and underscores.
+        #     parameter name (for example, `@firstName`). Parameter names must conform
+        #     to the naming requirements of identifiers as specified at
+        #     https://cloud.google.com/spanner/docs/lexical#identifiers.
         #
         #     Parameters can appear anywhere that a literal value is expected.  The same
         #     parameter name can be used more than once, for example:
@@ -238,6 +300,9 @@ module Google
         # @!attribute [rw] query_options
         #   @return [::Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryOptions]
         #     Query optimizer configuration to use for the given query.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Spanner::V1::RequestOptions]
+        #     Common options for this request.
         class ExecuteSqlRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -250,17 +315,49 @@ module Google
           #     This parameter allows individual queries to pick different query
           #     optimizer versions.
           #
-          #     Specifying "latest" as a value instructs Cloud Spanner to use the
+          #     Specifying `latest` as a value instructs Cloud Spanner to use the
           #     latest supported query optimizer version. If not specified, Cloud Spanner
-          #     uses optimizer version set at the database level options. Any other
+          #     uses the optimizer version set at the database level options. Any other
           #     positive integer (from the list of supported optimizer versions)
           #     overrides the default optimizer version for query execution.
+          #
           #     The list of supported optimizer versions can be queried from
-          #     SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS. Executing a SQL statement
-          #     with an invalid optimizer version will fail with a syntax error
-          #     (`INVALID_ARGUMENT`) status.
+          #     SPANNER_SYS.SUPPORTED_OPTIMIZER_VERSIONS.
+          #
+          #     Executing a SQL statement with an invalid optimizer version fails with
+          #     an `INVALID_ARGUMENT` error.
+          #
+          #     See
+          #     https://cloud.google.com/spanner/docs/query-optimizer/manage-query-optimizer
+          #     for more information on managing the query optimizer.
           #
           #     The `optimizer_version` statement hint has precedence over this setting.
+          # @!attribute [rw] optimizer_statistics_package
+          #   @return [::String]
+          #     An option to control the selection of optimizer statistics package.
+          #
+          #     This parameter allows individual queries to use a different query
+          #     optimizer statistics package.
+          #
+          #     Specifying `latest` as a value instructs Cloud Spanner to use the latest
+          #     generated statistics package. If not specified, Cloud Spanner uses
+          #     the statistics package set at the database level options, or the latest
+          #     package if the database option is not set.
+          #
+          #     The statistics package requested by the query has to be exempt from
+          #     garbage collection. This can be achieved with the following DDL
+          #     statement:
+          #
+          #     ```
+          #     ALTER STATISTICS <package_name> SET OPTIONS (allow_gc=false)
+          #     ```
+          #
+          #     The list of available statistics packages can be queried from
+          #     `INFORMATION_SCHEMA.SPANNER_STATISTICS`.
+          #
+          #     Executing a SQL statement with an invalid optimizer statistics package
+          #     or with a statistics package that allows garbage collection fails with
+          #     an `INVALID_ARGUMENT` error.
           class QueryOptions
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -319,6 +416,9 @@ module Google
         #     transaction. If a request arrives for the first time with an out-of-order
         #     sequence number, the transaction may be aborted. Replays of previously
         #     handled requests will yield the same response as the first execution.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Spanner::V1::RequestOptions]
+        #     Common options for this request.
         class ExecuteBatchDmlRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -610,6 +710,9 @@ module Google
         #     previously created using PartitionRead().    There must be an exact
         #     match for the values of fields common to this message and the
         #     PartitionReadRequest message used to create this partition_token.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Spanner::V1::RequestOptions]
+        #     Common options for this request.
         class ReadRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -622,6 +725,13 @@ module Google
         # @!attribute [rw] options
         #   @return [::Google::Cloud::Spanner::V1::TransactionOptions]
         #     Required. Options for the new transaction.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Spanner::V1::RequestOptions]
+        #     Common options for this request.
+        #     Priority is ignored for this request. Setting the priority in this
+        #     request_options struct will not do anything. To set the priority for a
+        #     transaction, set it on the reads and writes that are part of this
+        #     transaction instead.
         class BeginTransactionRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -650,20 +760,19 @@ module Google
         #     The mutations to be executed when this transaction commits. All
         #     mutations are applied atomically, in the order they appear in
         #     this list.
+        # @!attribute [rw] return_commit_stats
+        #   @return [::Boolean]
+        #     If `true`, then statistics related to the transaction will be included in
+        #     the {::Google::Cloud::Spanner::V1::CommitResponse#commit_stats CommitResponse}. Default value is
+        #     `false`.
+        # @!attribute [rw] request_options
+        #   @return [::Google::Cloud::Spanner::V1::RequestOptions]
+        #     Common options for this request.
         class CommitRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The response for {::Google::Cloud::Spanner::V1::Spanner::Client#commit Commit}.
-        # @!attribute [rw] commit_timestamp
-        #   @return [::Google::Protobuf::Timestamp]
-        #     The Cloud Spanner timestamp at which the transaction committed.
-        class CommitResponse
-          include ::Google::Protobuf::MessageExts
-          extend ::Google::Protobuf::MessageExts::ClassMethods
-        end
-
         # The request for {::Google::Cloud::Spanner::V1::Spanner::Client#rollback Rollback}.
         # @!attribute [rw] session
         #   @return [::String]

data/proto_docs/google/spanner/v1/transaction.rb

@@ -24,10 +24,11 @@ module Google
         # # Transactions
         #
         #
-        # Each session can have at most one active transaction at a time. After the
-        # active transaction is completed, the session can immediately be
-        # re-used for the next transaction. It is not necessary to create a
-        # new session for each transaction.
+        # Each session can have at most one active transaction at a time (note that
+        # standalone reads and queries use a transaction internally and do count
+        # towards the one transaction limit). After the active transaction is
+        # completed, the session can immediately be re-used for the next transaction.
+        # It is not necessary to create a new session for each transaction.
         #
         # # Transaction Modes
         #
@@ -85,7 +86,7 @@ module Google
         # {::Google::Cloud::Spanner::V1::Spanner::Client#rollback Rollback} request to abort the
         # transaction.
         #
-        # ### Semantics
+        # ## Semantics
         #
         # Cloud Spanner can commit the transaction if all read locks it acquired
         # are still valid at commit time, and it is able to acquire write
@@ -98,7 +99,7 @@ module Google
         # use Cloud Spanner locks for any sort of mutual exclusion other than
         # between Cloud Spanner transactions themselves.
         #
-        # ### Retrying Aborted Transactions
+        # ## Retrying Aborted Transactions
         #
         # When a transaction aborts, the application can choose to retry the
         # whole transaction again. To maximize the chances of successfully
@@ -114,7 +115,7 @@ module Google
         # instead, it is better to limit the total amount of wall time spent
         # retrying.
         #
-        # ### Idle Transactions
+        # ## Idle Transactions
         #
         # A transaction is considered idle if it has no outstanding reads or
         # SQL queries and has not started a read or SQL query within the last 10
@@ -164,7 +165,7 @@ module Google
         #
         # Each type of timestamp bound is discussed in detail below.
         #
-        # ### Strong
+        # ## Strong
         #
         # Strong reads are guaranteed to see the effects of all transactions
         # that have committed before the start of the read. Furthermore, all
@@ -180,7 +181,7 @@ module Google
         #
         # See {::Google::Cloud::Spanner::V1::TransactionOptions::ReadOnly#strong TransactionOptions.ReadOnly.strong}.
         #
-        # ### Exact Staleness
+        # ## Exact Staleness
         #
         # These timestamp bounds execute reads at a user-specified
         # timestamp. Reads at a timestamp are guaranteed to see a consistent
@@ -202,7 +203,7 @@ module Google
         # See {::Google::Cloud::Spanner::V1::TransactionOptions::ReadOnly#read_timestamp TransactionOptions.ReadOnly.read_timestamp} and
         # {::Google::Cloud::Spanner::V1::TransactionOptions::ReadOnly#exact_staleness TransactionOptions.ReadOnly.exact_staleness}.
         #
-        # ### Bounded Staleness
+        # ## Bounded Staleness
         #
         # Bounded staleness modes allow Cloud Spanner to pick the read timestamp,
         # subject to a user-provided staleness bound. Cloud Spanner chooses the
@@ -232,7 +233,7 @@ module Google
         # See {::Google::Cloud::Spanner::V1::TransactionOptions::ReadOnly#max_staleness TransactionOptions.ReadOnly.max_staleness} and
         # {::Google::Cloud::Spanner::V1::TransactionOptions::ReadOnly#min_read_timestamp TransactionOptions.ReadOnly.min_read_timestamp}.
         #
-        # ### Old Read Timestamps and Garbage Collection
+        # ## Old Read Timestamps and Garbage Collection
         #
         # Cloud Spanner continuously garbage collects deleted and overwritten data
         # in the background to reclaim storage space. This process is known

data/proto_docs/google/spanner/v1/type.rb

@@ -59,7 +59,7 @@ module Google
           #     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
+          #     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

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-spanner-v1
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.6.1
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.a
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: google-cloud-errors
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.24.0
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -151,7 +157,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 description: Cloud Spanner is a managed, mission-critical, globally consistent and
-  scalable relational database service.
+  scalable relational database service. Note that google-cloud-spanner-v1 is a version-specific
+  client library. For most uses, we recommend installing the main client library google-cloud-spanner
+  instead. See the readme for more details.
 email: googleapis-packages@google.com
 executables: []
 extensions: []
@@ -168,6 +176,7 @@ files:
 - lib/google/cloud/spanner/v1/spanner/credentials.rb
 - lib/google/cloud/spanner/v1/spanner/paths.rb
 - lib/google/cloud/spanner/v1/version.rb
+- lib/google/spanner/v1/commit_response_pb.rb
 - lib/google/spanner/v1/keys_pb.rb
 - lib/google/spanner/v1/mutation_pb.rb
 - lib/google/spanner/v1/query_plan_pb.rb
@@ -185,6 +194,7 @@ files:
 - proto_docs/google/protobuf/struct.rb
 - proto_docs/google/protobuf/timestamp.rb
 - proto_docs/google/rpc/status.rb
+- proto_docs/google/spanner/v1/commit_response.rb
 - proto_docs/google/spanner/v1/keys.rb
 - proto_docs/google/spanner/v1/mutation.rb
 - proto_docs/google/spanner/v1/query_plan.rb
@@ -204,14 +214,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.6
+rubygems_version: 3.2.17
 signing_key: 
 specification_version: 4
 summary: API Client library for the Cloud Spanner V1 API