pgslice 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d02cf8d6926bc4ed8908f1c9cc06bf406a3a926d99c08cba1e23f1ef8279f8fc
-  data.tar.gz: 4d68a0f7e771714d488f5e1c0bb4410f342f9f2e7e561fece795ee8d90b0e479
+  metadata.gz: 7b29363ba9973cca9be997f3bc62c748b27bee61d25da67f3d3af60f9166cec9
+  data.tar.gz: bb6be94d05a1ff1e059f3386ce4ba34a1a4698a25f89e676d8d3117d4d203ac4
 SHA512:
-  metadata.gz: 419d9ca61bc0fd990d5680fbb35c9b8a2de88b169b2882c5b28a8233082bf5f2c75e0cb9c531fb9538d0815777500ea773e2a61fff4d93b1e481ae81dc2d48a2
-  data.tar.gz: 55555b66db960941e2d766af939637d10b6fac19301ee5b3eb141ccb860963fdbdfd98bb2fac0f459184f75b084d1d463e095d644efc16161dae18285b36f66a
+  metadata.gz: abceaedcfa90cfa78954c3184baa02e270244d89b4be19016eb0e1c570902008745845018120182f4dbe543a42cf8d6d8926a52238245d95976946fcf1a49d6e
+  data.tar.gz: b5adb37599b3651e737f81193f50495a9ae416544cc96acb77f371c26083cae000c27dc740a9992d303815eb3a250881c7ce5c0dd7bf571e7c1b58f4df4dff66

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.4.4
+
+- Added partitioning by `year`
+- Fixed `--source-table` and `--dest-table` options
+- Added descriptions to options
+
 ## 0.4.3
 
 - Fixed sequence ownership

data/README.md

@@ -32,7 +32,7 @@ This will give you the `pgslice` command.
   pgslice prep <table> <column> <period>
   ```
 
-  Period can be `day` or `month`.
+  Period can be `day`, `month`, or `year`.
 
   This creates a table named `<table>_intermediate` with the appropriate trigger for partitioning.
 
@@ -98,7 +98,7 @@ BEGIN;
 
 CREATE TABLE visits_intermediate (LIKE visits INCLUDING DEFAULTS INCLUDING CONSTRAINTS INCLUDING STORAGE INCLUDING COMMENTS) PARTITION BY RANGE (created_at);
 
-COMMENT ON TABLE visits_intermediate is 'column:created_at,period:day';
+COMMENT ON TABLE visits_intermediate is 'column:created_at,period:month';
 
 COMMIT;
 
@@ -261,7 +261,7 @@ To add partitions, use:
 pgslice add_partitions <table> --future 3
 ```
 
-Add this as a cron job to create a new partition each day or month.
+Add this as a cron job to create a new partition each day, month, or year.
 
 ```sh
 # day
@@ -269,6 +269,9 @@ Add this as a cron job to create a new partition each day or month.
 
 # month
 0 0 1 * * pgslice add_partitions <table> --future 3 --url ...
+
+# year
+0 0 1 1 * pgslice add_partitions <table> --future 3 --url ...
 ```
 
 Add a monitor to ensure partitions are being created.
@@ -283,11 +286,12 @@ WHERE
     n.nspname = 'public' AND
     c.relname = '<table>_' || to_char(NOW() + INTERVAL '3 days', 'YYYYMMDD')
     -- for months, use to_char(NOW() + INTERVAL '3 months', 'YYYYMM')
+    -- for years, use to_char(NOW() + INTERVAL '3 years', 'YYYY')
 ```
 
 ## Archiving Partitions
 
-Back up and drop older partitions each day or month.
+Back up and drop older partitions each day, month, or year.
 
 ```sh
 pg_dump -c -Fc -t <table>_201609 $PGSLICE_URL > <table>_201609.dump

data/lib/pgslice/client.rb

@@ -2,8 +2,8 @@ module PgSlice
   class Client < Thor
     check_unknown_options!
 
-    class_option :url
-    class_option :dry_run, type: :boolean, default: false
+    class_option :url, desc: "Database URL"
+    class_option :dry_run, type: :boolean, default: false, desc: "Print statements without executing"
 
     map %w[--version -v] => :version
 
@@ -13,7 +13,8 @@ module PgSlice
 
     SQL_FORMAT = {
       day: "YYYYMMDD",
-      month: "YYYYMM"
+      month: "YYYYMM",
+      year: "YYYY"
     }
 
     def initialize(*args)
@@ -24,10 +25,10 @@ module PgSlice
     end
 
     desc "prep TABLE [COLUMN] [PERIOD]", "Create an intermediate table for partitioning"
-    option :partition, type: :boolean, default: true
-    option :trigger_based, type: :boolean, default: false
+    option :partition, type: :boolean, default: true, desc: "Partition the table"
+    option :trigger_based, type: :boolean, default: false, desc: "Use trigger-based partitioning"
     def prep(table, column=nil, period=nil)
-      table = Table.new(qualify_table(table))
+      table = qualify_table(table)
       intermediate_table = table.intermediate_table
       trigger_name = table.trigger_name
 
@@ -102,7 +103,7 @@ COMMENT ON TRIGGER #{quote_ident(trigger_name)} ON #{quote_table(intermediate_ta
 
     desc "unprep TABLE", "Undo prep"
     def unprep(table)
-      table = Table.new(qualify_table(table))
+      table = qualify_table(table)
       intermediate_table = table.intermediate_table
       trigger_name = table.trigger_name
 
@@ -116,11 +117,11 @@ COMMENT ON TRIGGER #{quote_ident(trigger_name)} ON #{quote_table(intermediate_ta
     end
 
     desc "add_partitions TABLE", "Add partitions"
