code0-zero_track 0.0.8 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6150c745af141848ee0848ec9beda4db5c1809ece022f90b9006cf69df88f10
-  data.tar.gz: 73128d1d5ab33dec7887b195831c8a1b591eb46999c5cb4e20eb79387d5d138e
+  metadata.gz: b7bc699d8f0bb3f1237eeb8ff75493624930bc8cce4b97ba1666709c494d4d04
+  data.tar.gz: aac0a33b9d880e0fd9f5a6297b76f0dd32c5f42f6beccad0afeea412caa78bd9
 SHA512:
-  metadata.gz: 129416f538b904432c213a42a22d95244220fb9c35548b089d9a9ef4836b11b1b3fd0a93c910ab748dfd51d024d56d00ac525e7fd22855330916462b848a3824
-  data.tar.gz: 78bba0f4d37e6a08b2d5b02a46478060e7ea944ee8a40c407a4f63c819c450ae41e86b33df9b47a28472ebb202dad28a49c2c95fa221de041d672de1164e8a6d
+  metadata.gz: 60edef2bb7d288aeb3127068d6d58099cb409b659a5401a62db2844317cd4aa7048f7b8146ae59234f0e2c3c20e4af1a2e94ef91ac0561c62987f9977193e1c6
+  data.tar.gz: 02f209d8121437c829735e11bb9896c0991f2927d484da5c5f8f1f52c1cb7dd6d2363581f4d9886f285052339685ae942972666d497db6e03e6f25a0ed5b0c86

data/README.md

@@ -87,9 +87,10 @@ config.zero_track.db_partitioning.base_ar_class = 'ActiveRecord::Base' # default
 Include the migration helpers by inheriting from `Code0::ZeroTrack::Database::Migration[1.0]` (or the
 appropriate version). The following methods become available:
 
-`create_partition_by_date_table(table_name, partition_column:, **options, &block)` creates a table
-partitioned by range on the given column. It automatically sets up a composite primary key
-of `(id, partition_column)`.
+`create_partition_by_date_table(table_name, partition_column:, primary_key: nil, **options, &block)` creates a table
+partitioned by range on the given column. By default, it adds a `bigserial` id column and sets up a composite
+primary key of `(id, partition_column)`. If `primary_key` is provided (e.g. `primary_key: %i[date other_column]`),
+the id column is omitted and the given columns are used as the primary key instead.
 
 `create_dynamic_partition_schema` / `drop_dynamic_partition_schema` creates or drops the schema
 used for storing dynamic partitions.
@@ -188,6 +189,9 @@ When tables have foreign key relationships, registration order and retention con
 - A child table's `retain_for` must be less than or equal to the parent table's `retain_for`.
   If a child retains partitions longer than its parent, dropping the parent partition will
   fail because the child's foreign key still references it.
+- Foreign keys between the partitioned tables must be declared with `drop_foreign_keys_on_detach`
+  on the model. Otherwise, the foreign key of a detached partition will block detaching partitions
+  of the referenced table.
 
 #### Schema Cleaner Integration
 

data/lib/code0/zero_track/database/migration_helpers/table_partitioning.rb

@@ -5,21 +5,23 @@ module Code0
     module Database
       module MigrationHelpers
         module TablePartitioning
-          def create_partition_by_date_table(table_name, partition_column:, **options, &block)
+          def create_partition_by_date_table(table_name, partition_column:, primary_key: nil, **options, &block)
             options[:options] = "PARTITION BY RANGE (#{quote_column_name(partition_column)})"
             options[:id] = false
 
             create_table(table_name, **options) do |t|
-              t.bigserial :id, null: false
+              t.bigserial :id, null: false unless primary_key
 
               block.call(t)
             end
 
+            pk_columns = primary_key || [:id, partition_column]
+
             reversible do |dir|
               dir.up do
                 execute <<~SQL.squish
                   ALTER TABLE #{quote_table_name(table_name)}
