composite_primary_keys 13.0.4 → 13.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 875a5dc3886b5b887bbcb77bdcb0bfa40ad377e5084fd1bcdf3a71b5c226dbc3
-  data.tar.gz: 9cad15004b91f80917564f623855836217c2ce8e745eb5e6fc47464f10c7cf0c
+  metadata.gz: 397760c82733f99fafe1596036951df80ad7c440f6b6a8a4362e65459d2a5be9
+  data.tar.gz: 79b3579f453a63fa55f0474ca5f941d85e647714e9fdd892ca441eb500ad21e2
 SHA512:
-  metadata.gz: f771c6c4266eb770f685c7fc0960c344c10b7666a24240c59b456afa2c4c52c058e530e8e3d1ddfb4575468eb5eaf30a77b141216820eb028d774fc9f9593326
-  data.tar.gz: 33d2e087cdfc10ea336038a5ffabdb5dd878133ba11ed874ee2d6bd7cf5e572f9acf8b3a996bf04b402c161ffe49d2237ae7284266b58e6eed98b53a890ca7e5
+  metadata.gz: c4dfc8b13e54c9d4d7e761f545aacc262ad569681593175f29cf53040cfbd6ebf4a5d24b4e2698b0d6a90eb703650ce983f25410ca2cb8706d5776bcfa1c27a9
+  data.tar.gz: a7e17419407f1621c17c523594d80281dbbb1d16acde923678fd847d2d386c611f13d4b40a0e35c2532f22a8f63a7bdc888e5bfd3a258ece8f7e52c5a50bf61d

data/History.rdoc

@@ -1,4 +1,9 @@
-== 13.0.4
+== 13.0.5 (2023-02-04)
+* Improve query generation for cpk_in_predicate. This reduces the length of
+queries when loading many keys and enables Postgres to use index scans
+more frequently. (Andrew Kiellor)
+
+== 13.0.4 (2022-12-05)
 * Fix previously_new_record? not being set to true after create
 
 == 13.0.3 (2022-01-09)

data/lib/composite_primary_keys/composite_predicates.rb

@@ -51,9 +51,59 @@ module CompositePrimaryKeys
     end
 
     def cpk_in_predicate(table, primary_keys, ids)
+      if primary_keys.length == 2
+        cpk_in_predicate_with_grouped_keys(table, primary_keys, ids)
+      else
+        cpk_in_predicate_with_non_grouped_keys(table, primary_keys, ids)
+      end
+    end
+
+    def cpk_in_predicate_with_non_grouped_keys(table, primary_keys, ids)
       and_predicates = ids.map do |id|
         cpk_id_predicate(table, primary_keys, id)
       end
+
+      cpk_or_predicate(and_predicates)
+    end
+
+    def cpk_in_predicate_with_grouped_keys(table, primary_keys, ids)
+      keys_by_first_column_name = Hash.new { |hash, key| hash[key] = [] }
+      keys_by_second_column_name = Hash.new { |hash, key| hash[key] = [] }
+
+      ids.map.each do |first_key_part, second_key_part|
+        keys_by_first_column_name[first_key_part] << second_key_part
+        keys_by_second_column_name[second_key_part] << first_key_part
+      end
+
+      low_cardinality_column_name, high_cardinality_column_name, groups = \
+        if keys_by_first_column_name.size <= keys_by_second_column_name.size
+          [primary_keys.first, primary_keys.second, keys_by_first_column_name]
+        else
+          [primary_keys.second, primary_keys.first, keys_by_second_column_name]
+        end
+
+      and_predicates = groups.map do |low_cardinality_value, high_cardinality_values|
+        non_nil_high_cardinality_values = high_cardinality_values.compact
+        in_clause = table[high_cardinality_column_name].in(non_nil_high_cardinality_values)
+        inclusion_clauses = if non_nil_high_cardinality_values.size != high_cardinality_values.size
+                              Arel::Nodes::Grouping.new(
+                                Arel::Nodes::Or.new(
+                                  in_clause,
+                                  table[high_cardinality_column_name].eq(nil)
+                                )
+                              )
+                            else
+                              in_clause
+                            end
+
+        Arel::Nodes::And.new(
+          [
+            table[low_cardinality_column_name].eq(low_cardinality_value),
+            inclusion_clauses
+          ]
+        )
+      end
+
       cpk_or_predicate(and_predicates)
     end
   end

