exwiw 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 369701f0b142d0660d988630013e5f421c1d4ad817a834615e25177721700abc
-  data.tar.gz: 950edc07255a1520bfa9bae067c028160219790ecc84379210e6532054de0ddb
+  metadata.gz: 95749db3a2093fe305a67c6caacf1b6861f791d99f70283a7fa63ce765b9f846
+  data.tar.gz: '087a7260b7d5cd3809fc72c8a783f408e87091e1e6bc816eab4a965e489b4404'
 SHA512:
-  metadata.gz: 852cd30d5121dbbbf8d7abeb1fd486c188c4ab177339620d2129ebfed10ef1dfe13a928c34840f082c295e255d0a15e3a72cf1e71151292dce50657bbf125ac5
-  data.tar.gz: a57d914dd5794caa00df4323ab84df3c9fcdec5694c0e32fde68d44cc7f78369b3d8359614c55a35608eb2b9d7202af2078ffc1ee0a3a566d69cf1eb5141de72
+  metadata.gz: cafb2801b708bf26124f12f6a13799f35d6b5f17ec2977fc49464ae56bb6482434bf9d1a155b176968d4f7b545f172a1fc56c3114958206da0605c426194aebf
+  data.tar.gz: c9c05f6da15c12ee45963d0552122310cda5a3261f210d2dbb069986751b9d245bad9661ef9ca5d8ed7fbec04afbe00e637bc9b852d0d15b0eea4429db4c6ec2

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## [Unreleased]
 
