google-cloud-spanner-v1 0.2.1 → 0.5.0

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/api/resource.rb

@@ -43,12 +43,12 @@ module Google
     #
     # The ResourceDescriptor Yaml config will look like:
     #
-    #    resources:
-    #    - type: "pubsub.googleapis.com/Topic"
-    #      name_descriptor:
-    #        - pattern: "projects/\\{project}/topics/\\{topic}"
-    #          parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #          parent_name_extractor: "projects/\\{project}"
+    #     resources:
+    #     - type: "pubsub.googleapis.com/Topic"
+    #       name_descriptor:
+    #         - pattern: "projects/{project}/topics/{topic}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
     #
     # Sometimes, resources have multiple patterns, typically because they can
     # live under multiple parents.
@@ -183,15 +183,24 @@ module Google
     #         }
     # @!attribute [rw] plural
     #   @return [::String]
-    #     The plural name used in the resource name, such as 'projects' for
-    #     the name of 'projects/\\{project}'. It is the same concept of the `plural`
-    #     field in k8s CRD spec
+    #     The plural name used in the resource name and permission names, such as
+    #     'projects' for the resource name of 'projects/\\{project}' and the permission
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
+    #     concept of the `plural` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #
+    #     Note: The plural form is required even for singleton resources. See
+    #     https://aip.dev/156
     # @!attribute [rw] singular
     #   @return [::String]
     #     The same concept of the `singular` field in k8s CRD spec
     #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
     #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    # @!attribute [rw] style
+    #   @return [::Array<::Google::Api::ResourceDescriptor::Style>]
+    #     Style flag(s) for this resource.
+    #     These indicate that a resource is expected to conform to a given
+    #     style. See the specific style flags for additional information.
     class ResourceDescriptor
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -211,6 +220,22 @@ module Google
         # that from being necessary once there are multiple patterns.)
         FUTURE_MULTI_PATTERN = 2
       end
+
+      # A flag representing a specific style that a resource claims to conform to.
+      module Style
+        # The unspecified value. Do not use.
+        STYLE_UNSPECIFIED = 0
+
+        # This resource is intended to be "declarative-friendly".
+        #
+        # Declarative-friendly resources must be more strictly consistent, and
+        # setting this to true communicates to tools that this resource should
+        # adhere to declarative-friendly expectations.
+        #
+        # Note: This is used by the API linter (linter.aip.dev) to enable
+        # additional checks.
+        DECLARATIVE_FRIENDLY = 1
+      end
     end
 
     # Defines a proto annotation that describes a string field that refers to
@@ -226,6 +251,17 @@ module Google
     #             type: "pubsub.googleapis.com/Topic"
     #           }];
     #         }
+    #
+    #     Occasionally, a field may reference an arbitrary resource. In this case,
+    #     APIs use the special value * in their resource reference.
+    #
+    #     Example:
+    #
+    #         message GetIamPolicyRequest {
+    #           string resource = 2 [(google.api.resource_reference) = {
+    #             type: "*"
+    #           }];
+    #         }
     # @!attribute [rw] child_type
     #   @return [::String]
     #     The resource type of a child collection that the annotated field
@@ -234,11 +270,11 @@ module Google
     #
     #     Example:
     #
-    #       message ListLogEntriesRequest {
-    #         string parent = 1 [(google.api.resource_reference) = {
-    #           child_type: "logging.googleapis.com/LogEntry"
-    #         };
-    #       }
+    #         message ListLogEntriesRequest {
+    #           string parent = 1 [(google.api.resource_reference) = {
+    #             child_type: "logging.googleapis.com/LogEntry"
+    #           };
+    #         }
     class ResourceReference
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

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/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.
@@ -185,8 +184,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:
@@ -250,17 +250,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]
+          #     Query optimizer statistics package to use.
+          #
+          #     This parameter allows individual queries to use a different query
+          #     optimizer statistics.
+          #
+          #     Specifying `latest` as a value instructs Cloud Spanner to use the latest
+          #     generated statistics package. If not specified, Cloud Spanner uses
+          #     statistics package set at the database level options, or latest 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
+          #     `SPANNER_SYS.OPTIMIZER_STATISTICS_PACKAGES`.
+          #
+          #     Executing a SQL statement with an invalid optimizer statistics package
+          #     or with statistics package that allows garbage collection fails with
+          #     an `INVALID_ARGUMENT` error.
           class QueryOptions
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -650,6 +682,11 @@ 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`.
         class CommitRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -659,9 +696,29 @@ module Google
         # @!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
 
         # The request for {::Google::Cloud::Spanner::V1::Spanner::Client#rollback Rollback}.

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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-spanner-v1
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-06 00:00:00.000000000 Z
+date: 2021-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -44,14 +44,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 +151,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: []
@@ -204,14 +206,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.1.3
+rubygems_version: 3.2.13
 signing_key: 
 specification_version: 4
 summary: API Client library for the Cloud Spanner V1 API