pgsync 0.6.4 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ecb467f4d3112edfcfebe19913e29daeddfe1e4cc10e18bd9e8850fbceced57
-  data.tar.gz: 4d8309dec9e8238074267baf583fe333c7b1d3300ad80398748e15905eb1e539
+  metadata.gz: e3ef4779b0d0962cfb0a23bb8e1ec4e6a03923e1324a77280499d3c023aa7673
+  data.tar.gz: 59aa2f0868e3a1a920547326a49b86460ab2d8349eb0be68989899ca3bf7ada2
 SHA512:
-  metadata.gz: 145eb31e2565257a5adedc05c1308692dffb1e0785728ecd38230bb23c34c4ba6ecf08512201f707f457b136e0b7a22ca511b46fb7834f2045c041ff43dd6ccc
-  data.tar.gz: cde51dee36149f9f8c21e26eecd504de68d8a47c2524f084b74962d7ceae1a01b59841261fc6c112cf94b31a89f55b9a991c05d1af0db41c46ed615fc56e888f
+  metadata.gz: 9c6761c05533930479d39fcc318bd1c2601afa06ba50379c94bdaa69e3751fa3229559aa31806778cf17bdf79af0510bdbcb5d0c33dd6e4fdb1e164cda9ea49f
+  data.tar.gz: f8509b918137d97f80044ecac181a9499c128891d33467d91f2f74e6e49248f2ebbacee8bf6233c959c923d583ef8e14cd76b25d19b6b58c0d4166a7cc81af56

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.6.5 (2020-07-10)
+
+- Improved help
+
 ## 0.6.4 (2020-06-10)
 
 - Log SQL with `--debug` option

data/README.md

@@ -390,6 +390,10 @@ Also check out:
 
 Inspired by [heroku-pg-transfer](https://github.com/ddollar/heroku-pg-transfer).
 
+## History
+
+View the [changelog](https://github.com/ankane/pgsync/blob/master/CHANGELOG.md)
+
 ## Contributing
 
 Everyone is encouraged to help improve this project. Here are a few ways you can help:

data/lib/pgsync/client.rb

@@ -39,42 +39,74 @@ module PgSync
     def slop_options
       o = Slop::Options.new
       o.banner = %{Usage:
-  pgsync [options]
+    pgsync [tables,groups] [sql] [options]}
 
-Options:}
-      o.string "-d", "--db", "database"
-      o.string "-t", "--tables", "tables to sync"
-      o.string "-g", "--groups", "groups to sync"
-      o.integer "-j", "--jobs", "number of tables to sync at a time"
+      # not shown
+      o.string "-t", "--tables", "tables to sync", help: false
+      o.string "-g", "--groups", "groups to sync", help: false
+
+      o.separator ""
+      o.separator "Table options:"
+      o.string "--exclude", "tables to exclude"
       o.string "--schemas", "schemas to sync"
-      o.string "--from", "source"
-      o.string "--to", "destination"
-      o.string "--exclude", "exclude tables"
-      o.string "--config", "config file"
-      o.boolean "--to-safe", "accept danger", default: false
-      o.boolean "--debug", "debug", default: false
-      o.boolean "--list", "list", default: false
-      o.boolean "--overwrite", "overwrite existing rows", default: false, help: false
+      o.boolean "--all-schemas", "sync all schemas", default: false
+
+      o.separator ""
+      o.separator "Row options:"
+      o.boolean "--overwrite", "overwrite existing rows", default: false
       o.boolean "--preserve", "preserve existing rows", default: false
       o.boolean "--truncate", "truncate existing rows", default: false
-      o.boolean "--schema-first", "schema first", default: false
-      o.boolean "--schema-only", "schema only", default: false
-      o.boolean "--all-schemas", "all schemas", default: false
-      o.boolean "--no-rules", "do not apply data rules", default: false
-      o.boolean "--no-sequences", "do not sync sequences", default: false
-      o.boolean "--init", "init", default: false
-      o.boolean "--in-batches", "in batches", default: false, help: false
-      o.integer "--batch-size", "batch size", default: 10000, help: false
-      o.float "--sleep", "sleep", default: 0, help: false
-      o.boolean "--fail-fast", "stop on the first failed table", default: false
-      o.boolean "--defer-constraints", "defer constraints", default: false, help: false
+
+      o.separator ""
+      o.separator "Foreign key options:"
       o.boolean "--defer-constraints-v2", "defer constraints", default: false
-      o.boolean "--disable-user-triggers", "disable non-system triggers", default: false
       o.boolean "--disable-integrity", "disable foreign key triggers", default: false
+      o.integer "-j", "--jobs", "number of tables to sync at a time"
+
+      # replaced by v2
+      o.boolean "--defer-constraints", "defer constraints", default: false, help: false
       # private, for testing
       o.boolean "--disable-integrity-v2", "disable foreign key triggers", default: false, help: false
-      o.boolean "-v", "--version", "print the version"
-      o.boolean "-h", "--help", "prints help"
+
+      o.separator ""
+      o.separator "Schema options:"
+      o.boolean "--schema-first", "sync schema first", default: false
+      o.boolean "--schema-only", "sync schema only", default: false
+
+      o.separator ""
+      o.separator "Config options:"
+      # technically, defaults to searching path for .pgsync.yml, but this is simpler
+      o.string "--config", "config file (defaults to .pgsync.yml)"
+      o.string "-d", "--db", "database-specific config file"
+
+      o.separator ""
+      o.separator "Connection options:"
+      o.string "--from", "source database URL"
+      o.string "--to", "destination database URL"
+      o.boolean "--to-safe", "confirms destination is safe (when not localhost)", default: false
+
+      o.separator ""
+      o.separator "Other options:"
+      o.boolean "--debug", "show SQL statements", default: false
+      o.boolean "--disable-user-triggers", "disable non-system triggers", default: false
+      o.boolean "--fail-fast", "stop on the first failed table", default: false
+      o.boolean "--no-rules", "don't apply data rules", default: false
+      o.boolean "--no-sequences", "don't sync sequences", default: false
+
+      # not shown in help
+      # o.separator ""
+      # o.separator "Append-only table options:"
+      o.boolean "--in-batches", "sync in batches", default: false, help: false
+      o.integer "--batch-size", "batch size", default: 10000, help: false
+      o.float "--sleep", "time to sleep between batches", default: 0, help: false
+
+      o.separator ""
+      o.separator "Other commands:"
+      o.boolean "--init", "create config file", default: false
+      o.boolean "--list", "list tables", default: false
+      o.boolean "-h", "--help", "print help"
+      o.boolean "-v", "--version", "print version"
+
       o
     end
   end

data/lib/pgsync/version.rb

@@ -1,3 +1,3 @@
 module PgSync
-  VERSION = "0.6.4"
+  VERSION = "0.6.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pgsync
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2020-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.8.1
+        version: 4.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.8.1
+        version: 4.8.2
 - !ruby/object:Gem::Dependency
   name: tty-spinner
   requirement: !ruby/object:Gem::Requirement