google-cloud-datastore-v1 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70494eebdff2679a9ba9a3ac0e3fad3aa963d9ff6c043588fd3c01350e25bf00
-  data.tar.gz: b5d9812b094fdf12f184a01da35fa3e98b64742e7e328851707d118d3a95c27b
+  metadata.gz: 9037ce9b9a83196dc252e29b5210dd7aa5e36c75e9015e5cd685ffa66b4a8294
+  data.tar.gz: 932f181b9b2726f89ffa2f59c2b6de3f8d39608c17900ea64cb6ad7a05b24cee
 SHA512:
-  metadata.gz: 758651b474e62bd94e5779349556046eac9c861a71ddc980471416738adf2334f0bbfb7b9e99dfa632628cbeec2ad99cb44357971b3d60439bc753d903f89150
-  data.tar.gz: fb98c51cb9c73cf468c7c265af12555e2f994594c306da6f71ac9b5e9cd3132c391306ad9816a5e0663d5d548363c2e623d3704a0d7b29a9f8965f866f924553
+  metadata.gz: bc98b055ee9214faa13ff29a42fabad5857d8c2b50e7ca76d85d251db574ed5a95a6fc34e39dd9920351dccfa9b2637c0886d66a29a6abf51ca49266def389a6
+  data.tar.gz: 962be531e28ceae5ca7c621c68b5ec0e2c33a89d3128ad649d14472cb1af02b8abec6978e912d8f0d4d11928542d8dd161239c693902965a1ae7d14d03b4251f

data/AUTHENTICATION.md

@@ -114,7 +114,7 @@ credentials are discovered.
 To configure your system for this, simply:
 
 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
-2. Authenticate using OAuth 2.0 `$ gcloud auth login`
+2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
 3. Write code as if already authenticated.
 
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK

data/README.md

