pcrd 0.1.0

data/lib/pcrd/transform/validator.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Pcrd
+  module Transform
+    # Runs pre-migration data validation queries on the source database.
+    #
+    # For each column in the migration spec that involves a validated cast,
+    # Validator queries the source table to confirm no rows would be rejected
+    # or silently truncated by the cast. Failures are collected and reported
+    # all at once so the operator can fix everything in one pass.
+    #
+    # Called by the preflight phase before any replication slot is created.
+    class Validator
+      ValidationFailure = Data.define(:table_name, :column_name, :source_type,
+                                      :target_type, :failing_count, :description,
+                                      :warn_only)
+
+      def initialize(source_pool)
+        @pool = source_pool
+      end
+
+      # Validates all columns in table_config against their source schema.
+      #
+      # source_columns: Array<Schema::Column> from Schema::Reader
+      # Returns Array<ValidationFailure> — empty means all checks passed.
+      # Raises on unexpected database errors.
+      def validate(table_config, source_columns)
+        failures = []
+        col_index = source_columns.each_with_object({}) { |c, h| h[c.name] = c }
+
+        (table_config.columns || {}).each do |src_name, col_spec|
+          next if col_spec.drop || col_spec.type.nil?
+
+          source_col = col_index[src_name.to_s]
+          next unless source_col
+
+          safety = TypeMap.cast_safety(source_col.type_name, col_spec.type)
+          next if %i[no_op always_safe].include?(safety)
+
+          if safety == :unsupported
+            failures << ValidationFailure.new(
+              table_name:    table_config.name,
+              column_name:   src_name,
+              source_type:   source_col.display_type,
+              target_type:   col_spec.type,
+              failing_count: nil,
+              description:   "pcrd does not support this type transition — " \
+                             "use a custom transform or perform it separately",
+              warn_only:     false
+            )
+            next
+          end
+
+          # :validated — run the data check
+          result = run_check(table_config.name, src_name, source_col, col_spec.type)
+          failures << result if result
+        end
+
+        failures
+      end
+
+      private
+
+      def run_check(table_name, col_name, source_col, target_type)
+        rule = TypeMap.validated_rule(source_col.type_name, target_type)
+        return nil unless rule
+
+        quoted_col   = Sql.quote_ident(col_name.to_s)
+        quoted_table = Sql.quote_table(table_name)
+
+        count = if rule[:check_expr] == :varchar_length_check
+                  varchar_length_check(quoted_table, quoted_col, target_type)
+                elsif rule[:check_expr]
+                  expr    = rule[:check_expr].call(quoted_col)
+                  result  = @pool.exec("SELECT COUNT(*) FROM #{quoted_table} WHERE #{expr}")
+                  result[0]["count"].to_i
+                else
+                  0  # warn_only rule with no SQL check
+                end
+
+        return nil if count.zero? && !rule[:warn_only]
+
+        ValidationFailure.new(
+          table_name:    table_name,
+          column_name:   col_name.to_s,
+          source_type:   source_col.display_type,
+          target_type:   target_type,
+          failing_count: rule[:check_expr] ? count : nil,
+          description:   rule[:description],
+          warn_only:     rule[:warn_only]
+        )
+      end
+
+      def varchar_length_check(quoted_table, quoted_col, target_type)
+        max_len = TypeMap.extract_length(target_type)
+        return 0 unless max_len
+
+        result = @pool.exec(
+          "SELECT COUNT(*) FROM #{quoted_table} WHERE length(#{quoted_col}) > $1",
+          [max_len]
+        )
+        result[0]["count"].to_i
+      end
+    end
+  end
+end

data/lib/pcrd/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pcrd
+  VERSION = "0.1.0"
+end

data/lib/pcrd.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect "cli" => "CLI"
+loader.inflector.inflect "ddl" => "DDL"
+loader.setup
+
+module Pcrd
+end

metadata

