pg_online_schema_change 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d69a5ecadf6f0c3b3c27bb2e16e163cfbc6526c4c83b5cbdf4ebef73be62cf9
-  data.tar.gz: 5a8ac6b5491692d4680f40637550392ebe5e8a206e7e3b1729967a379231ee8a
+  metadata.gz: b06d39169d55c016d78969968c71cac7f0c49a3c716d0bc8c5004905ef820fb0
+  data.tar.gz: 78fcc0a928a5efa645ec201cfca093f4ef078b8d683f0776a7f9ad91bb11ef99
 SHA512:
-  metadata.gz: 5b8960dae33e3cf5bace38cb45cacaa555d16433b15703ffda2f2338b5076e716c23271d5f08d77f033cfbe9c6f2ea450e764a8ce934bb3ec9bfd9327cf89735
-  data.tar.gz: f003a55abb25ad2bcecf5a4e3b2358bfac4b3c0c55c401f7500a8d92e2b5bd30ebb4891d934cec52a1449e65a4fd9d177a9f87a2493d72b3f949ef47493943e8
+  metadata.gz: 179fcaf09bcc36b69186ba48494835841a88c095e010756f0e6f322a146279d0790403f2c195f23f483e89a1cb74c10b50a3ceee26ad6d311e3d9977af1b8c07
+  data.tar.gz: 157255f9d901ec2cb980d84bd664cc0eaae32854bdd79ebd262b2112eef965f8dc2d123277a35446fefd6ecdac4a4ba4c94769589461053241d1eedbe40efa52

data/CHANGELOG.md

@@ -1,6 +1,6 @@
 ## [0.2.0] - 2022-02-17
 
-- Use ISOLATION LEVEL SERIALIZABLE ([#42](https://github.com/shayonj/pg-online-schema-change/pull/42)) (props to @jfrost)
+- Use ISOLATION LEVEL SERIALIZABLE ([#42](https://github.com/shayonj/pg-osc/pull/42)) (props to @jfrost)
 
 ## [0.1.0] - 2022-02-16
 
@@ -10,4 +10,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.2.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,5 +1,6 @@
-# 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. 
@@ -10,6 +11,25 @@ pg-online-schema-change (`pg-osc`) is a tool for making schema changes (any `ALT
 
 ⚠️ 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:
@@ -26,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
@@ -92,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
 
@@ -160,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.
@@ -195,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
 
@@ -212,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).