exwiw 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c5e29a492af74dfbfa0e778fcb527a218d3a33507024646b2fe88b495581c2f
-  data.tar.gz: bd66516a56f40e4147e76e3fc662c98cd3c0261eb54a310ef7af49bcc5373cf0
+  metadata.gz: b48628d0a7599b151f957d6a40cd5a23cc3befa5007a86c550c834878b9893cc
+  data.tar.gz: 38fe41ada0a3e0a8f358bd60c3a28a7b7637e91bd2066d2e2a97e5542716540a
 SHA512:
-  metadata.gz: 1b63d52ce0abd624695b73d782c64a5d4dd861e701f7c5989e977dd506d0178f4e2d394e9ae57e1106bf83898b622bd93681c60bdfbbde7dcd72bf1796cd4847
-  data.tar.gz: 36ea50859424c45eb3bd83ffc84fb148eb4080345e7dfc012ff81b32003fa27e83f43324c4e7fa296c4d35ee8de6f89754a9e9f1449bd69d3d1b4066015e51bc
+  metadata.gz: 4105dbad3eb0291b841e7ebf152776913e19d817dbf3a9901a6838d7f16113c4fbd30887b88015fed735c0ec4b82c03367fafed81f2f6c7669c8f091da9b4041
+  data.tar.gz: 28a6383dbc953b93772f46adaf488cb4f0e826a0642859700c48536de46bde633a55780d8baff588da3e81dd6c4534d2fedd355424f7b68a70082c462eaf59aa

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 ## [Unreleased]
 
+## [0.1.9] - 2026-05-21
+
+  Added
+
+  - PostgreSQL: --output-format=copy — emits COPY FROM stdin blocks instead of
+  INSERT statements. Faster restores for large dumps. (c026960)
+  - PostgreSQL: dump-all-tables mode — running without --target-table / --ids now
+   dumps every table in the scenario. (c026960)
+
+  Fixed
+
+  - PostgreSQL: value escape sequences — corrected escape handling in formatted
+  values. (50e6772)
+
+https://github.com/heyinc/exwiw/pull/21
+
 ## [0.1.8] - 2026-05-16
 
 ### Added

data/README.md