data/lib/composite_primary_keys/version.rb

@@ -2,7 +2,7 @@ module CompositePrimaryKeys
   module VERSION
     MAJOR = 13
     MINOR = 0
-    TINY  = 4
+    TINY  = 5
     STRING = [MAJOR, MINOR, TINY].join('.')
   end
 end

data/test/test_predicates.rb

@@ -1,60 +1,130 @@
-require File.expand_path('../abstract_unit', __FILE__)
-
-class TestPredicates < ActiveSupport::TestCase
-  fixtures :departments
-
-  include CompositePrimaryKeys::Predicates
-
-  def test_or
-    dep = Department.arel_table
-
-    predicates = Array.new
-
-    3.times do |i|
-      predicates << dep[:id].eq(i)
-    end
-
-    connection = ActiveRecord::Base.connection
-    quoted = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('id')}"
-    expected = "(#{quoted} = 0 OR #{quoted} = 1 OR #{quoted} = 2)"
-
-    pred = cpk_or_predicate(predicates)
-    assert_equal(with_quoted_identifiers(expected), pred.to_sql)
-  end
-
-  def test_or_with_many_values
-    dep = Arel::Table.new(:departments)
-
-    predicates = Array.new
-
-    number_of_predicates = 3000 # This should really be big
-    number_of_predicates.times do |i|
-      predicates << dep[:id].eq(i)
-    end
-
-    connection = ActiveRecord::Base.connection
-    quoted = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('id')}"
-    expected_ungrouped = ((0...number_of_predicates).map { |i| "#{quoted} = #{i}" }).join(' OR ')
-    expected = "(#{expected_ungrouped})"
-
-    pred = cpk_or_predicate(predicates)
-    assert_equal(with_quoted_identifiers(expected), pred.to_sql)
-  end
-
-  def test_and
-    dep = Department.arel_table
-
-    predicates = Array.new
-
-    3.times do |i|
-      predicates << dep[:id].eq(i)
-    end
-
-    connection = ActiveRecord::Base.connection
-    quoted = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('id')}"
-    expected = "#{quoted} = 0 AND #{quoted} = 1 AND #{quoted} = 2"
-
-    pred = cpk_and_predicate(predicates)
-    assert_equal(with_quoted_identifiers(expected), pred.to_sql)
-  end
-end
+require File.expand_path('../abstract_unit', __FILE__)
+
+class TestPredicates < ActiveSupport::TestCase
+  fixtures :departments
+
+  include CompositePrimaryKeys::Predicates
+
+  def test_or
+    dep = Department.arel_table
+
+    predicates = Array.new
+
+    3.times do |i|
+      predicates << dep[:id].eq(i)
+    end
+
+    connection = ActiveRecord::Base.connection
+    quoted = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('id')}"
+    expected = "(#{quoted} = 0 OR #{quoted} = 1 OR #{quoted} = 2)"
+
+    pred = cpk_or_predicate(predicates)
+    assert_equal(with_quoted_identifiers(expected), pred.to_sql)
+  end
+
+  def test_or_with_many_values
+    dep = Arel::Table.new(:departments)
+
+    predicates = Array.new
+
+    number_of_predicates = 3000 # This should really be big
+    number_of_predicates.times do |i|
+      predicates << dep[:id].eq(i)
+    end
+
+    connection = ActiveRecord::Base.connection
+    quoted = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('id')}"
+    expected_ungrouped = ((0...number_of_predicates).map { |i| "#{quoted} = #{i}" }).join(' OR ')
+    expected = "(#{expected_ungrouped})"
+
+    pred = cpk_or_predicate(predicates)
+    assert_equal(with_quoted_identifiers(expected), pred.to_sql)
+  end
+
+  def test_and
+    dep = Department.arel_table
+
+    predicates = Array.new
+
+    3.times do |i|
+      predicates << dep[:id].eq(i)
+    end
+
+    connection = ActiveRecord::Base.connection
+    quoted = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('id')}"
+    expected = "#{quoted} = 0 AND #{quoted} = 1 AND #{quoted} = 2"
+
+    pred = cpk_and_predicate(predicates)
+    assert_equal(with_quoted_identifiers(expected), pred.to_sql)
+  end
+
+  def test_in
+    dep = Department.arel_table
+
+    primary_keys = [[1, 1], [1, 2]]
+
+    connection = ActiveRecord::Base.connection
+    quoted_id_column = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('id')}"
+    quoted_location_id_column = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('location_id')}"
+    expected = "#{quoted_id_column} = 1 AND #{quoted_location_id_column} IN (1, 2)"
+
+    pred = cpk_in_predicate(dep, [:id, :location_id], primary_keys)
+    assert_equal(with_quoted_identifiers(expected), pred.to_sql)
+  end
+
+  def test_in_with_low_cardinality_second_key_part
+    dep = Department.arel_table
+
+    primary_keys = [[1, 1], [2, 1]]
+
+    connection = ActiveRecord::Base.connection
+    quoted_id_column = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('id')}"
+    quoted_location_id_column = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('location_id')}"
+    expected = "#{quoted_location_id_column} = 1 AND #{quoted_id_column} IN (1, 2)"
+
+    pred = cpk_in_predicate(dep, [:id, :location_id], primary_keys)
+    assert_equal(with_quoted_identifiers(expected), pred.to_sql)
+  end
+
+  def test_in_with_nil_primary_key_part
+    dep = Department.arel_table
+
+    primary_keys = [[nil, 1], [nil, 2]]
+
+    connection = ActiveRecord::Base.connection
+    quoted_id_column = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('id')}"
+    quoted_location_id_column = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('location_id')}"
+    expected = "#{quoted_id_column} IS NULL AND #{quoted_location_id_column} IN (1, 2)"
+
+    pred = cpk_in_predicate(dep, [:id, :location_id], primary_keys)
+    assert_equal(with_quoted_identifiers(expected), pred.to_sql)
+  end
+
+  def test_in_with_nil_secondary_key_part
+    dep = Department.arel_table
+
+    primary_keys = [[1, 1], [1, nil]]
+
+    connection = ActiveRecord::Base.connection
+    quoted_id_column = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('id')}"
+    quoted_location_id_column = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('location_id')}"
+    expected = "#{quoted_id_column} = 1 AND (#{quoted_location_id_column} IN (1) OR #{quoted_location_id_column} IS NULL)"
+
+    pred = cpk_in_predicate(dep, [:id, :location_id], primary_keys)
+    assert_equal(with_quoted_identifiers(expected), pred.to_sql)
+  end
+
+  def test_in_with_multiple_primary_key_parts
+    dep = Department.arel_table
+
+    primary_keys = [[1, 1], [1, 2], [2, 3], [2, 4]]
+
+    connection = ActiveRecord::Base.connection
+    quoted_id_column = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('id')}"
+    quoted_location_id_column = "#{connection.quote_table_name('departments')}.#{connection.quote_column_name('location_id')}"
+    expected = "(#{quoted_id_column} = 1 AND #{quoted_location_id_column} IN (1, 2) OR #{quoted_id_column} = 2 AND #{quoted_location_id_column} IN (3, 4))"
+
+    pred = cpk_in_predicate(dep, [:id, :location_id], primary_keys)
+    assert_equal(with_quoted_identifiers(expected), pred.to_sql)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: composite_primary_keys
 version: !ruby/object:Gem::Version
-  version: 13.0.4
+  version: 13.0.5
 platform: ruby
 authors:
 - Charlie Savage
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
+date: 2023-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -216,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Composite key support for ActiveRecord