active_hll 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9014f39ae62f6db1066d4933bc28485ecc57e788922d70437c4744edfb0c033
-  data.tar.gz: 91320d88909c41e425966993e145b9ff8aa5b57c6c3ac0556dc3661519691968
+  metadata.gz: a357d4e04aad048c5abddf17021edde474073438414e6d85e3f48748ff1fc304
+  data.tar.gz: '03031590842b88853c7028e5a45174ff104f674ecf86e235f64fdb7120435c23'
 SHA512:
-  metadata.gz: c55980654230a259a249a24b959c18b054d8e41773653bcc5411dbbbe3200fdd35c65dcfe729ed042943a8f2e81e26843c696d4989840fa43384622e3d56614f
-  data.tar.gz: 5285ca0005787997dec664512b0bc6796201a8a4bd719e0ce0b9f6efa50096f3a3e7ade096db6ba943e9f84630b2a92c5d9b3a53a4a0b744cc4162e87d6c2990
+  metadata.gz: 2efc0fc07d80ae37f2063388151bfe3b0a7459d584a03b51661b1010f64b03d8e8b275e65664f859e77fb6c1fa48840ef3f7cae706f37c23afbefe6d358fe04f
+  data.tar.gz: 29c3beb46f85e6a58ed522a4503414b4cbb2f322c5563c26a07a38e2160d84058c3c79ace3dd17165f961b76d7313b8e5c4f906b52d52106fa8d5713bccb8ffc

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.2.0 (2024-06-24)
+
+- Dropped support for Ruby < 3.1 and Active Record < 6.1
+
+## 0.1.1 (2023-01-29)
+
+- Added experimental `hll_upsert` method
+
 ## 0.1.0 (2023-01-24)
 
 - First release

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023 Andrew Kane
+Copyright (c) 2023-2024 Andrew Kane
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -4,7 +4,7 @@
 
 For fast, approximate count-distinct queries
 
-[![Build Status](https://github.com/ankane/active_hll/workflows/build/badge.svg?branch=master)](https://github.com/ankane/active_hll/actions)
+[![Build Status](https://github.com/ankane/active_hll/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/active_hll/actions)
 
 ## Installation
 
@@ -12,8 +12,8 @@ First, install the [hll extension](https://github.com/citusdata/postgresql-hll)
 
 ```sh
 cd /tmp
-curl -L https://github.com/citusdata/postgresql-hll/archive/refs/tags/v2.17.tar.gz | tar xz
-cd postgresql-hll-2.17
+curl -L https://github.com/citusdata/postgresql-hll/archive/refs/tags/v2.18.tar.gz | tar xz
+cd postgresql-hll-2.18
 make
 make install # may need sudo
 ```
@@ -39,7 +39,7 @@ HLLs provide an approximate count of unique values (like unique visitors). By ro
 Create a table with an `hll` column
 
 ```ruby
-class CreateEventRollups < ActiveRecord::Migration[7.0]
+class CreateEventRollups < ActiveRecord::Migration[7.1]
   def change
     create_table :event_rollups do |t|
       t.date :time_bucket, index: {unique: true}
@@ -53,7 +53,7 @@ You can use [batch](#batch) and [stream](#stream) approaches to build HLLs
 
 ### Batch
 
-Use the `hll_agg` method to generate HLLs from existing data
+To generate HLLs from existing data, use the `hll_agg` method
 
 ```ruby
 hlls = Event.group_by_day(:created_at).hll_agg(:visitor_id)
@@ -74,12 +74,18 @@ For a large number of HLLs, use SQL to generate and upsert in a single statement
 
 ### Stream
 
-Use the `hll_add` method to add new data to HLLs
+To add new data to HLLs, use the `hll_add` method
 
 ```ruby
 EventRollup.where(time_bucket: Date.current).hll_add(visitor_ids: ["visitor1", "visitor2"])
 ```
 
+or the `hll_upsert` method (experimental)
+
+```ruby
+EventRollup.hll_upsert({time_bucket: Date.current, visitor_ids: ["visitor1", "visitor2"]})
+```
+
 ## Querying
 
 Get approximate unique values for a time range
@@ -132,7 +138,7 @@ There’s not a way to remove data from an HLL, so to delete data for a specific
 
 ## Hosted Postgres
 
-The `hll` extension is available on Amazon RDS, Google Cloud SQL, and DigitalOcean Managed Databases.
+The `hll` extension is available on a number of [hosted providers](https://github.com/ankane/active_hll/issues/4).
 
 ## History
 

data/lib/active_hll/model.rb

@@ -50,6 +50,36 @@ module ActiveHll
 
         update_all(set_clauses.join(", "))
       end
+
+      # experimental
+      def hll_upsert(attributes)
+        hll_columns, other_columns = attributes.keys.partition { |a| columns_hash[a.to_s]&.type == :hll }
+
+        # important! raise if column detection fails
+        if hll_columns.empty?
+          raise ArgumentError, "No hll columns"
+        end
+
+        quoted_table = connection.quote_table_name(table_name)
+
+        quoted_hll_columns = hll_columns.map { |k| connection.quote_column_name(k) }
+        quoted_other_columns = other_columns.map { |k| connection.quote_column_name(k) }
+        quoted_columns = quoted_other_columns + quoted_hll_columns
+
+        hll_values =
+          hll_columns.map do |k|
+            vs = attributes[k]
+            vs = [vs] unless vs.is_a?(Array)
+            vs.map { |v| Utils.hll_hash_sql(self, v) }.join(" || ")
+          end
+        other_values = other_columns.map { |k| connection.quote(attributes[k]) }
+
+        insert_values = other_values + hll_values.map { |v| "hll_empty()#{v.size > 0 ? " || #{v}" : ""}" }
+        update_values = quoted_hll_columns.zip(hll_values).map { |k, v| "#{k} = COALESCE(#{quoted_table}.#{k}, hll_empty())#{v.size > 0 ? " || #{v}" : ""}" }
+
+        sql = "INSERT INTO #{quoted_table} (#{quoted_columns.join(", ")}) VALUES (#{insert_values.join(", ")}) ON CONFLICT (#{quoted_other_columns.join(", ")}) DO UPDATE SET #{update_values.join(", ")}"
+        connection.exec_insert(sql, "#{name} Upsert")
+      end
     end
 
     # doesn't update in-memory record attribute for performance

data/lib/active_hll/utils.rb

@@ -46,7 +46,7 @@ module ActiveHll
         # matches table.column and column
         unless column.is_a?(Symbol) || column.is_a?(Arel::Nodes::SqlLiteral)
           column = column.to_s
-          unless /\A\w+(\.\w+)?\z/i.match(column)
+          unless /\A\w+(\.\w+)?\z/i.match?(column)
             raise ActiveRecord::UnknownAttributeReference, "Query method called with non-attribute argument(s): #{column.inspect}. Use Arel.sql() for known-safe values."
           end
         end

data/lib/active_hll/version.rb

@@ -1,3 +1,3 @@
 module ActiveHll
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_hll
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-24 00:00:00.000000000 Z
+date: 2024-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.1'
 description:
 email: andrew@ankane.org
 executables: []
@@ -53,14 +53,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: HyperLogLog for Rails and Postgres