pgslice 0.4.7 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73d406b68757fa95efcc58a98249f9a8394cab3408a9ae14ef642983720f44b3
-  data.tar.gz: 7952c9aaa1734c76260b76a59822a4065e6184ac01bf3b1916bd217f7b368403
+  metadata.gz: 38dff970617c4a96ee7b9234d345e841e0c496d02abbc1900a028a7f0cb46b87
+  data.tar.gz: 24aa5b2b515991c0310fc3dc8cf54c6a7f322b4ee8743bc5e745ca85a1831cec
 SHA512:
-  metadata.gz: 057aeaddcf952f2bb99f657f290e03f2ec3bac2deffce0d7701a7549418d7d8211b2454cbc71039226b369fc5b355d7ad426df0c4ce032d660e8ce09ebe15eab
-  data.tar.gz: a36f9db976f72cc656e289ff5af6ebb89657eb739fb6ca1bc4ccba652fdfa8b93894bc2e3fde5a9fdcd63d53a24574347a280af60157d124445a565810b9839c
+  metadata.gz: f63af4550ae70f3fe03e3e4104a43652529d0da576f909c23512ea4a3fa12e2b7f3dd9c526821c69f4b01ec685c5f72d9c8988e5ff4ae74f391e846540c068f4
+  data.tar.gz: 405bb97384272d35e85fb0395e8ec367d1db62bdd7120cb0c9f03c9faa728c804256949fbc78eaf8c048b21aefe93106b3da60f8f9741e83dbb47aec23e64008

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.5.0 (2023-01-29)
+
+- Dropped support for Ruby < 2.5
+
+## 0.4.8 (2022-02-28)
+
+- Fixed error with pg 1.3
+- Reduced size of Docker image
+
 ## 0.4.7 (2020-08-14)
 
 - Added `--tablespace` option to `add_partitions`

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-2020 Andrew Kane
+Copyright (c) 2016-2023 Andrew Kane
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -4,7 +4,7 @@ Postgres partitioning as easy as pie. Works great for both new and existing tabl
 
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
 