+## [0.2.4] - 2026-05-28
+
+### Added
+
+- Dump/explain queries issued against the source DB now carry an identifying comment (e.g. `/* exwiw table=shops */`) so exwiw-originated queries can be spotted in `processlist` / slow query log / `db.currentOp()` and killed by table when they run long. Added to the SELECT/EXPLAIN of the `mysql2`, `postgresql`, and `sqlite3` adapters and to MongoDB `find` (via `.comment(...)`); the `explain` subcommand's printed SQL matches the emitted form. The comment is applied only at the query-issuing boundary, so generated `insert-*` / `delete-*` files (and `to_bulk_delete` subqueries) stay comment-free, and the version is intentionally omitted to keep snapshots/diffs stable. ([#35](https://github.com/heyinc/exwiw/pull/35))
+
+## [0.2.3] - 2026-05-27
+
+### Fixed
+
+- PostgreSQL: schema dump now includes `CREATE TYPE ... AS ENUM` for custom enum types referenced by dumped tables. Previously `pg_dump --table` excluded schema-level type definitions, causing `type "..." does not exist` errors on import. ([#22](https://github.com/heyinc/exwiw/pull/22))
+
 ## [0.2.2] - 2026-05-26
 
 ### Changed

data/README.md

@@ -347,7 +347,12 @@ At runtime:
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version:
+
+1. Run the **Release PR** workflow from the Actions tab with the new version number (e.g. `0.2.3`). This creates a PR that bumps `version.rb` and `CHANGELOG.md`.
+2. Merge the PR. The **Release** workflow runs automatically, creating a git tag and publishing the gem to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/exwiw/adapter/mongodb_adapter.rb

@@ -73,7 +73,11 @@ module Exwiw
       def execute(query)
         @logger.debug("  Executing Mongo find on '#{query.collection}': filter=#{query.filter.inspect} projection=#{query.projection.inspect}")
 
-        docs = db[query.collection].find(query.filter).projection(query.projection).to_a
+        docs = db[query.collection]
+          .find(query.filter)
+          .projection(query.projection)
+          .comment(query_comment_text("collection=#{query.collection}"))
+          .to_a
 
         @state[query.collection] = docs.map { |doc| doc[query.primary_key] }
 

data/lib/exwiw/adapter/mysql2_adapter.rb

@@ -8,14 +8,14 @@ module Exwiw
       end
 
       def execute(query_ast)
-        sql = compile_ast(query_ast)
+        sql = commented_sql(query_ast)
 
         @logger.debug("  Executing SQL: \n#{sql}")
         connection.query(sql, cast: false, as: :array).to_a
       end
 
       def explain(query_ast)
-        sql = compile_ast(query_ast)
+        sql = commented_sql(query_ast)
 
         @logger.debug("  Executing EXPLAIN: \n#{sql}")
         rows = connection.query("EXPLAIN #{sql}", cast: false).to_a

data/lib/exwiw/adapter/postgresql_adapter.rb

@@ -8,14 +8,14 @@ module Exwiw
       end
 
       def execute(query_ast)
-        sql = compile_ast(query_ast)
+        sql = commented_sql(query_ast)
 
         @logger.debug("  Executing SQL: \n#{sql}")
         connection.exec(sql).values
       end
 
       def explain(query_ast)
-        sql = compile_ast(query_ast)
+        sql = commented_sql(query_ast)
 
         @logger.debug("  Executing EXPLAIN: \n#{sql}")
         connection.exec("EXPLAIN #{sql}").values.map(&:first).join("\n")
@@ -52,6 +52,13 @@ module Exwiw
           raise "pg_dump failed (exit #{status.exitstatus}): #{stderr}"
         end
 
+        enum_types = query_enum_types(table_names)
+        unless enum_types.empty?
+          enum_ddl = DdlPostprocessor.create_type_enum_statements(enum_types)
+          @logger.debug("  Found #{enum_types.size} enum type(s) to prepend.")
+          stdout = enum_ddl + stdout
+        end
+
         idempotent = stdout
         idempotent = DdlPostprocessor.add_if_not_exists_to_create_schema(idempotent)
         idempotent = DdlPostprocessor.add_if_not_exists_to_create_sequence(idempotent)
@@ -264,6 +271,40 @@ module Exwiw
         end
       end
 
+      private def query_enum_types(table_names)
+        return [] if table_names.empty?
+
+        placeholders = table_names.each_with_index.map { |_, i| "$#{i + 1}" }.join(', ')
+        sql = <<~SQL
+          SELECT DISTINCT
+            n.nspname  AS type_schema,
+            t.typname  AS type_name,
+            array_agg(e.enumlabel ORDER BY e.enumsortorder) AS enum_labels
+          FROM pg_attribute a
+          JOIN pg_class c      ON c.oid = a.attrelid
+          JOIN pg_namespace cn ON cn.oid = c.relnamespace
+          JOIN pg_type t       ON t.oid = a.atttypid
+          JOIN pg_namespace n  ON n.oid = t.typnamespace
+          JOIN pg_enum e       ON e.enumtypid = t.oid
+          WHERE c.relname IN (#{placeholders})
+            AND a.attnum > 0
+            AND NOT a.attisdropped
+            AND t.typtype = 'e'
+          GROUP BY n.nspname, t.typname
+          ORDER BY n.nspname, t.typname
+        SQL
+
+        result = connection.exec_params(sql, table_names)
+        decoder = PG::TextDecoder::Array.new
+        result.map do |row|
+          {
+            schema: row['type_schema'],
+            name: row['type_name'],
+            labels: decoder.decode(row['enum_labels']),
+          }
+        end
+      end
+
       private def connection
         @connection ||=
           begin

data/lib/exwiw/adapter/sqlite3_adapter.rb

@@ -8,14 +8,14 @@ module Exwiw
       end
 
       def execute(query_ast)
-        sql = compile_ast(query_ast)
+        sql = commented_sql(query_ast)
 
         @logger.debug("  Executing SQL: \n#{sql}")
         connection.execute(sql)
       end
 
       def explain(query_ast)
-        sql = compile_ast(query_ast)
+        sql = commented_sql(query_ast)
 
         @logger.debug("  Executing EXPLAIN QUERY PLAN: \n#{sql}")
         rows = connection.execute("EXPLAIN QUERY PLAN #{sql}")

data/lib/exwiw/adapter.rb

@@ -81,6 +81,34 @@ module Exwiw
       def explain(_query_ast)
         raise NotImplementedError, "#{self.class.name} does not implement #explain"
       end
+
+      # Identifier text prepended to every query exwiw sends to the (often
+      # production) source DB, so the statement is recognizable in the
+      # processlist / slow-query log / db.currentOp() and can be killed if it
+      # runs long. e.g. "exwiw table=shops". `label` is "table=..." /
+      # "collection=...". The version is intentionally omitted to keep the
+      # comment stable across releases (snapshots / diffs). Strips `*/` to
+      # avoid breaking out of the comment.
+      def query_comment_text(label = nil)
+        parts = ["exwiw"]
+        parts << label if label
+        parts.join(' ').gsub('*/', '')
+      end
+
+      # SQL block-comment form, prefixed to SELECT / EXPLAIN.
+      def sql_query_comment(query_ast)
+        label =
+          if query_ast.respond_to?(:from_table_name) && query_ast.from_table_name
+            "table=#{query_ast.from_table_name}"
+          end
+        "/* #{query_comment_text(label)} */"
+      end
+
+      # Comment-prefixed SELECT. Relies on the SQL adapter's #compile_ast
+      # (dispatched to the subclass at runtime).
+      def commented_sql(query_ast)
+        "#{sql_query_comment(query_ast)} #{compile_ast(query_ast)}"
+      end
     end
 
     # @params [Exwiw::QueryAst] query_ast

data/lib/exwiw/ddl_postprocessor.rb

@@ -57,5 +57,24 @@ module Exwiw
         SQL
       end
     end
+
+    # Generate idempotent CREATE TYPE ... AS ENUM statements.
+    # +enum_types+ is an Array of Hashes with keys :schema, :name, :labels.
+    def create_type_enum_statements(enum_types)
+      return "" if enum_types.empty?
+
+      stmts = enum_types.map do |t|
+        qualified_name = "\"#{t[:schema]}\".\"#{t[:name]}\""
+        labels_sql = t[:labels].map { |l| "'#{l.gsub("'", "''")}'" }.join(', ')
+        <<~SQL.chomp
+          DO $exwiw$ BEGIN
+            CREATE TYPE #{qualified_name} AS ENUM (#{labels_sql});
+          EXCEPTION WHEN duplicate_object THEN NULL;
+          END $exwiw$;
+        SQL
+      end
+
+      stmts.join("\n\n") + "\n\n"
+    end
   end
 end

data/lib/exwiw/explain_runner.rb

@@ -40,7 +40,7 @@ module Exwiw
         @logger.debug("Explaining '#{table_name}'... (#{idx + 1}/#{total_size})")
 
         query_ast = adapter.build_query(table, @dump_target, table_by_name)
-        sql = adapter.compile_ast(query_ast)
+        sql = adapter.commented_sql(query_ast)
         explain_text = adapter.explain(query_ast)
 
         @io.puts "-- [#{idx + 1}/#{total_size}] #{table_name}"

data/lib/exwiw/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Exwiw
-  VERSION = "0.2.2"
+  VERSION = "0.2.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exwiw
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Shia