@@ -69,16 +69,21 @@ module GRPC
 end
 ```
 
+
+## Google Cloud Samples
+
+To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
+
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.5+.
+This library is supported on Ruby 2.6+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or
-in security maintenance, and not end of life. Currently, this means Ruby 2.5
-and later. Older versions of Ruby _may_ still work, but are unsupported and not
-recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
-about the Ruby support schedule.
+in security maintenance, and not end of life. Older versions of Ruby _may_
+still work, but are unsupported and not recommended. See
+https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
+support schedule.
 
 ## Which client should I use?
 

data/lib/google/cloud/datastore/v1/datastore/client.rb

@@ -77,6 +77,11 @@ module Google
                   initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
                 }
 
+                default_config.rpcs.run_aggregation_query.timeout = 60.0
+                default_config.rpcs.run_aggregation_query.retry_policy = {
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
+                }
+
                 default_config.rpcs.begin_transaction.timeout = 60.0
 
                 default_config.rpcs.commit.timeout = 60.0
@@ -183,13 +188,18 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload lookup(project_id: nil, read_options: nil, keys: nil)
+            # @overload lookup(project_id: nil, database_id: nil, read_options: nil, keys: nil)
             #   Pass arguments to `lookup` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param project_id [::String]
             #     Required. The ID of the project against which to make the request.
+            #   @param database_id [::String]
+            #     The ID of the database against which to make the request.
+            #
+            #     '(default)' is not allowed; please use empty string '' to refer the default
+            #     database.
             #   @param read_options [::Google::Cloud::Datastore::V1::ReadOptions, ::Hash]
             #     The options for this lookup request.
             #   @param keys [::Array<::Google::Cloud::Datastore::V1::Key, ::Hash>]
@@ -272,13 +282,18 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload run_query(project_id: nil, partition_id: nil, read_options: nil, query: nil, gql_query: nil)
+            # @overload run_query(project_id: nil, database_id: nil, partition_id: nil, read_options: nil, query: nil, gql_query: nil)
             #   Pass arguments to `run_query` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param project_id [::String]
             #     Required. The ID of the project against which to make the request.
+            #   @param database_id [::String]
+            #     The ID of the database against which to make the request.
+            #
+            #     '(default)' is not allowed; please use empty string '' to refer the default
+            #     database.
             #   @param partition_id [::Google::Cloud::Datastore::V1::PartitionId, ::Hash]
             #     Entities are partitioned into subsets, identified by a partition ID.
             #     Queries are scoped to a single partition.
@@ -289,7 +304,7 @@ module Google
             #   @param query [::Google::Cloud::Datastore::V1::Query, ::Hash]
             #     The query to run.
             #   @param gql_query [::Google::Cloud::Datastore::V1::GqlQuery, ::Hash]
-            #     The GQL query to run.
+            #     The GQL query to run. This query must be a non-aggregation query.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Datastore::V1::RunQueryResponse]
@@ -355,6 +370,107 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Runs an aggregation query.
+            #
+            # @overload run_aggregation_query(request, options = nil)
+            #   Pass arguments to `run_aggregation_query` via a request object, either of type
+            #   {::Google::Cloud::Datastore::V1::RunAggregationQueryRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Datastore::V1::RunAggregationQueryRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload run_aggregation_query(project_id: nil, database_id: nil, partition_id: nil, read_options: nil, aggregation_query: nil, gql_query: nil)
+            #   Pass arguments to `run_aggregation_query` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param project_id [::String]
+            #     Required. The ID of the project against which to make the request.
+            #   @param database_id [::String]
+            #     The ID of the database against which to make the request.
+            #
+            #     '(default)' is not allowed; please use empty string '' to refer the default
+            #     database.
+            #   @param partition_id [::Google::Cloud::Datastore::V1::PartitionId, ::Hash]
+            #     Entities are partitioned into subsets, identified by a partition ID.
+            #     Queries are scoped to a single partition.
+            #     This partition ID is normalized with the standard default context
+            #     partition ID.
+            #   @param read_options [::Google::Cloud::Datastore::V1::ReadOptions, ::Hash]
+            #     The options for this query.
+            #   @param aggregation_query [::Google::Cloud::Datastore::V1::AggregationQuery, ::Hash]
+            #     The query to run.
+            #   @param gql_query [::Google::Cloud::Datastore::V1::GqlQuery, ::Hash]
+            #     The GQL query to run. This query must be an aggregation query.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::Datastore::V1::RunAggregationQueryResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::Datastore::V1::RunAggregationQueryResponse]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/datastore/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Datastore::V1::Datastore::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Datastore::V1::RunAggregationQueryRequest.new
+            #
+            #   # Call the run_aggregation_query method.
+            #   result = client.run_aggregation_query request
+            #
+            #   # The returned object is of type Google::Cloud::Datastore::V1::RunAggregationQueryResponse.
+            #   p result
+            #
+            def run_aggregation_query request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastore::V1::RunAggregationQueryRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.run_aggregation_query.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::Datastore::V1::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.project_id
+                header_params["project_id"] = request.project_id
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.run_aggregation_query.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.run_aggregation_query.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @datastore_stub.call_rpc :run_aggregation_query, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Begins a new transaction.
             #
@@ -368,13 +484,18 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload begin_transaction(project_id: nil, transaction_options: nil)
+            # @overload begin_transaction(project_id: nil, database_id: nil, transaction_options: nil)
             #   Pass arguments to `begin_transaction` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param project_id [::String]
             #     Required. The ID of the project against which to make the request.
+            #   @param database_id [::String]
+            #     The ID of the database against which to make the request.
+            #
+            #     '(default)' is not allowed; please use empty string '' to refer the default
+            #     database.
             #   @param transaction_options [::Google::Cloud::Datastore::V1::TransactionOptions, ::Hash]
             #     Options for a new transaction.
             #
@@ -456,13 +577,18 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload commit(project_id: nil, mode: nil, transaction: nil, mutations: nil)
+            # @overload commit(project_id: nil, database_id: nil, mode: nil, transaction: nil, mutations: nil)
             #   Pass arguments to `commit` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param project_id [::String]
             #     Required. The ID of the project against which to make the request.
+            #   @param database_id [::String]
+            #     The ID of the database against which to make the request.
+            #
+            #     '(default)' is not allowed; please use empty string '' to refer the default
+            #     database.
             #   @param mode [::Google::Cloud::Datastore::V1::CommitRequest::Mode]
             #     The type of commit to perform. Defaults to `TRANSACTIONAL`.
             #   @param transaction [::String]
@@ -561,13 +687,18 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload rollback(project_id: nil, transaction: nil)
+            # @overload rollback(project_id: nil, database_id: nil, transaction: nil)
             #   Pass arguments to `rollback` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param project_id [::String]
             #     Required. The ID of the project against which to make the request.
+            #   @param database_id [::String]
+            #     The ID of the database against which to make the request.
+            #
+            #     '(default)' is not allowed; please use empty string '' to refer the default
+            #     database.
             #   @param transaction [::String]
             #     Required. The transaction identifier, returned by a call to
             #     {::Google::Cloud::Datastore::V1::Datastore::Client#begin_transaction Datastore.BeginTransaction}.
@@ -650,13 +781,18 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload allocate_ids(project_id: nil, keys: nil)
+            # @overload allocate_ids(project_id: nil, database_id: nil, keys: nil)
             #   Pass arguments to `allocate_ids` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param project_id [::String]
             #     Required. The ID of the project against which to make the request.
+            #   @param database_id [::String]
+            #     The ID of the database against which to make the request.
+            #
+            #     '(default)' is not allowed; please use empty string '' to refer the default
+            #     database.
             #   @param keys [::Array<::Google::Cloud::Datastore::V1::Key, ::Hash>]
             #     Required. A list of keys with incomplete key paths for which to allocate IDs.
             #     No key may be reserved/read-only.
@@ -747,7 +883,10 @@ module Google
             #   @param project_id [::String]
             #     Required. The ID of the project against which to make the request.
             #   @param database_id [::String]
-            #     If not empty, the ID of the database against which to make the request.
+            #     The ID of the database against which to make the request.
+            #
+            #     '(default)' is not allowed; please use empty string '' to refer the default
+            #     database.
             #   @param keys [::Array<::Google::Cloud::Datastore::V1::Key, ::Hash>]
             #     Required. A list of keys with complete key paths whose numeric IDs should not be
             #     auto-allocated.
@@ -962,6 +1101,11 @@ module Google
                 #
                 attr_reader :run_query
                 ##
+                # RPC-specific configuration for `run_aggregation_query`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :run_aggregation_query
+                ##
                 # RPC-specific configuration for `begin_transaction`
                 # @return [::Gapic::Config::Method]
                 #
@@ -993,6 +1137,8 @@ module Google
                   @lookup = ::Gapic::Config::Method.new lookup_config
                   run_query_config = parent_rpcs.run_query if parent_rpcs.respond_to? :run_query
                   @run_query = ::Gapic::Config::Method.new run_query_config
+                  run_aggregation_query_config = parent_rpcs.run_aggregation_query if parent_rpcs.respond_to? :run_aggregation_query
+                  @run_aggregation_query = ::Gapic::Config::Method.new run_aggregation_query_config
                   begin_transaction_config = parent_rpcs.begin_transaction if parent_rpcs.respond_to? :begin_transaction
                   @begin_transaction = ::Gapic::Config::Method.new begin_transaction_config
                   commit_config = parent_rpcs.commit if parent_rpcs.respond_to? :commit

data/lib/google/cloud/datastore/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Datastore
       module V1
-        VERSION = "0.5.0"
+        VERSION = "0.7.0"
       end
     end
   end

data/lib/google/datastore/v1/aggregation_result_pb.rb

@@ -0,0 +1,32 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/datastore/v1/aggregation_result.proto
+
+require 'google/protobuf'
+
+require 'google/datastore/v1/entity_pb'
+require 'google/datastore/v1/query_pb'
+require 'google/protobuf/timestamp_pb'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/datastore/v1/aggregation_result.proto", :syntax => :proto3) do
+    add_message "google.datastore.v1.AggregationResult" do
+      map :aggregate_properties, :string, :message, 2, "google.datastore.v1.Value"
+    end
+    add_message "google.datastore.v1.AggregationResultBatch" do
+      repeated :aggregation_results, :message, 1, "google.datastore.v1.AggregationResult"
+      optional :more_results, :enum, 2, "google.datastore.v1.QueryResultBatch.MoreResultsType"
+      optional :read_time, :message, 3, "google.protobuf.Timestamp"
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Datastore
+      module V1
+        AggregationResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.AggregationResult").msgclass
+        AggregationResultBatch = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.AggregationResultBatch").msgclass
+      end
+    end
+  end
+end

data/lib/google/datastore/v1/datastore_pb.rb

@@ -1,18 +1,21 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/datastore/v1/datastore.proto
 
+require 'google/protobuf'
+
 require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
+require 'google/datastore/v1/aggregation_result_pb'
 require 'google/datastore/v1/entity_pb'
 require 'google/datastore/v1/query_pb'
 require 'google/protobuf/timestamp_pb'
-require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/datastore/v1/datastore.proto", :syntax => :proto3) do
     add_message "google.datastore.v1.LookupRequest" do
       optional :project_id, :string, 8
+      optional :database_id, :string, 9
       optional :read_options, :message, 1, "google.datastore.v1.ReadOptions"
       repeated :keys, :message, 3, "google.datastore.v1.Key"
     end
@@ -24,6 +27,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.datastore.v1.RunQueryRequest" do
       optional :project_id, :string, 8
+      optional :database_id, :string, 9
       optional :partition_id, :message, 2, "google.datastore.v1.PartitionId"
       optional :read_options, :message, 1, "google.datastore.v1.ReadOptions"
       oneof :query_type do
@@ -35,8 +39,23 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :batch, :message, 1, "google.datastore.v1.QueryResultBatch"
       optional :query, :message, 2, "google.datastore.v1.Query"
     end
+    add_message "google.datastore.v1.RunAggregationQueryRequest" do
+      optional :project_id, :string, 8
+      optional :database_id, :string, 9
+      optional :partition_id, :message, 2, "google.datastore.v1.PartitionId"
+      optional :read_options, :message, 1, "google.datastore.v1.ReadOptions"
+      oneof :query_type do
+        optional :aggregation_query, :message, 3, "google.datastore.v1.AggregationQuery"
+        optional :gql_query, :message, 7, "google.datastore.v1.GqlQuery"
+      end
+    end
+    add_message "google.datastore.v1.RunAggregationQueryResponse" do
+      optional :batch, :message, 1, "google.datastore.v1.AggregationResultBatch"
+      optional :query, :message, 2, "google.datastore.v1.AggregationQuery"
+    end
     add_message "google.datastore.v1.BeginTransactionRequest" do
       optional :project_id, :string, 8
+      optional :database_id, :string, 9
       optional :transaction_options, :message, 10, "google.datastore.v1.TransactionOptions"
     end
     add_message "google.datastore.v1.BeginTransactionResponse" do
@@ -44,12 +63,14 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.datastore.v1.RollbackRequest" do
       optional :project_id, :string, 8
+      optional :database_id, :string, 9
       optional :transaction, :bytes, 1
     end
     add_message "google.datastore.v1.RollbackResponse" do
     end
     add_message "google.datastore.v1.CommitRequest" do
       optional :project_id, :string, 8
+      optional :database_id, :string, 9
       optional :mode, :enum, 5, "google.datastore.v1.CommitRequest.Mode"
       repeated :mutations, :message, 6, "google.datastore.v1.Mutation"
       oneof :transaction_selector do
@@ -68,6 +89,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.datastore.v1.AllocateIdsRequest" do
       optional :project_id, :string, 8
+      optional :database_id, :string, 9
       repeated :keys, :message, 1, "google.datastore.v1.Key"
     end
     add_message "google.datastore.v1.AllocateIdsResponse" do
@@ -133,6 +155,8 @@ module Google
         LookupResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.LookupResponse").msgclass
         RunQueryRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.RunQueryRequest").msgclass
         RunQueryResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.RunQueryResponse").msgclass
+        RunAggregationQueryRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.RunAggregationQueryRequest").msgclass
+        RunAggregationQueryResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.RunAggregationQueryResponse").msgclass
         BeginTransactionRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.BeginTransactionRequest").msgclass
         BeginTransactionResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.BeginTransactionResponse").msgclass
         RollbackRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.RollbackRequest").msgclass

data/lib/google/datastore/v1/datastore_services_pb.rb

@@ -43,6 +43,8 @@ module Google
             rpc :Lookup, ::Google::Cloud::Datastore::V1::LookupRequest, ::Google::Cloud::Datastore::V1::LookupResponse
             # Queries for entities.
             rpc :RunQuery, ::Google::Cloud::Datastore::V1::RunQueryRequest, ::Google::Cloud::Datastore::V1::RunQueryResponse
+            # Runs an aggregation query.
+            rpc :RunAggregationQuery, ::Google::Cloud::Datastore::V1::RunAggregationQueryRequest, ::Google::Cloud::Datastore::V1::RunAggregationQueryResponse
             # Begins a new transaction.
             rpc :BeginTransaction, ::Google::Cloud::Datastore::V1::BeginTransactionRequest, ::Google::Cloud::Datastore::V1::BeginTransactionResponse
             # Commits a transaction, optionally creating, deleting or modifying some

data/lib/google/datastore/v1/entity_pb.rb

@@ -1,15 +1,17 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/datastore/v1/entity.proto
 
+require 'google/protobuf'
+
 require 'google/protobuf/struct_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/type/latlng_pb'
-require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/datastore/v1/entity.proto", :syntax => :proto3) do
     add_message "google.datastore.v1.PartitionId" do
       optional :project_id, :string, 2
+      optional :database_id, :string, 3
       optional :namespace_id, :string, 4
     end
     add_message "google.datastore.v1.Key" do

data/lib/google/datastore/v1/query_pb.rb

@@ -1,10 +1,12 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/datastore/v1/query.proto
 
+require 'google/protobuf'
+
+require 'google/api/field_behavior_pb'
 require 'google/datastore/v1/entity_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/protobuf/wrappers_pb'
-require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/datastore/v1/query.proto", :syntax => :proto3) do
@@ -31,6 +33,21 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :offset, :int32, 10
       optional :limit, :message, 12, "google.protobuf.Int32Value"
     end
+    add_message "google.datastore.v1.AggregationQuery" do
+      repeated :aggregations, :message, 3, "google.datastore.v1.AggregationQuery.Aggregation"
+      oneof :query_type do
+        optional :nested_query, :message, 1, "google.datastore.v1.Query"
+      end
+    end
+    add_message "google.datastore.v1.AggregationQuery.Aggregation" do
+      optional :alias, :string, 7
+      oneof :operator do
+        optional :count, :message, 1, "google.datastore.v1.AggregationQuery.Aggregation.Count"
+      end
+    end
+    add_message "google.datastore.v1.AggregationQuery.Aggregation.Count" do
+      optional :up_to, :message, 1, "google.protobuf.Int64Value"
+    end
     add_message "google.datastore.v1.KindExpression" do
       optional :name, :string, 1
     end
@@ -119,6 +136,9 @@ module Google
         EntityResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.EntityResult").msgclass
         EntityResult::ResultType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.EntityResult.ResultType").enummodule
         Query = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.Query").msgclass
+        AggregationQuery = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.AggregationQuery").msgclass
+        AggregationQuery::Aggregation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.AggregationQuery.Aggregation").msgclass
+        AggregationQuery::Aggregation::Count = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.AggregationQuery.Aggregation.Count").msgclass
         KindExpression = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.KindExpression").msgclass
         PropertyReference = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.PropertyReference").msgclass
         Projection = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.Projection").msgclass

data/proto_docs/google/datastore/v1/aggregation_result.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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 Datastore
+      module V1
+        # The result of a single bucket from a Datastore aggregation query.
+        #
+        # The keys of `aggregate_properties` are the same for all results in an
+        # aggregation query, unlike entity queries which can have different fields
+        # present for each result.
+        # @!attribute [rw] aggregate_properties
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::Datastore::V1::Value}]
+        #     The result of the aggregation functions, ex: `COUNT(*) AS total_entities`.
+        #
+        #     The key is the {::Google::Cloud::Datastore::V1::AggregationQuery::Aggregation#alias alias}
+        #     assigned to the aggregation function on input and the size of this map
+        #     equals the number of aggregation functions in the query.
+        class AggregationResult
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::Datastore::V1::Value]
+          class AggregatePropertiesEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # A batch of aggregation results produced by an aggregation query.
+        # @!attribute [rw] aggregation_results
+        #   @return [::Array<::Google::Cloud::Datastore::V1::AggregationResult>]
+        #     The aggregation results for this batch.
+        # @!attribute [rw] more_results
+        #   @return [::Google::Cloud::Datastore::V1::QueryResultBatch::MoreResultsType]
+        #     The state of the query after the current batch.
+        #     Only COUNT(*) aggregations are supported in the initial launch. Therefore,
+        #     expected result type is limited to `NO_MORE_RESULTS`.
+        # @!attribute [rw] read_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Read timestamp this batch was returned from.
+        #
+        #     In a single transaction, subsequent query result batches for the same query
+        #     can have a greater timestamp. Each batch's read timestamp
+        #     is valid for all preceding batches.
+        class AggregationResultBatch
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/datastore/v1/datastore.rb

@@ -25,6 +25,12 @@ module Google
         # @!attribute [rw] project_id
         #   @return [::String]
         #     Required. The ID of the project against which to make the request.
+        # @!attribute [rw] database_id
+        #   @return [::String]
+        #     The ID of the database against which to make the request.
+        #
+        #     '(default)' is not allowed; please use empty string '' to refer the default
+        #     database.
         # @!attribute [rw] read_options
         #   @return [::Google::Cloud::Datastore::V1::ReadOptions]
         #     The options for this lookup request.
@@ -64,6 +70,12 @@ module Google
         # @!attribute [rw] project_id
         #   @return [::String]
         #     Required. The ID of the project against which to make the request.
+        # @!attribute [rw] database_id
+        #   @return [::String]
+        #     The ID of the database against which to make the request.
+        #
+        #     '(default)' is not allowed; please use empty string '' to refer the default
+        #     database.
         # @!attribute [rw] partition_id
         #   @return [::Google::Cloud::Datastore::V1::PartitionId]
         #     Entities are partitioned into subsets, identified by a partition ID.
@@ -78,7 +90,7 @@ module Google
         #     The query to run.
         # @!attribute [rw] gql_query
         #   @return [::Google::Cloud::Datastore::V1::GqlQuery]
-        #     The GQL query to run.
+        #     The GQL query to run. This query must be a non-aggregation query.
         class RunQueryRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -96,10 +108,58 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # The request for {::Google::Cloud::Datastore::V1::Datastore::Client#run_aggregation_query Datastore.RunAggregationQuery}.
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     Required. The ID of the project against which to make the request.
+        # @!attribute [rw] database_id
+        #   @return [::String]
+        #     The ID of the database against which to make the request.
+        #
+        #     '(default)' is not allowed; please use empty string '' to refer the default
+        #     database.
+        # @!attribute [rw] partition_id
+        #   @return [::Google::Cloud::Datastore::V1::PartitionId]
+        #     Entities are partitioned into subsets, identified by a partition ID.
+        #     Queries are scoped to a single partition.
+        #     This partition ID is normalized with the standard default context
+        #     partition ID.
+        # @!attribute [rw] read_options
+        #   @return [::Google::Cloud::Datastore::V1::ReadOptions]
+        #     The options for this query.
+        # @!attribute [rw] aggregation_query
+        #   @return [::Google::Cloud::Datastore::V1::AggregationQuery]
+        #     The query to run.
+        # @!attribute [rw] gql_query
+        #   @return [::Google::Cloud::Datastore::V1::GqlQuery]
+        #     The GQL query to run. This query must be an aggregation query.
+        class RunAggregationQueryRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response for {::Google::Cloud::Datastore::V1::Datastore::Client#run_aggregation_query Datastore.RunAggregationQuery}.
+        # @!attribute [rw] batch
+        #   @return [::Google::Cloud::Datastore::V1::AggregationResultBatch]
+        #     A batch of aggregation results. Always present.
+        # @!attribute [rw] query
+        #   @return [::Google::Cloud::Datastore::V1::AggregationQuery]
+        #     The parsed form of the `GqlQuery` from the request, if it was set.
+        class RunAggregationQueryResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # The request for {::Google::Cloud::Datastore::V1::Datastore::Client#begin_transaction Datastore.BeginTransaction}.
         # @!attribute [rw] project_id
         #   @return [::String]
         #     Required. The ID of the project against which to make the request.
+        # @!attribute [rw] database_id
+        #   @return [::String]
+        #     The ID of the database against which to make the request.
+        #
+        #     '(default)' is not allowed; please use empty string '' to refer the default
+        #     database.
         # @!attribute [rw] transaction_options
         #   @return [::Google::Cloud::Datastore::V1::TransactionOptions]
         #     Options for a new transaction.
@@ -121,6 +181,12 @@ module Google
         # @!attribute [rw] project_id
         #   @return [::String]
         #     Required. The ID of the project against which to make the request.
+        # @!attribute [rw] database_id
+        #   @return [::String]
+        #     The ID of the database against which to make the request.
+        #
+        #     '(default)' is not allowed; please use empty string '' to refer the default
+        #     database.
         # @!attribute [rw] transaction
         #   @return [::String]
         #     Required. The transaction identifier, returned by a call to
@@ -141,6 +207,12 @@ module Google
         # @!attribute [rw] project_id
         #   @return [::String]
         #     Required. The ID of the project against which to make the request.
+        # @!attribute [rw] database_id
+        #   @return [::String]
+        #     The ID of the database against which to make the request.
+        #
+        #     '(default)' is not allowed; please use empty string '' to refer the default
+        #     database.
         # @!attribute [rw] mode
         #   @return [::Google::Cloud::Datastore::V1::CommitRequest::Mode]
         #     The type of commit to perform. Defaults to `TRANSACTIONAL`.
@@ -204,6 +276,12 @@ module Google
         # @!attribute [rw] project_id
         #   @return [::String]
         #     Required. The ID of the project against which to make the request.
+        # @!attribute [rw] database_id
+        #   @return [::String]
+        #     The ID of the database against which to make the request.
+        #
+        #     '(default)' is not allowed; please use empty string '' to refer the default
+        #     database.
         # @!attribute [rw] keys
         #   @return [::Array<::Google::Cloud::Datastore::V1::Key>]
         #     Required. A list of keys with incomplete key paths for which to allocate IDs.
@@ -229,7 +307,10 @@ module Google
         #     Required. The ID of the project against which to make the request.
         # @!attribute [rw] database_id
         #   @return [::String]
-        #     If not empty, the ID of the database against which to make the request.
+        #     The ID of the database against which to make the request.
+        #
+        #     '(default)' is not allowed; please use empty string '' to refer the default
+        #     database.
         # @!attribute [rw] keys
         #   @return [::Array<::Google::Cloud::Datastore::V1::Key>]
         #     Required. A list of keys with complete key paths whose numeric IDs should not be
@@ -308,7 +389,6 @@ module Google
         # @!attribute [rw] read_consistency
         #   @return [::Google::Cloud::Datastore::V1::ReadOptions::ReadConsistency]
         #     The non-transactional read consistency to use.
-        #     Cannot be set to `STRONG` for global queries.
         # @!attribute [rw] transaction
         #   @return [::String]
         #     The identifier of the transaction in which to read. A

data/proto_docs/google/datastore/v1/entity.rb

@@ -43,6 +43,10 @@ module Google
         # @!attribute [rw] project_id
         #   @return [::String]
         #     The ID of the project to which the entities belong.
+        # @!attribute [rw] database_id
+        #   @return [::String]
+        #     If not empty, the ID of the database to which the entities
+        #     belong.
         # @!attribute [rw] namespace_id
         #   @return [::String]
         #     If not empty, the ID of the namespace to which the entities belong.
@@ -89,20 +93,31 @@ module Google
           # @!attribute [rw] kind
           #   @return [::String]
           #     The kind of the entity.
+          #
           #     A kind matching regex `__.*__` is reserved/read-only.
           #     A kind must not contain more than 1500 bytes when UTF-8 encoded.
           #     Cannot be `""`.
+          #
+          #     Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are
+          #     encoded as `__bytes<X>__` where `<X>` is the base-64 encoding of the
+          #     bytes.
           # @!attribute [rw] id
           #   @return [::Integer]
           #     The auto-allocated ID of the entity.
+          #
           #     Never equal to zero. Values less than zero are discouraged and may not
           #     be supported in the future.
           # @!attribute [rw] name
           #   @return [::String]
           #     The name of the entity.
+          #
           #     A name matching regex `__.*__` is reserved/read-only.
           #     A name must not be more than 1500 bytes when UTF-8 encoded.
           #     Cannot be `""`.
+          #
+          #     Must be valid UTF-8 bytes. Legacy values that are not valid UTF-8 are
+          #     encoded as `__bytes<X>__` where `<X>` is the base-64 encoding of the
+          #     bytes.
           class PathElement
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/datastore/v1/query.rb

@@ -116,6 +116,96 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Datastore query for running an aggregation over a {::Google::Cloud::Datastore::V1::Query Query}.
+        # @!attribute [rw] nested_query
+        #   @return [::Google::Cloud::Datastore::V1::Query]
+        #     Nested query for aggregation
+        # @!attribute [rw] aggregations
+        #   @return [::Array<::Google::Cloud::Datastore::V1::AggregationQuery::Aggregation>]
+        #     Optional. Series of aggregations to apply over the results of the `nested_query`.
+        #
+        #     Requires:
+        #
+        #     * A minimum of one and maximum of five aggregations per query.
+        class AggregationQuery
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Defines a aggregation that produces a single result.
+          # @!attribute [rw] count
+          #   @return [::Google::Cloud::Datastore::V1::AggregationQuery::Aggregation::Count]
+          #     Count aggregator.
+          # @!attribute [rw] alias
+          #   @return [::String]
+          #     Optional. Optional name of the property to store the result of the aggregation.
+          #
+          #     If not provided, Datastore will pick a default name following the format
+          #     `property_<incremental_id++>`. For example:
+          #
+          #     ```
+          #     AGGREGATE
+          #       COUNT_UP_TO(1) AS count_up_to_1,
+          #       COUNT_UP_TO(2),
+          #       COUNT_UP_TO(3) AS count_up_to_3,
+          #       COUNT_UP_TO(4)
+          #     OVER (
+          #       ...
+          #     );
+          #     ```
+          #
+          #     becomes:
+          #
+          #     ```
+          #     AGGREGATE
+          #       COUNT_UP_TO(1) AS count_up_to_1,
+          #       COUNT_UP_TO(2) AS property_1,
+          #       COUNT_UP_TO(3) AS count_up_to_3,
+          #       COUNT_UP_TO(4) AS property_2
+          #     OVER (
+          #       ...
+          #     );
+          #     ```
+          #
+          #     Requires:
+          #
+          #     * Must be unique across all aggregation aliases.
+          #     * Conform to {::Google::Cloud::Datastore::V1::Entity#properties entity property name} limitations.
+          class Aggregation
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Count of entities that match the query.
+            #
+            # The `COUNT(*)` aggregation function operates on the entire entity
+            # so it does not require a field reference.
+            # @!attribute [rw] up_to
+            #   @return [::Google::Protobuf::Int64Value]
+            #     Optional. Optional constraint on the maximum number of entities to count.
+            #
+            #     This provides a way to set an upper bound on the number of entities
+            #     to scan, limiting latency and cost.
+            #
+            #     Unspecified is interpreted as no bound.
+            #
+            #     If a zero value is provided, a count result of zero should always be
+            #     expected.
+            #
+            #     High-Level Example:
+            #
+            #     ```
+            #     AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k );
+            #     ```
+            #
+            #     Requires:
+            #
+            #     * Must be non-negative when present.
+            class Count
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+        end
+
         # A representation of a kind.
         # @!attribute [rw] name
         #   @return [::String]