-[![Build Status](https://travis-ci.org/ankane/pgslice.svg?branch=master)](https://travis-ci.org/ankane/pgslice)
+[![Build Status](https://github.com/ankane/pgslice/workflows/build/badge.svg?branch=master)](https://github.com/ankane/pgslice/actions)
 
 ## Install
 
@@ -14,7 +14,7 @@ pgslice is a command line tool. To install, run:
 gem install pgslice
 ```
 
-This will give you the `pgslice` command. If installation fails, you may need to install [dependencies](#dependencies).
+This will give you the `pgslice` command. You can also install it with [Homebrew](#homebrew) or [Docker](#docker). If installation fails, you may need to install [dependencies](#dependencies).
 
 ## Steps
 
@@ -108,17 +108,17 @@ pgslice add_partitions visits --intermediate --past 1 --future 1
 ```sql
 BEGIN;
 
-CREATE TABLE "public"."visits_201808" PARTITION OF "public"."visits_intermediate" FOR VALUES FROM ('2018-08-01') TO ('2018-09-01');
+CREATE TABLE "public"."visits_202108" PARTITION OF "public"."visits_intermediate" FOR VALUES FROM ('2021-08-01') TO ('2021-09-01');
 
-ALTER TABLE "public"."visits_201808" ADD PRIMARY KEY ("id");
+ALTER TABLE "public"."visits_202108" ADD PRIMARY KEY ("id");
 
-CREATE TABLE "public"."visits_201809" PARTITION OF "public"."visits_intermediate" FOR VALUES FROM ('2018-09-01') TO ('2018-10-01');
+CREATE TABLE "public"."visits_202109" PARTITION OF "public"."visits_intermediate" FOR VALUES FROM ('2021-09-01') TO ('2021-10-01');
 
-ALTER TABLE "public"."visits_201809" ADD PRIMARY KEY ("id");
+ALTER TABLE "public"."visits_202109" ADD PRIMARY KEY ("id");
 
-CREATE TABLE "public"."visits_201810" PARTITION OF "public"."visits_intermediate" FOR VALUES FROM ('2018-10-01') TO ('2018-11-01');
+CREATE TABLE "public"."visits_202110" PARTITION OF "public"."visits_intermediate" FOR VALUES FROM ('2021-10-01') TO ('2021-11-01');
 
-ALTER TABLE "public"."visits_201808" ADD PRIMARY KEY ("id");
+ALTER TABLE "public"."visits_202110" ADD PRIMARY KEY ("id");
 
 COMMIT;
 ```
@@ -131,17 +131,17 @@ pgslice fill visits
 /* 1 of 3 */
 INSERT INTO "public"."visits_intermediate" ("id", "user_id", "ip", "created_at")
     SELECT "id", "user_id", "ip", "created_at" FROM "public"."visits"
-    WHERE "id" > 0 AND "id" <= 10000 AND "created_at" >= '2018-08-01'::date AND "created_at" < '2018-11-01'::date
+    WHERE "id" > 0 AND "id" <= 10000 AND "created_at" >= '2021-08-01'::date AND "created_at" < '2021-11-01'::date
 
 /* 2 of 3 */
 INSERT INTO "public"."visits_intermediate" ("id", "user_id", "ip", "created_at")
     SELECT "id", "user_id", "ip", "created_at" FROM "public"."visits"
-    WHERE "id" > 10000 AND "id" <= 20000 AND "created_at" >= '2018-08-01'::date AND "created_at" < '2018-11-01'::date
+    WHERE "id" > 10000 AND "id" <= 20000 AND "created_at" >= '2021-08-01'::date AND "created_at" < '2021-11-01'::date
 
 /* 3 of 3 */
 INSERT INTO "public"."visits_intermediate" ("id", "user_id", "ip", "created_at")
     SELECT "id", "user_id", "ip", "created_at" FROM "public"."visits"
-    WHERE "id" > 20000 AND "id" <= 30000 AND "created_at" >= '2018-08-01'::date AND "created_at" < '2018-11-01'::date
+    WHERE "id" > 20000 AND "id" <= 30000 AND "created_at" >= '2021-08-01'::date AND "created_at" < '2021-11-01'::date
 ```
 
 ```sh
@@ -149,11 +149,11 @@ pgslice analyze visits
 ```
 
 ```sql
-ANALYZE VERBOSE "public"."visits_201808";
+ANALYZE VERBOSE "public"."visits_202108";
 
-ANALYZE VERBOSE "public"."visits_201809";
+ANALYZE VERBOSE "public"."visits_202109";
 
-ANALYZE VERBOSE "public"."visits_201810";
+ANALYZE VERBOSE "public"."visits_202110";
 
 ANALYZE VERBOSE "public"."visits_intermediate";
 ```
@@ -217,16 +217,25 @@ WHERE
 Back up and drop older partitions each day, month, or year.
 
 ```sh
-pg_dump -c -Fc -t <table>_201809 $PGSLICE_URL > <table>_201809.dump
-psql -c "DROP TABLE <table>_201809" $PGSLICE_URL
+pg_dump -c -Fc -t <table>_202109 $PGSLICE_URL > <table>_202109.dump
+psql -c "DROP TABLE <table>_202109" $PGSLICE_URL
 ```
 
 If you use [Amazon S3](https://aws.amazon.com/s3/) for backups, [s3cmd](https://github.com/s3tools/s3cmd) is a nice tool.
 
 ```sh
-s3cmd put <table>_201809.dump s3://<s3-bucket>/<table>_201809.dump
+s3cmd put <table>_202109.dump s3://<s3-bucket>/<table>_202109.dump
 ```
 
+## Schema Updates
+
+Once a table is partitioned, make schema updates on the master table only (not partitions). This includes adding, removing, and modifying columns, as well as adding and removing indexes and foreign keys.
+
+A few exceptions are:
+
+- For Postgres 10, make index and foreign key updates on partitions only
+- For Postgres < 10, make index and foreign key updates on the master table and all partitions
+
 ## Additional Commands
 
 To undo prep (which will delete partitions), use:
@@ -241,6 +250,14 @@ To undo swap, use:
 pgslice unswap <table>
 ```
 
+## Additional Options
+
+Set the tablespace when adding partitions
+
+```sh
+pgslice add_partitions <table> --tablespace fastspace
+```
+
 ## App Considerations
 
 This set up allows you to read and write with the original table name with no knowledge it’s partitioned. However, there are a few things to be aware of.
@@ -255,7 +272,7 @@ SELECT * FROM
 WHERE
     user_id = 123 AND
     -- for performance
-    created_at >= '2018-09-01' AND created_at < '2018-09-02'
+    created_at >= '2021-09-01' AND created_at < '2021-09-02'
 ```
 
 For this to be effective, ensure `constraint_exclusion` is set to `partition` (default value) or `on`.
@@ -271,7 +288,9 @@ Before Postgres 10, if you use `INSERT` statements with a `RETURNING` clause (as
 1. Insert directly into the partition
 2. Get value before the insert with `SELECT nextval('sequence_name')` (for multiple rows, append `FROM generate_series(1, n)`)
 
-## Rails
+## Frameworks
+
+### Rails
 
 For Postgres 10+, specify the primary key for partitioned models to ensure it’s returned.
 
@@ -291,6 +310,10 @@ class Visit < ApplicationRecord
 end
 ```
 
+### Other Frameworks
+
+Please submit a PR if additional configuration is needed.
+
 ## One Off Tasks
 
 You can also use pgslice to reduce the size of a table without partitioning by creating a new table, filling it with a subset of records, and swapping it in.
@@ -301,17 +324,9 @@ pgslice fill <table> --where "id > 1000" # use any conditions
 pgslice swap <table>
 ```
 
-## Schema Updates
+## Triggers
 
-Once a table is partitioned, here’s how to change the schema:
-
-To add, remove, or modify a column, make the update on the master table only.
-
-To add or remove an index or foreign key:
-
-- For Postgres 11+, make the update on the master table only.
-- For Postgres 10, make the update on partitions only.
-- For Postgres < 10, make the update on the master table and all partitions.
+Triggers aren’t copied from the original table. You can set up triggers on the intermediate table if needed. Note that Postgres doesn’t support `BEFORE / FOR EACH ROW` triggers on partitioned tables.
 
 ## Declarative Partitioning
 
@@ -321,6 +336,27 @@ Postgres 10 introduces [declarative partitioning](https://www.postgresql.org/doc
 
 Always make sure your [connection is secure](https://ankane.org/postgres-sslmode-explained) when connecting to a database over a network you don’t fully trust. Your best option is to connect over SSH or a VPN. Another option is to use `sslmode=verify-full`. If you don’t do this, your database credentials can be compromised.
 
+## Additional Installation Methods
+
+### Homebrew
+
+With Homebrew, you can use:
+
+```sh
+brew install ankane/brew/pgslice
+```
+
+### Docker
+
+Get the [Docker image](https://hub.docker.com/r/ankane/pgslice) with:
+
+```sh
+docker pull ankane/pgslice
+alias pgslice="docker run --rm -e PGSLICE_URL ankane/pgslice"
+```
+
+This will give you the `pgslice` command.
+
 ## Dependencies
 
 If installation fails, your system may be missing Ruby or libpq.
@@ -328,7 +364,7 @@ If installation fails, your system may be missing Ruby or libpq.
 On Mac, run:
 
 ```sh
-brew install postgresql
+brew install libpq
 ```
 
 On Ubuntu, run:
@@ -352,15 +388,6 @@ gem install specific_install
 gem specific_install https://github.com/ankane/pgslice.git
 ```
 
-## Docker
-
-```sh
-docker build -t pgslice .
-alias pgslice="docker run --rm -e PGSLICE_URL pgslice"
-```
-
-This will give you the `pgslice` command.
-
 ## Reference
 
 - [PostgreSQL Manual](https://www.postgresql.org/docs/current/static/ddl-partitioning.html)

data/lib/pgslice/cli/add_partitions.rb

@@ -27,7 +27,7 @@ module PgSlice
       queries = []
 
       if needs_comment
-        queries << "COMMENT ON TRIGGER #{quote_ident(trigger_name)} ON #{quote_table(table)} is 'column:#{field},period:#{period},cast:#{cast}';"
+        queries << "COMMENT ON TRIGGER #{quote_ident(trigger_name)} ON #{quote_table(table)} IS 'column:#{field},period:#{period},cast:#{cast}';"
       end
 
       # today = utc date

data/lib/pgslice/cli/prep.rb

@@ -57,7 +57,7 @@ CREATE TABLE #{quote_table(intermediate_table)} (LIKE #{quote_table(table)} INCL
         # add comment
         cast = table.column_cast(column)
         queries << <<-SQL
-COMMENT ON TABLE #{quote_table(intermediate_table)} is 'column:#{column},period:#{period},cast:#{cast},version:#{version}';
+COMMENT ON TABLE #{quote_table(intermediate_table)} IS 'column:#{column},period:#{period},cast:#{cast},version:#{version}';
         SQL
       else
         queries << <<-SQL
@@ -87,7 +87,7 @@ CREATE TRIGGER #{quote_ident(trigger_name)}
 
         cast = table.column_cast(column)
         queries << <<-SQL
-COMMENT ON TRIGGER #{quote_ident(trigger_name)} ON #{quote_table(intermediate_table)} is 'column:#{column},period:#{period},cast:#{cast}';
+COMMENT ON TRIGGER #{quote_ident(trigger_name)} ON #{quote_table(intermediate_table)} IS 'column:#{column},period:#{period},cast:#{cast}';
         SQL
       end
 

data/lib/pgslice/helpers.rb

@@ -33,7 +33,7 @@ module PgSlice
         params = CGI.parse(uri.query.to_s)
         # remove schema
         @schema = Array(params.delete("schema") || "public")[0]
-        uri.query = URI.encode_www_form(params)
+        uri.query = params.any? ? URI.encode_www_form(params) : nil
 
         ENV["PGCONNECT_TIMEOUT"] ||= "1"
         conn = PG::Connection.new(uri.to_s)

data/lib/pgslice/version.rb

@@ -1,3 +1,3 @@
 module PgSlice
-  VERSION = "0.4.7"
+  VERSION = "0.5.0"
 end

data/lib/pgslice.rb

@@ -7,16 +7,16 @@ require "cgi"
 require "time"
 
 # modules
-require "pgslice/helpers"
-require "pgslice/table"
-require "pgslice/version"
+require_relative "pgslice/helpers"
+require_relative "pgslice/table"
+require_relative "pgslice/version"
 
 # commands
-require "pgslice/cli"
-require "pgslice/cli/add_partitions"
-require "pgslice/cli/analyze"
-require "pgslice/cli/fill"
-require "pgslice/cli/prep"
-require "pgslice/cli/swap"
-require "pgslice/cli/unprep"
-require "pgslice/cli/unswap"
+require_relative "pgslice/cli"
+require_relative "pgslice/cli/add_partitions"
+require_relative "pgslice/cli/analyze"
+require_relative "pgslice/cli/fill"
+require_relative "pgslice/cli/prep"
+require_relative "pgslice/cli/swap"
+require_relative "pgslice/cli/unprep"
+require_relative "pgslice/cli/unswap"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pgslice
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.5.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-14 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -38,50 +38,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.18.2
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: 
-email: andrew@chartkick.com
+description:
+email: andrew@ankane.org
 executables:
 - pgslice
 extensions: []
@@ -107,7 +65,7 @@ homepage: https://github.com/ankane/pgslice
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -115,15 +73,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.4.1
+signing_key:
 specification_version: 4
 summary: Postgres partitioning as easy as pie
 test_files: []