google-cloud-datastore 2.7.1 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 646ed90d461784d6870d425a6f98271a249338a72696200b3b2707d3e4725098
-  data.tar.gz: 963afff082dd55de2dce0f58715bd76c17497e118b0db92b7a542b6dd813b00d
+  metadata.gz: 6c062edd7866b2d8f56365618cdbfca915d1df66440e9bdfca54d4e85bbc0133
+  data.tar.gz: c4085c6ba18cd98c6ec7f38b6487dfbab56dd00030eb3dcad70afa184772056e
 SHA512:
-  metadata.gz: 832baf39842dd1261ee5394284a0cc8448bd65fbf08162cc49a95f16654676f4dae76d4cb80be58a2692f7035f613b3b1668bf6e5f7d73f175a3f3ad7d6e3eb0
-  data.tar.gz: dd2b0d16cf4727a342e305a6c3dee82add4ce10f5faac8c691216e9e4a88d356d89cb49684cc71b92bfe162bc9aa099abca54c260698ca96722400a729a952e7
+  metadata.gz: 9621f21518ea67ebedcd0230f16b240976152d99133b2e0e4ecb7a770e92079e47a44868925cb7ac4aaeef8030a6138ef2842836749b4274c9a5ada151eeae28
+  data.tar.gz: 0dbf0d457be8a4b94e6be54a7eaae13ea31113d818025ed59905fc3c7bbd64c3c10bff2fbb36519f3a94cd17f0b901bfb9029d837e5a4c36f73282ef39012997

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+### 2.8.0 (2023-09-12)
+
+#### Features
+
+* Support sum & avg aggregate functions ([#22884](https://github.com/googleapis/google-cloud-ruby/issues/22884)) 
+
 ### 2.7.1 (2023-05-18)
 
 #### Documentation

data/lib/google/cloud/datastore/aggregate_query.rb

@@ -56,6 +56,15 @@ module Google
       #   puts aggregate_query_results.get('total')
       #
       class AggregateQuery
+        # @private
+        DEFAULT_COUNT_AGGREGATE_ALIAS = "count".freeze
+
+        # @private
+        DEFAULT_SUM_AGGREGATE_ALIAS = "sum".freeze
+
+        # @private
+        DEFAULT_AVG_AGGREGATE_ALIAS = "avg".freeze
+
         ##
         # @private The Google::Cloud::Datastore::V1::AggregationQuery object.
         attr_reader :grpc
@@ -113,7 +122,7 @@ module Google
         #   puts aggregate_query_results.get('total')
         #
         def add_count aggregate_alias: nil
-          aggregate_alias ||= ALIASES[:count]
+          aggregate_alias ||= DEFAULT_COUNT_AGGREGATE_ALIAS
           @grpc.aggregations << Google::Cloud::Datastore::V1::AggregationQuery::Aggregation.new(
             count: Google::Cloud::Datastore::V1::AggregationQuery::Aggregation::Count.new,
             alias: aggregate_alias
@@ -122,16 +131,118 @@ module Google
           self
         end
 
-        # @private
-        def to_grpc
-          @grpc
+        ##
+        # Adds a sum aggregate.
+        #
+        # @param name [String] The property to sum by.
+        # @param aggregate_alias [String] Alias to refer to the aggregate. Optional
+        #
+        # @return [AggregateQuery] The modified aggregate query object with the added SUM aggregate.
+        #
+        # @example
+        #   require "google/cloud/datastore"
+        #
+        #   datastore = Google::Cloud::Datastore.new
+        #
+        #   query = Google::Cloud::Datastore::Query.new
+        #   query.kind("Task")
+        #        .where("done", "=", false)
+        #
+        #   Create an aggregate query
+        #   aggregate_query = query.aggregate_query
+        #                          .add_sum("score")
+        #
+        #   aggregate_query_results = dataset.run_aggregation aggregate_query
+        #   puts aggregate_query_results.get
+        #
+        # @example Alias an aggregate SUM query
+        #   require "google/cloud/datastore"
+        #
+        #   datastore = Google::Cloud::Datastore.new
+        #
+        #   query = Google::Cloud::Datastore::Query.new
+        #   query.kind("Task")
+        #        .where("done", "=", false)
+        #
+        #   # Create an aggregate query
+        #   aggregate_query = query.aggregate_query
+        #                          .add_sum("score", aggregate_alias: 'total_score')
+        #
+        #   aggregate_query_results = dataset.run_aggregation aggregate_query
+        #   puts aggregate_query_results.get('total_score')
+        #
+        def add_sum name, aggregate_alias: nil
+          aggregate_alias ||= DEFAULT_SUM_AGGREGATE_ALIAS
+          @grpc.aggregations << Google::Cloud::Datastore::V1::AggregationQuery::Aggregation.new(
+            sum: Google::Cloud::Datastore::V1::AggregationQuery::Aggregation::Sum.new(
+              property: Google::Cloud::Datastore::V1::PropertyReference.new(
+                name: name
+              )
+            ),
+            alias: aggregate_alias
+          )
+
+          self
         end
 
         ##
+        # Adds an average aggregate.
+        #
+        # @param name [String] The property to apply average on.
+        # @param aggregate_alias [String] Alias to refer to the aggregate. Optional
+        #
+        # @return [AggregateQuery] The modified aggregate query object with the added AVG aggregate.
+        #
+        # @example
+        #   require "google/cloud/datastore"
+        #
+        #   datastore = Google::Cloud::Datastore.new
+        #
+        #   query = Google::Cloud::Datastore::Query.new
+        #   query.kind("Task")
+        #        .where("done", "=", false)
+        #
+        #   Create an aggregate query
+        #   aggregate_query = query.aggregate_query
+        #                          .add_avg("score")
+        #
+        #   aggregate_query_results = dataset.run_aggregation aggregate_query
+        #   puts aggregate_query_results.get
+        #
+        # @example Alias an aggregate AVG query
+        #   require "google/cloud/datastore"
+        #
+        #   datastore = Google::Cloud::Datastore.new
+        #
+        #   query = Google::Cloud::Datastore::Query.new
+        #   query.kind("Task")
+        #        .where("done", "=", false)
+        #
+        #   # Create an aggregate query
+        #   aggregate_query = query.aggregate_query
+        #                          .add_avg("score", aggregate_alias: 'avg_score')
+        #
+        #   aggregate_query_results = dataset.run_aggregation aggregate_query
+        #   puts aggregate_query_results.get('avg_score')
+        #
+        def add_avg name, aggregate_alias: nil
+          aggregate_alias ||= DEFAULT_AVG_AGGREGATE_ALIAS
+          @grpc.aggregations << Google::Cloud::Datastore::V1::AggregationQuery::Aggregation.new(
+            avg: Google::Cloud::Datastore::V1::AggregationQuery::Aggregation::Avg.new(
+              property: Google::Cloud::Datastore::V1::PropertyReference.new(
+                name: name
+              )
+            ),
+            alias: aggregate_alias
+          )
+
+          self
+        end
+
         # @private
-        ALIASES = {
-          count: "count"
-        }.freeze
+        def to_grpc
+          @grpc
+        end
       end
     end
   end

data/lib/google/cloud/datastore/dataset/aggregate_query_results.rb

@@ -39,6 +39,17 @@ module Google
         #   puts aggregate_query_results.get
         #
         class AggregateQueryResults
+          ##
+          # @private Object of type [Hash{String => Object}].
+          #
+          # String can have the following values:
+          #   - an aggregate literal "sum", "avg", or "count"
+          #   - a custom aggregate alias
+          # Object can have the following types:
+          #   - Integer
+          #   - Float
+          attr_reader :aggregate_fields
+
           ##
           # Read timestamp the query was done on the database at.
           #
@@ -52,7 +63,8 @@ module Google
           #   the aggregate value. For an AggregateQuery with a
           #   single aggregate field, this parameter can be omitted.
           #
-          # @return [Integer] The aggregate value.
+          # @return [Integer, Float, nil] The aggregate value. Returns `nil`
+          # if the aggregate_alias does not exist.
           #
           # @example
           #   require "google/cloud/datastore"
@@ -101,8 +113,15 @@ module Google
                                .batch
                                .aggregation_results[0]
                                .aggregate_properties
+                               .map do |aggregate_alias, value|
+                                 if value.has_integer_value?
+                                   [aggregate_alias, value.integer_value]
+                                 else
+                                   [aggregate_alias, value.double_value]
+                                 end
+                               end
                                .to_h
-                               .transform_values { |v| v[:integer_value] }
+
             new.tap do |s|
               s.instance_variable_set :@aggregate_fields, aggregate_fields
               s.instance_variable_set :@read_time, aggregate_query_response.batch.read_time

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Datastore
-      VERSION = "2.7.1".freeze
+      VERSION = "2.8.0".freeze
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-datastore
 version: !ruby/object:Gem::Version
-  version: 2.7.1
+  version: 2.8.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-19 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -238,7 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Datastore