@@ -62,6 +62,20 @@ exwiw \
   --log-level=info
 ```
 
+When `--target-table` and `--ids` are omitted, exwiw dumps all tables defined in `--config-dir`:
+
+```bash
+# dump all tables
+exwiw \
+  --adapter=postgresql \
+  --host=localhost \
+  --port=5432 \
+  --user=reader \
+  --database=app_production \
+  --config-dir=exwiw \
+  --output-dir=dump
+```
+
 This command will generate sql files in the `dump` directory.
 
 - `dump/insert-000-schema.sql` — idempotent `CREATE TABLE IF NOT EXISTS ...` for every table in scope. Apply this first to provision an empty database.
@@ -120,6 +134,32 @@ This is an example of the one table schema:
 
 `--config-dir` will use all json files in the specified directory.
 
+### Output format
+
+By default, exwiw generates `INSERT` statements. For PostgreSQL, you can use `--output-format=copy` to generate `COPY FROM stdin` format instead, which is significantly faster for bulk loading:
+
+```bash
+exwiw \
+  --adapter=postgresql \
+  --host=localhost \
+  --port=5432 \
+  --user=reader \
+  --database=app_production \
+  --config-dir=exwiw \
+  --target-table=shops \
+  --ids=1 \
+  --output-dir=dump \
+  --output-format=copy
+```
+
+The generated file uses tab-separated values with PostgreSQL's text-format escaping (`\N` for NULL, `\\` for backslash, etc.). Import with `psql`:
+
+```bash
+psql -d app_dev -f dump/insert-001-shops.sql
+```
+
+`--output-format=copy` is only supported with the `postgresql` adapter.
+
 ### Bulk insert chunk size
 
 `bulk_insert_chunk_size` splits the generated `INSERT` statement into multiple statements, each containing at most the specified number of rows. This is useful when the number of records per table is large enough to hit limits like MySQL's `max_allowed_packet`.
@@ -250,7 +290,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/riseshia/exwiw.
+Bug reports and pull requests are welcome on GitHub at https://github.com/heyinc/exwiw.
 
 ## License
 

data/lib/exwiw/adapter/postgresql_adapter.rb

@@ -74,6 +74,16 @@ module Exwiw
         "INSERT INTO #{table_name} (#{column_names}) VALUES\n#{values};"
       end
 
+      def to_copy_from_stdin(results, table)
+        column_names = table.columns.map(&:name).join(', ')
+        lines = ["COPY #{table.name} (#{column_names}) FROM stdin;"]
+        results.each do |row|
+          lines << row.map { |v| escape_copy_value(v) }.join("\t")
+        end
+        lines << '\\.'
+        lines.join("\n")
+      end
+
       # Transcribe the FROM-side sequence cursor backing `table.primary_key`
       # onto the import target. Without this, importing into a clean DB leaves
       # the sequence at 1 while the inserted rows occupy higher IDs, so the
@@ -205,6 +215,21 @@ module Exwiw
         end
       end
 
+      private def escape_copy_value(value)
+        case value
+        when nil
+          "\\N"
+        when String
+          value
+            .gsub('\\') { '\\\\' }
+            .gsub("\t", '\t')
+            .gsub("\n", '\n')
+            .gsub("\r", '\r')
+        else
+          value.to_s
+        end
+      end
+
       private def escape_single_quote(value)
         value.gsub("'", "''")
       end

data/lib/exwiw/adapter.rb

@@ -70,6 +70,10 @@ module Exwiw
       def post_insert_sql(_table)
         nil
       end
+
+      def to_copy_from_stdin(_results, _table)
+        raise NotImplementedError, "COPY format is not supported by #{self.class.name}"
+      end
     end
 
     # @params [Exwiw::QueryAst] query_ast

data/lib/exwiw/cli.rb

@@ -28,6 +28,7 @@ module Exwiw
       @database_name = nil
       @target_table_name = nil
       @ids = []
+      @output_format = 'insert'
       @log_level = :info
 
       parser.parse!(@argv)
@@ -60,6 +61,7 @@ module Exwiw
           output_dir: @output_dir,
           config_dir: @config_dir,
           dump_target: dump_target,
+          output_format: @output_format,
           logger: logger,
         ).run
       end
@@ -92,6 +94,17 @@ module Exwiw
         exit 1
       end
 
+      valid_output_formats = ["insert", "copy"]
+      unless valid_output_formats.include?(@output_format)
+        $stderr.puts "Invalid output format '#{@output_format}'. Available options are: #{valid_output_formats.join(', ')}"
+        exit 1
+      end
+
+      if @output_format == "copy" && @database_adapter != "postgresql"
+        $stderr.puts "--output-format=copy is only supported with the postgresql adapter"
+        exit 1
+      end
+
       if @config_dir.nil?
         $stderr.puts "Config dir is required"
         exit 1
@@ -107,13 +120,13 @@ module Exwiw
         exit 1
       end
 
-      if @target_table_name.nil? || @target_table_name.empty?
-        $stderr.puts "Target table is required"
+      if @target_table_name && @ids.empty?
+        $stderr.puts "--ids is required when --target-table is specified"
         exit 1
       end
 
-      if @ids.empty?
-        $stderr.puts "At least one ID is required"
+      if !@target_table_name && @ids.any?
+        $stderr.puts "--target-table is required when --ids is specified"
         exit 1
       end
     end
@@ -151,8 +164,9 @@ module Exwiw
         end
         opts.on("-a", "--adapter=ADAPTER", "Database adapter") { |v| @database_adapter = v }
         opts.on("--database=DATABASE", "Target database name") { |v| @database_name = v }
-        opts.on("--target-table=TABLE", "Target table for extraction") { |v| @target_table_name = v }
-        opts.on("--ids=IDS", "Comma-separated list of identifiers") { |v| @ids = v.split(',') }
+        opts.on("--target-table=[TABLE]", "Target table for extraction. If omitted, dump all tables.") { |v| @target_table_name = v }
+        opts.on("--ids=[IDS]", "Comma-separated list of identifiers. Required when --target-table is given.") { |v| @ids = v.split(',') }
+        opts.on("--output-format=[FORMAT]", "Output format: insert (default) or copy (PostgreSQL only)") { |v| @output_format = v }
         opts.on("--log-level=LEVEL", "Log level (debug, info). default is info") { |v| @log_level = v.to_sym }
 
         opts.on("--help", "Print this help") do

data/lib/exwiw/runner.rb

@@ -9,12 +9,14 @@ module Exwiw
       output_dir:,
       config_dir:,
       dump_target:,
-      logger:
+      logger:,
+      output_format: 'insert'
     )
       @connection_config = connection_config
       @output_dir = output_dir
       @config_dir = config_dir
       @dump_target = dump_target
+      @output_format = output_format
       @logger = logger
     end
 
@@ -52,18 +54,30 @@ module Exwiw
           @logger.info("  No records matched. skip this table.")
           next
         end
-        @logger.debug("  Generate INSERT statement...")
+        insert_idx = (idx + 1).to_s.rjust(3, '0')
 
-        chunk_size = table.bulk_insert_chunk_size
-        chunks = chunk_size ? results.each_slice(chunk_size).to_a : [results]
-        insert_sql = chunks.map { |chunk_rows| adapter.to_bulk_insert(chunk_rows, table) }.join("\n")
+        if @output_format == 'copy'
+          @logger.debug("  Generate COPY statement...")
+          copy_sql = adapter.to_copy_from_stdin(results, table)
+          @logger.info("  Generated COPY statement for #{record_num} records.")
 
-        @logger.info("  Generated INSERT statement for #{record_num} records (#{chunks.size} statement(s)).")
-        insert_idx = (idx + 1).to_s.rjust(3, '0')
-        File.open(File.join(@output_dir, "insert-#{insert_idx}-#{table_name}.#{adapter.output_extension}"), 'w') do |file|
-          file.puts(insert_sql)
-          post = adapter.post_insert_sql(table)
-          file.puts(post) if post
+          File.open(File.join(@output_dir, "insert-#{insert_idx}-#{table_name}.#{adapter.output_extension}"), 'w') do |file|
+            file.puts(copy_sql)
+            post = adapter.post_insert_sql(table)
+            file.puts(post) if post
+          end
+        else
+          @logger.debug("  Generate INSERT statement...")
+          chunk_size = table.bulk_insert_chunk_size
+          chunks = chunk_size ? results.each_slice(chunk_size).to_a : [results]
+          insert_sql = chunks.map { |chunk_rows| adapter.to_bulk_insert(chunk_rows, table) }.join("\n")
+
+          @logger.info("  Generated INSERT statement for #{record_num} records (#{chunks.size} statement(s)).")
+          File.open(File.join(@output_dir, "insert-#{insert_idx}-#{table_name}.#{adapter.output_extension}"), 'w') do |file|
+            file.puts(insert_sql)
+            post = adapter.post_insert_sql(table)
+            file.puts(post) if post
+          end
         end
 
         if adapter.supports_bulk_delete?

data/lib/exwiw/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exwiw
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Shia
@@ -83,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby gem that allows you to export records from a database to a dump file.
 test_files: []