-                  ADD PRIMARY KEY (#{quote_column_name(:id)}, #{quote_column_name(partition_column)})
+                  ADD PRIMARY KEY (#{pk_columns.map { |c| quote_column_name(c) }.join(', ')})
                 SQL
               end
             end

data/lib/code0/zero_track/database/partitioning/partition_manager.rb

@@ -64,6 +64,8 @@ module Code0
               model.partitioning_strategy.partitions_to_detach.each do |partition|
                 detach_partition(partition, connection)
               end
+
+              drop_declared_foreign_keys_from_detached_partitions(connection)
             end
           end
 
@@ -109,6 +111,73 @@ module Code0
             )
           end
 
+          def drop_declared_foreign_keys_from_detached_partitions(connection)
+            constraint_names = model.foreign_keys_to_drop_on_detach || []
+            return if constraint_names.empty?
+
+            warn_about_unknown_foreign_keys(constraint_names, connection)
+
+            detached_foreign_keys(constraint_names, connection).each do |qualified_table, constraint_name|
+              connection.execute(
+                "ALTER TABLE #{qualified_table} " \
+                "DROP CONSTRAINT #{connection.quote_column_name(constraint_name)}"
+              )
+
+              logger.info(
+                message: 'Dropped foreign key from detached partition',
+                table_name: model.table_name,
+                partition_name: qualified_table,
+                constraint_name: constraint_name
+              )
+            end
+          end
+
+          # We check the parent table because we drop the FK from the partition
+          # when detaching. A missing FK on the detached partition is an expected state
+          def warn_about_unknown_foreign_keys(constraint_names, connection)
+            existing = parent_foreign_key_names(connection)
+            unknown = constraint_names - existing
+            return if unknown.empty?
+
+            logger.warn(
+              message: 'Configured foreign keys to drop on detach do not exist on the partitioned table',
+              table_name: model.table_name,
+              constraint_names: unknown
+            )
+          end
+
+          def parent_foreign_key_names(connection)
+            connection.select_values(<<~SQL.squish)
+              SELECT con.conname
+              FROM pg_catalog.pg_constraint con
+              WHERE con.contype = 'f'
+                AND con.conrelid = #{connection.quote(model.table_name)}::regclass
+            SQL
+          end
+
+          def detached_foreign_keys(constraint_names, connection)
+            schema = Rails.application.config.zero_track.db_partitioning.dynamic_partition_schema
+            quoted_names = constraint_names.map { |name| connection.quote(name) }.join(', ')
+
+            rows = connection.select_rows(<<~SQL.squish)
+              SELECT (quote_ident(n.nspname) || '.' || quote_ident(c.relname)) AS qualified_table,
+                     con.conname AS constraint_name
+              FROM pg_catalog.pg_constraint con
+              JOIN pg_catalog.pg_class c ON c.oid = con.conrelid
+              JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace
+              WHERE con.contype = 'f'
+                AND con.conname IN (#{quoted_names})
+                AND n.nspname = #{connection.quote(schema)}
+                AND c.relkind = 'r'
+                AND NOT c.relispartition
+                AND NOT EXISTS (
+                  SELECT 1 FROM pg_catalog.pg_inherits i WHERE i.inhrelid = c.oid
+                )
+            SQL
+
+            rows.map { |qualified_table, constraint_name| [qualified_table, constraint_name] }
+          end
+
           def drop_partition(detached_partition, connection)
             schema_name = connection.quote_table_name(detached_partition.schema)
             partition_name = connection.quote_table_name(detached_partition.name)

data/lib/code0/zero_track/database/partitioning/partitioned_table.rb

@@ -25,6 +25,16 @@ module Code0
 
               @partitioning_strategy = strategy_class.new(self, column, **kwargs)
             end
+
+            def drop_foreign_keys_on_detach(*constraint_names)
+              @foreign_keys_to_drop_on_detach ||= []
+              @foreign_keys_to_drop_on_detach.concat(constraint_names.flatten.map(&:to_s))
+              @foreign_keys_to_drop_on_detach
+            end
+
+            def foreign_keys_to_drop_on_detach
+              @foreign_keys_to_drop_on_detach || []
+            end
           end
         end
       end

data/lib/code0/zero_track/version.rb

@@ -2,6 +2,6 @@
 
 module Code0
   module ZeroTrack
-    VERSION = '0.0.8'
+    VERSION = '0.0.10'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: code0-zero_track
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.10
 platform: ruby
 authors:
 - Niklas van Schrick