@@ -187,7 +277,10 @@ module Google
         # @!attribute [rw] filters
         #   @return [::Array<::Google::Cloud::Datastore::V1::Filter>]
         #     The list of filters to combine.
-        #     Must contain at least one filter.
+        #
+        #     Requires:
+        #
+        #     * At least one filter is present.
         class CompositeFilter
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/protobuf/struct.rb

@@ -46,8 +46,8 @@ module Google
 
     # `Value` represents a dynamically typed value which can be either
     # null, a number, a string, a boolean, a recursive struct value, or a
-    # list of values. A producer of value is expected to set one of that
-    # variants, absence of any variant indicates an error.
+    # list of values. A producer of value is expected to set one of these
+    # variants. Absence of any variant indicates an error.
     #
     # The JSON representation for `Value` is JSON value.
     # @!attribute [rw] null_value

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-datastore-v1
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-20 00:00:00.000000000 Z
+date: 2022-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.12'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.12'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -50,28 +50,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.1
+        version: 1.26.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.1
+        version: 1.26.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.14'
+        version: '5.16'
 - !ruby/object:Gem::Dependency
   name: minitest-focus
   requirement: !ruby/object:Gem::Requirement
@@ -106,14 +106,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -175,6 +175,7 @@ files:
 - lib/google/cloud/datastore/v1/datastore/client.rb
 - lib/google/cloud/datastore/v1/datastore/credentials.rb
 - lib/google/cloud/datastore/v1/version.rb
+- lib/google/datastore/v1/aggregation_result_pb.rb
 - lib/google/datastore/v1/datastore_pb.rb
 - lib/google/datastore/v1/datastore_services_pb.rb
 - lib/google/datastore/v1/entity_pb.rb
@@ -182,6 +183,7 @@ files:
 - proto_docs/README.md
 - proto_docs/google/api/field_behavior.rb
 - proto_docs/google/api/resource.rb
+- proto_docs/google/datastore/v1/aggregation_result.rb
 - proto_docs/google/datastore/v1/datastore.rb
 - proto_docs/google/datastore/v1/entity.rb
 - proto_docs/google/datastore/v1/query.rb
@@ -201,14 +203,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.3.14
 signing_key: 
 specification_version: 4
 summary: API Client library for the Firestore in Datastore mode V1 API