@@ -0,0 +1,231 @@
+--- !ruby/object:Gem::Specification
+name: pcrd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Charles Harris
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: tty-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: tty-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: dry-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+description: |
+  pcrd migrates PostgreSQL tables to a new cluster using logical replication,
+  with support for column type changes, renames, additions, drops, and column
+  reordering with padding optimization. Designed for large tables where
+  ALTER TABLE would cause unacceptable downtime.
+email:
+- charris000@gmail.com
+executables:
+- pcrd
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/pcrd
+- lib/pcrd.rb
+- lib/pcrd/advisory_lock.rb
+- lib/pcrd/apply/engine.rb
+- lib/pcrd/apply/worker.rb
+- lib/pcrd/backfill/batch.rb
+- lib/pcrd/backfill/engine.rb
+- lib/pcrd/checkpoint/store.rb
+- lib/pcrd/cli.rb
+- lib/pcrd/commands/analyze.rb
+- lib/pcrd/commands/cleanup.rb
+- lib/pcrd/commands/demo.rb
+- lib/pcrd/commands/readiness.rb
+- lib/pcrd/commands/status.rb
+- lib/pcrd/commands/verify.rb
+- lib/pcrd/config.rb
+- lib/pcrd/config/add_column.rb
+- lib/pcrd/config/analyze_config.rb
+- lib/pcrd/config/column_spec.rb
+- lib/pcrd/config/connection.rb
+- lib/pcrd/config/cutover_config.rb
+- lib/pcrd/config/load_error.rb
+- lib/pcrd/config/loader.rb
+- lib/pcrd/config/migrate_config.rb
+- lib/pcrd/config/root.rb
+- lib/pcrd/config/schema.rb
+- lib/pcrd/config/table.rb
+- lib/pcrd/config/verify_config.rb
+- lib/pcrd/connection/client.rb
+- lib/pcrd/connection/error.rb
+- lib/pcrd/connection/replication.rb
+- lib/pcrd/cutover/orchestrator.rb
+- lib/pcrd/cutover/sequences.rb
+- lib/pcrd/demo/generator.rb
+- lib/pcrd/demo/schema.rb
+- lib/pcrd/error.rb
+- lib/pcrd/migration/orchestrator.rb
+- lib/pcrd/monitor/lag.rb
+- lib/pcrd/options.rb
+- lib/pcrd/output/analyze_printer.rb
+- lib/pcrd/output/cutover_printer.rb
+- lib/pcrd/output/preflight_printer.rb
+- lib/pcrd/output/readiness_printer.rb
+- lib/pcrd/preflight.rb
+- lib/pcrd/readiness/manifest.rb
+- lib/pcrd/replication/consumer.rb
+- lib/pcrd/replication/error.rb
+- lib/pcrd/replication/pgoutput/messages.rb
+- lib/pcrd/replication/pgoutput/parser.rb
+- lib/pcrd/reporter/console.rb
+- lib/pcrd/reporter/null.rb
+- lib/pcrd/schema/column.rb
+- lib/pcrd/schema/ddl.rb
+- lib/pcrd/schema/diff_entry.rb
+- lib/pcrd/schema/differ.rb
+- lib/pcrd/schema/object_reader.rb
+- lib/pcrd/schema/packer.rb
+- lib/pcrd/schema/reader.rb
+- lib/pcrd/schema/setup.rb
+- lib/pcrd/schema/setup_error.rb
+- lib/pcrd/schema/table_not_found.rb
+- lib/pcrd/schema/type_registry.rb
+- lib/pcrd/sql.rb
+- lib/pcrd/transform/row_transformer.rb
+- lib/pcrd/transform/type_map.rb
+- lib/pcrd/transform/validator.rb
+- lib/pcrd/version.rb
+homepage: https://github.com/charlesharris/pcrd
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/charlesharris/pcrd
+  changelog_uri: https://github.com/charlesharris/pcrd/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/charlesharris/pcrd/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: PostgreSQL Column Rewrite Daemon — zero-downtime cross-cluster schema migrations
+test_files: []