-    option :intermediate, type: :boolean, default: false
-    option :past, type: :numeric, default: 0
-    option :future, type: :numeric, default: 0
+    option :intermediate, type: :boolean, default: false, desc: "Add to intermediate table"
+    option :past, type: :numeric, default: 0, desc: "Number of past partitions to add"
+    option :future, type: :numeric, default: 0, desc: "Number of future partitions to add"
     def add_partitions(table)
-      original_table = Table.new(qualify_table(table))
+      original_table = qualify_table(table)
       table = options[:intermediate] ? original_table.intermediate_table : original_table
       trigger_name = original_table.trigger_name
 
@@ -245,17 +246,17 @@ CREATE OR REPLACE FUNCTION #{quote_ident(trigger_name)}()
     end
 
     desc "fill TABLE", "Fill the partitions in batches"
-    option :batch_size, type: :numeric, default: 10000
-    option :swapped, type: :boolean, default: false
-    option :source_table
-    option :dest_table
-    option :start
-    option :where
-    option :sleep, type: :numeric
+    option :batch_size, type: :numeric, default: 10000, desc: "Batch size"
+    option :swapped, type: :boolean, default: false, desc: "Use swapped table"
+    option :source_table, desc: "Source table"
+    option :dest_table, desc: "Destination table"
+    option :start, type: :numeric, desc: "Primary key to start"
+    option :where, desc: "Conditions to filter"
+    option :sleep, type: :numeric, desc: "Seconds to sleep between batches"
     def fill(table)
-      table = Table.new(qualify_table(table))
-      source_table = Table.new(options[:source_table]) if options[:source_table]
-      dest_table = Table.new(options[:dest_table]) if options[:dest_table]
+      table = qualify_table(table)
+      source_table = qualify_table(options[:source_table]) if options[:source_table]
+      dest_table = qualify_table(options[:dest_table]) if options[:dest_table]
 
       if options[:swapped]
         source_table ||= table.retired_table
@@ -345,9 +346,9 @@ INSERT INTO #{quote_table(dest_table)} (#{fields})
     end
 
     desc "swap TABLE", "Swap the intermediate table with the original table"
-    option :lock_timeout, default: "5s"
+    option :lock_timeout, default: "5s", desc: "Lock timeout"
     def swap(table)
-      table = Table.new(qualify_table(table))
+      table = qualify_table(table)
       intermediate_table = table.intermediate_table
       retired_table = table.retired_table
 
@@ -371,7 +372,7 @@ INSERT INTO #{quote_table(dest_table)} (#{fields})
 
     desc "unswap TABLE", "Undo swap"
     def unswap(table)
-      table = Table.new(qualify_table(table))
+      table = qualify_table(table)
       intermediate_table = table.intermediate_table
       retired_table = table.retired_table
 
@@ -392,9 +393,9 @@ INSERT INTO #{quote_table(dest_table)} (#{fields})
     end
 
     desc "analyze TABLE", "Analyze tables"
-    option :swapped, type: :boolean, default: false
+    option :swapped, type: :boolean, default: false, desc: "Use swapped table"
     def analyze(table)
-      table = Table.new(qualify_table(table))
+      table = qualify_table(table)
       parent_table = options[:swapped] ? table : table.intermediate_table
 
       existing_tables = table.existing_partitions
@@ -502,8 +503,10 @@ INSERT INTO #{quote_table(dest_table)} (#{fields})
       case period.to_sym
       when :day
         "%Y%m%d"
-      else
+      when :month
         "%Y%m"
+      else
+        "%Y"
       end
     end
 
@@ -512,8 +515,10 @@ INSERT INTO #{quote_table(dest_table)} (#{fields})
       case period.to_sym
       when :day
         date
-      else
+      when :month
         Date.new(date.year, date.month)
+      else
+        Date.new(date.year)
       end
     end
 
@@ -522,8 +527,10 @@ INSERT INTO #{quote_table(dest_table)} (#{fields})
       case period.to_sym
       when :day
         date.next_day(count)
-      else
+      when :month
         date.next_month(count)
+      else
+        date.next_year(count)
       end
     end
 
@@ -540,7 +547,7 @@ INSERT INTO #{quote_table(dest_table)} (#{fields})
     end
 
     def qualify_table(table)
-      table.to_s.include?(".") ? table : [schema, table].join(".")
+      Table.new(table.to_s.include?(".") ? table : [schema, table].join("."))
     end
 
     def settings_from_trigger(original_table, table)
@@ -555,7 +562,7 @@ INSERT INTO #{quote_table(dest_table)} (#{fields})
 
       unless period
         needs_comment = true
-        function_def = execute("select pg_get_functiondef(oid) from pg_proc where proname = $1", [trigger_name])[0]
+        function_def = execute("SELECT pg_get_functiondef(oid) FROM pg_proc WHERE proname = $1", [trigger_name])[0]
         return [] unless function_def
         function_def = function_def["pg_get_functiondef"]
         sql_format = SQL_FORMAT.find { |_, f| function_def.include?("'#{f}'") }

data/lib/pgslice/table.rb

@@ -42,6 +42,8 @@ module PgSlice
           8
         when "month"
           6
+        when "year"
+          4
         else
           "6,8"
         end

data/lib/pgslice/version.rb

@@ -1,3 +1,3 @@
 module PgSlice
-  VERSION = "0.4.3"
+  VERSION = "0.4.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pgslice
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Andrew Kane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-17 00:00:00.000000000 Z
+date: 2018-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor