pg_online_schema_change 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6580f86cf1fc33883f10391990817fb8c885b03eb4ecd1cd3095d46fc2a6bff5
-  data.tar.gz: 28b702f57765278ed7cdf9f7590c2bbf957d2debe8ace180bacd2a3f2fad98e3
+  metadata.gz: 8ef1069f7d159544838ec27cf518f98eb31609a0a2e1878ebd40246b10a6b534
+  data.tar.gz: 8e83cbac78164fb10870537bf4867020eae7cf06f4cd91930a2c8846fbc76c7c
 SHA512:
-  metadata.gz: b761947d35092a7479589ef2b1bc4f79290e5172d83e1f24bd23af37e4ecdfaf7e26a0d0b91dafed3ad68b6e3012dfcd9ff8f54c861f1270037e9582e1f9db7b
-  data.tar.gz: a4f8f44660858b0e3fb5d74847e8f4e46e46b5d5237cbea669dcb9880dd3cb6deae9c5b598120169769e57cdb07e67f72cfc0edd6d72ef8c46d8bc9f5284ded6
+  metadata.gz: 2657c94b3b07730aa3bb282f34cd1ee95f0549d3649b39a61be3ce1b6d2ba5832a1914b6a9788778c912464cbd9773b5e967ed4e6c896127d60e62a0daa76c99
+  data.tar.gz: 4788523d691c25045b7f3c539f9743d880fabcbb01887ae34ec55a6c8a829804a9f4d43f619e79e0c44b1c9fff6ea88361fb5ac1111bc1f491aa17e6e43336d0

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
 require:
   - rubocop-rspec
   - rubocop-packaging
@@ -14,71 +16,70 @@ AllCops:
     - "vendor/**/*"
 
 Layout/HashAlignment:
-  EnforcedColonStyle:
-    - table
-    - key
-  EnforcedHashRocketStyle:
-    - table
-    - key
+  EnforcedColonStyle: key
+  EnforcedHashRocketStyle:  key
 
 Layout/SpaceAroundEqualsInParameterDefault:
-  EnforcedStyle: no_space
+  EnforcedStyle: space
 
 Metrics/AbcSize:
-  Max: 20
+  Enabled: true
+  Max: 40
   Exclude:
-    - "test/**/*"
+    - "spec/**/*"
 
 Metrics/BlockLength:
+  Max: 100
   Exclude:
     - "*.gemspec"
     - "Rakefile"
+    - "spec/**/*"
 
 Metrics/ClassLength:
   Exclude:
     - "test/**/*"
 
 Metrics/MethodLength:
-  Max: 18
+  Max: 30
   Exclude:
     - "test/**/*"
 
 Metrics/ParameterLists:
-  Max: 6
+  Max: 5
 
 Naming/MemoizedInstanceVariableName:
-  Enabled: false
+  Enabled: true
 
 Naming/VariableNumber:
-  Enabled: false
-
-Rake/Desc:
-  Enabled: false
+  Enabled: true
 
 Style/BarePercentLiterals:
   EnforcedStyle: percent_q
 
 Style/ClassAndModuleChildren:
-  Enabled: false
+  Enabled: true
 
 Style/Documentation:
   Enabled: false
 
 Style/DoubleNegation:
-  Enabled: false
+  Enabled: true
 
 Style/EmptyMethod:
-  Enabled: false
+  Enabled: true
 
 Style/FrozenStringLiteralComment:
-  Enabled: false
+  Enabled: true
 
 Style/NumericPredicate:
-  Enabled: false
+  Enabled: true
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
 Style/TrivialAccessors:
   AllowPredicates: true
 
@@ -91,9 +92,41 @@ Style/TrailingCommaInArrayLiteral:
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
 
-Style/SpaceAroundEqualsInParameterDefault:
-  EnforcedStyle: space
+Layout/MultilineArrayBraceLayout:
+  Enabled: true
+  EnforcedStyle: symmetrical
 
-Style/MultilineHashBraceLayout:
+Layout/MultilineHashBraceLayout:
   Enabled: true
   EnforcedStyle: symmetrical
+
+Layout/MultilineAssignmentLayout:
+  Enabled: true
+  EnforcedStyle: same_line
+
+Layout/FirstArrayElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Layout/FirstHashElementIndentation:
+  Enabled: true
+  EnforcedStyle: consistent
+
+Layout/MultilineHashKeyLineBreaks:
+  Enabled: true
+
+Layout/LineLength:
+  Enabled: true
+  Max: 250
+
+Style/FormatStringToken:
+  Enabled: true
+  EnforcedStyle: template
+
+RSpec/MessageSpies:
+  Enabled: true
+  EnforcedStyle: receive
+
+RSpec/FilePath:
+  Enabled: true
+  SpecSuffixOnly: true

data/.rubocop_todo.yml

@@ -0,0 +1,44 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-02-21 22:46:44 UTC using RuboCop version 1.23.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 233
+
+# Offense count: 2
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+# Offense count: 2
+# Configuration parameters: IgnoredMethods.
+Metrics/PerceivedComplexity:
+  Max: 13
+
+# Offense count: 1
+Packaging/GemspecGit:
+  Exclude:
+    - 'pg_online_schema_change.gemspec'
+
+# Offense count: 62
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 55
+
+# Offense count: 38
+RSpec/MultipleExpectations:
+  Max: 14
+
+# Offense count: 6
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: respond_to_missing?
+Style/OptionalBooleanParameter:
+  Exclude:
+    - 'lib/pg_online_schema_change/query.rb'
+    - 'lib/pg_online_schema_change/replay.rb'

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## [0.3.0] - 2022-02-21
+
+- Explicitly call dependencies and bump dependencies by @shayonj https://github.com/shayonj/pg-osc/pull/44
+- Introduce Dockerfile and release process https://github.com/shayonj/pg-osc/pull/45
+
+## [0.2.0] - 2022-02-17
+
+- Use ISOLATION LEVEL SERIALIZABLE ([#42](https://github.com/shayonj/pg-osc/pull/42)) (props to @jfrost)
+
 ## [0.1.0] - 2022-02-16
 
 Initial release
@@ -6,4 +15,4 @@ pg-online-schema-change (`pg-osc`) is a tool for making schema changes (any `ALT
 
 `pg-osc` uses the concept of shadow table to perform schema changes. At a high level, it copies the contents from a primary table to a shadow table, performs the schema change on the shadow table and swaps the table names in the end while preserving all changes to the primary table using triggers (via audit table).
 
-Checkout [Readme](https://github.com/shayonj/pg-online-schema-change#readme) for more details.
+Checkout [Readme](https://github.com/shayonj/pg-osc#readme) for more details.

data/Dockerfile

@@ -0,0 +1,5 @@
+FROM ruby:3.0
+
+ARG VERSION=0.2.0
+
+RUN gem install pg_online_schema_change -v $VERSION

data/Gemfile

@@ -3,16 +3,3 @@
 source "https://rubygems.org"
 
 gemspec
-
-gem "ougai", "~> 2.0.0"
-gem "pg", "~> 1.0"
-gem "pg_query", "~> 2.1.2"
-gem "pry"
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.0"
-gem "rubocop", "~> 1.23.0"
-gem "rubocop-packaging", "~> 0.5.1"
-gem "rubocop-performance", "~> 1.12.0"
-gem "rubocop-rake", "~> 0.6.0"
-gem "rubocop-rspec", "~> 2.7.0"
-gem "thor", "~> 1.1.0"

data/Gemfile.lock

@@ -1,7 +1,11 @@
 PATH
   remote: .
   specs:
-    pg_online_schema_change (0.1.0)
+    pg_online_schema_change (0.3.0)
+      ougai (~> 2.0.0)
+      pg (~> 1.3.2)
+      pg_query (~> 2.1.3)
+      thor (~> 1.2.1)
 
 GEM
   remote: https://rubygems.org/
@@ -9,18 +13,18 @@ GEM
     ast (2.4.2)
     coderay (1.1.3)
     diff-lcs (1.5.0)
-    google-protobuf (3.19.2)
-    google-protobuf (3.19.2-x86_64-linux)
+    google-protobuf (3.19.4)
+    google-protobuf (3.19.4-x86_64-linux)
     method_source (1.0.0)
-    oj (3.13.10)
+    oj (3.13.11)
     ougai (2.0.0)
       oj (~> 3.10)
     parallel (1.21.0)
     parser (3.0.3.2)
       ast (~> 2.4.1)
-    pg (1.2.3)
-    pg_query (2.1.2)
-      google-protobuf (>= 3.17.1)
+    pg (1.3.2)
+    pg_query (2.1.3)
+      google-protobuf (>= 3.19.2)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -62,7 +66,7 @@ GEM
     rubocop-rspec (2.7.0)
       rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
-    thor (1.1.0)
+    thor (1.2.1)
     unicode-display_width (2.1.0)
 
 PLATFORMS
@@ -70,11 +74,8 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  ougai (~> 2.0.0)
-  pg (~> 1.0)
   pg_online_schema_change!
-  pg_query (~> 2.1.2)
-  pry
+  pry (~> 0.14.1)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.23.0)
@@ -82,7 +83,6 @@ DEPENDENCIES
   rubocop-performance (~> 1.12.0)
   rubocop-rake (~> 0.6.0)
   rubocop-rspec (~> 2.7.0)
-  thor (~> 1.1.0)
 
 BUNDLED WITH
    2.3.3

data/README.md

@@ -1,14 +1,35 @@
-# pg-online-schema-change / pg-osc
-[![CircleCI](https://circleci.com/gh/shayonj/pg-online-schema-change/tree/main.svg?style=shield)](https://circleci.com/gh/shayonj/pg-online-schema-change/tree/main)
+# pg-osc
+
+[![CircleCI](https://circleci.com/gh/shayonj/pg-osc/tree/main.svg?style=shield)](https://circleci.com/gh/shayonj/pg-osc/tree/main)
+[![Gem Version](https://badge.fury.io/rb/pg_online_schema_change.svg)](https://badge.fury.io/rb/pg_online_schema_change)
 
 pg-online-schema-change (`pg-osc`) is a tool for making schema changes (any `ALTER` statements) in Postgres tables with minimal locks, thus helping achieve zero downtime schema changes against production workloads. 
 
-`pg-osc` uses the concept of shadow table to perform schema changes. At a high level, it copies the contents from a primary table to a shadow table, performs the schema change on the shadow table and swaps the table names in the end while preserving all changes to the primary table using triggers (via audit table).
+`pg-osc` uses the concept of shadow table to perform schema changes. At a high level, it creates a shadow table that looks structurally the same as the primary table, performs the schema change on the shadow table, copies contents from the primary table to the shadow table and swaps the table names in the end while preserving all changes to the primary table using triggers (via audit table).
 
 `pg-osc` is inspired by the design and workings of tools like `pg_repack` and `pt-online-schema-change` (MySQL). Read more below on [how does it work](#how-does-it-work), [prominent features](#prominent-features), the [caveats](#caveats) and [examples](#examples)
 
 ⚠️ Proceed with caution when using this on production like workloads. Best to try on similar setup or staging like environment first. Read on below for some examples and caveats.
 
+## Table of Contents
+
+- [Installation](#installation)
+- [Requirements](#requirements)
+- [Usage](#usage)
+- [How does it work](#how-does-it-work)
+- [Prominent features](#prominent-features)
+- [Examples](#examples)
+  * [Renaming a column](#renaming-a-column)
+  * [Multiple ALTER statements](#multiple-alter-statements)
+  * [Kill other backends after 5s](#kill-other-backends-after-5s)
+  * [Backfill data](#backfill-data)
+  * [Running using Docker](#running-using-docker)
+- [Caveats](#caveats)
+- [Development](#development)
+- [Releasing](#releasing)
+- [Contributing](#contributing)
+- [License](#license)
+- [Code of Conduct](#code-of-conduct)
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -25,6 +46,13 @@ Or install it yourself as:
 
     $ gem install pg_online_schema_change
 
+This will include all dependencies accordingly as well. Make sure the following requirements are satisfied.
+
+Or via Docker:
+
+    docker pull shayonj/pg-osc:latest
+
+https://hub.docker.com/r/shayonj/pg-osc
 ## Requirements
 - PostgreSQL 9.6 and later
 - Ruby 2.6 and later
@@ -33,6 +61,8 @@ Or install it yourself as:
 ## Usage
 
 ```
+pg-online-schema-change help perform
+
 Usage:
   pg-online-schema-change perform -a, --alter-statement=ALTER_STATEMENT -d, --dbname=DBNAME -h, --host=HOST -p, --port=N -s, --schema=SCHEMA -u, --username=USERNAME -w, --password=PASSWORD
 
@@ -89,7 +119,7 @@ print the version
 - Copies over indexes and Foreign keys.
 - Optionally drop or retain old tables in the end.
 - Backfill old/new columns as data is copied from primary table to shadow table, and then perform the swap. [Example](#backfill-data)
-- **TBD**: Ability to reverse the change with no data loss. [tracking issue](https://github.com/shayonj/pg-online-schema-change/issues/14)
+- **TBD**: Ability to reverse the change with no data loss. [tracking issue](https://github.com/shayonj/pg-osc/issues/14)
 
 ## Examples
 
@@ -157,7 +187,20 @@ pg-online-schema-change perform \
   --copy-statement "/src/query.sql" \
   --drop
 ```
-### Caveats
+
+### Running using Docker
+
+```
+docker run --network host -it --rm shayonj/pg-osc:latest \
+    pg-online-schema-change perform \
+    --alter-statement 'ALTER TABLE books ADD COLUMN "purchased" BOOLEAN DEFAULT FALSE; ALTER TABLE books RENAME COLUMN email TO new_email;' \
+    --dbname "postgres" \
+    --host "localhost" \
+    --username "jamesbond" \
+    --password "" \
+    --drop
+```
+## Caveats
 - A primary key should exist on the table; without it, `pg-osc` will raise an exception
 	- This is because - currently there is no other way to uniquely identify rows during replay.
 - `pg-osc` will acquire `ACCESS EXCLUSIVE` lock on the parent table twice during the operation.
@@ -192,16 +235,14 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 ## Releasing
 
 - Bump version in `version.rb`
-- `git tag v0.1.0`
-- `git push origin --tags`
-- `gem build pg_online_schema_change.gemspec`
-- `gem push pg_online_schema_change-0.1.0.gem`
+- Commit
+- `./scripts/release.sh 0.2.0`
 - Update `CHANGELOG.md`
-- Create a new release - https://github.com/shayonj/pg-online-schema-change/releases/new
+- Create a new release - https://github.com/shayonj/pg-osc/releases/new
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/shayonj/pg-online-schema-change. 
+Bug reports and pull requests are welcome on GitHub at https://github.com/shayonj/pg-osc. 
 
 ## License
 
@@ -209,4 +250,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the PgOnlineSchemaChange project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/shayonj/pg-online-schema-change/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the PgOnlineSchemaChange project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/shayonj/pg-osc/blob/main/CODE_OF_CONDUCT.md).