Merge pull request #7 from joncrlsn/release/0.9.1

Release/0.9.1

Former-commit-id: 5052ff7

Author: joncrlsn

LICENSE

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

README.md

@@ -1,36 +1,91 @@
 # pgdiff - PostgreSQL schema diff
 
-An important feature of this utility is that it never modifies any database directly. You are solely responsible for verifying the generated SQL *before* running it against your database.  Now that you know about that, it should give you confidence that it is safe to try out and see what SQL gets generated.
+pgdiff compares the schema between two PostgreSQL 9 databases and generates alter statements to be *manually* run against the second database to make them match.  The provided pgdiff.sh script helps automate the process.  
 
-Written in GoLang, pgdiff compares the schema between two PostgreSQL databases and generates alter statements to be *manually* run against the second database.  At the moment, not everything in the schema is compared, but the things considered important are: roles, sequences, tables, columns (and their default values), primary keys, unique constraints, foreign keys, roles, ownership information, and grants. 
+pgdiff is transparent in what it does, so it never modifies a database directly. You alone are responsible for verifying the generated SQL before running it against your database.  Go ahead and see what SQL gets generated.
+
+pgdiff is written to be easy to expand and improve the accuracy of the diff.
 
-It is written to be easy to add and improve the accuracy of the diff.  If you find something that seems wrong and you want me to look at it, please send me two schema-only database dumps that I can test with (Use the --schema-only option with pg\_dump)
 
 ### download
-[osx64](https://github.com/joncrlsn/pgrun/raw/master/bin-osx64/pgdiff "OSX 64-bit version")
-[osx32](https://github.com/joncrlsn/pgrun/raw/master/bin-osx32/pgdiff "OSX version")
-[linux64](https://github.com/joncrlsn/pgrun/raw/master/bin-linux64/pgdiff "Linux 64-bit version")
-[linux32](https://github.com/joncrlsn/pgrun/raw/master/bin-linux32/pgdiff "Linux version")
-[win64](https://github.com/joncrlsn/pgrun/raw/master/bin-win64/pgdiff.exe "Windows 64-bit version")
-[win32](https://github.com/joncrlsn/pgrun/raw/master/bin-win32/pgdiff.exe "Windows version")
+[osx](https://github.com/joncrlsn/pgrun/raw/master/bin-osx/pgdiff "OSX version")   [linux](https://github.com/joncrlsn/pgrun/raw/master/bin-linux/pgdiff "Linux version")    [windows](https://github.com/joncrlsn/pgrun/raw/master/bin-win/pgdiff.exe "Windows version")
 
 
 ### usage
+	pgdiff [options] <schemaType>
+
+ (where options are defined below and &lt;schemaType&gt; can be: ROLE, SEQUENCE, TABLE, COLUMN, INDEX, FUNCTION, VIEW, FOREIGN\_KEY, OWNER, GRANT\_RELATIONSHIP, GRANT\_ATTRIBUTE, TRIGGER)
+
+I've found that there is an ideal order for running the different schema types.  This order should minimize the problems you encounter.  For example, you'll always want to add new tables before you add new columns.  This is the order that has worked for me, however "your mileage may vary".
+
+1. FUNCTION
+1. ROLE
+1. SEQUENCE
+1. TABLE
+1. COLUMN
+1. VIEW
+1. OWNER
+1. INDEX
+1. FOREIGN\_KEY
+1. GRANT\_RELATIONSHIP
+1. GRANT\_ATTRIBUTE
+1. TRIGGER
+
+
+### example
+I have found it helpful to take ```--schema-only``` dumps of the databases in question, load them into a local postgres, then do my sql generation and testing there before running the SQL against a more official database. Your local postgres instance will need the correct users/roles populated because db dumps don't copy that information.
+
+```
+pgdiff -U dbuser -H localhost -D refDB  -O 'sslmode=disable' \
+       -u dbuser -h localhost -d compDB -o 'sslmode=disable' \
+       TABLE 
+```
+
+
+### options
+
+options           | explanation 
+----------------: | ------------------------------------
+  -V, --version   | prints the version of pgdiff being used
+  -?, --help      | displays helpful usage information
+  -U, --user1     | first postgres user
+  -u, --user2     | second postgres user
+  -W, --password1 | first db password
+  -w, --password2 | second db password
+  -H, --host1     | first db host. default is localhost
+  -h, --host2     | second db host. default is localhost
+  -P, --port1     | first db port number. default is 5432
+  -p, --port2     | second db port number. default is 5432
+  -D, --dbname1   | first db name
+  -d, --dbname2   | second db name
+  -O, --option1   | first db options. example: sslmode=disable
+  -o, --option2   | second db options. example: sslmode=disable
+
+
+### getting started on linux and osx
+linux and osx binaries are packaged with an extra, optional bash script and pgrun program that helps speed the diffing process. 
+1. download the tgz file for your OS
+1. untar it:  ```tar -xzvf pgdiff.tgz```
+1. cd to the new pgdiff directory
+1. edit the db connection defaults in pgdiff.sh 
+1. ...or manually run pgdiff for each schema type listed in the usage section above
+1. review the SQL output for each schema type and, if you want to make them match, run it against db2 
+
+
+### getting started on windows
+1. download pgdiff.exe from the bin-win directory on github
+1. edit the db connection defaults in pgdiff.sh or...
+1. manually run pgdiff for each schema type listed in the usage section above
+1. review the SQL output and, if you want to make them match, run it against db2 
 
-	pgdiff [database flags] <schemaType>
 
+### version history
+1. 0.9.0 - Implemented ROLE, SEQUENCE, TABLE, COLUMN, INDEX, FOREIGN\_KEY, OWNER, GRANT\_RELATIONSHIP, GRANT\_ATTRIBUTE
+1. 0.9.1 - Added VIEW, FUNCTION, and TRIGGER (Thank you, Shawn Carroll AKA SparkeyG)
 
- program flags | Explanation 
--------------: | ------------------------------------
-  -U1          | first db postgres user
-  -pw1         | first db password
-  -h1          | first db host -- default is localhost
-  -p1          | first db port number.  defaults to 5432
-  -d1          | first db name
-  -U2          | second db postgres user
-  -pw2         | second db password
-  -h2          | second db host -- default is localhost
-  -p2          | second db port number.  defaults to 5432
-  -d2          | second db name
 
-&lt;schemaType&gt; the type of objects in the schema to compare: ALL, ROLE, SEQUENCE, TABLE, COLUMN, INDEX, FOREIGN_KEY, OWNER, GRANT_RELATIONSHIP, GRANT_ATTRIBUTE
+### todo
+1. fix SQL for adding an array column
+1. add windows version of pgdiff.sh (or even better: re-write it in Go)
+1. allow editing of individual SQL lines after failure (this would probably be done in the script pgdiff.sh)
+1. store failed SQL statements in an error file for later fixing and rerunning?

bin-linux/README.md

@@ -0,0 +1,16 @@
+## Linux pgdiff instructions
+
+These instructions will guide you through the process of generating SQL, reviewing it, and optionally running it on the target database. It requires a familiarity with a Linux command-line shell.
+
+1. download pgdiff.tgz to your machine
+1. untar pgdiff.tgz (a new directory will be created: called pgdiff)
+1. cd into the new pgdiff directory
+1. optionally edit pgdiff.sh to change the db access values... or set them at runtime (i.e. USER1=joe NAME1=mydb USER2=joe NAME2=myotherdb ./pgdiff.sh)
+1. run pgdiff.sh
+
+## tar contents
+* pgdiff - a linux executable
+* pgrun - a linux executable for running SQL
+* pgdiff.sh - a bash shell script to coordinate your interaction with pgdiff and pgrun
+
+If you write a Go version of pgdiff.sh, please share it and I'll include it for others to use (with your copyright information intact). 

bin-linux/pgdiff.tgz.REMOVED.git-id

@@ -0,0 +1 @@
+a43bac9815b274229ca929f86bedc43fdd4454a1

bin-linux32/pgdiff.REMOVED.git-id

@@ -0,0 +1,16 @@
+## OSX / Mac pgdiff instructions
+
+These instructions will guide you through the process of generating SQL, reviewing it, and optionally running it on the target database.  It requires a familiarity with the bash shell in OSX.
+
+1. download pgdiff.tgz to your machine
+1. untar pgdiff.tgz (a new directory will be created: called pgdiff)
+1. cd into the new pgdiff directory
+1. optionally edit pgdiff.sh to change the db access values... or set them at runtime (i.e. USER1=joe NAME1=mydb USER2=joe NAME2=myotherdb ./pgdiff.sh)
+1. run pgdiff.sh
+
+## tar contents
+* pgdiff - an OSX executable
+* pgrun - an OSX executable for running SQL
+* pgdiff.sh - a bash shell script to coordinate your interaction with pgdiff and pgrun
+
+If you write a Go version of pgdiff.sh, please share it and I'll include it for others to use (with your copyright information intact). 

bin-linux64/pgdiff.REMOVED.git-id

@@ -0,0 +1 @@
+7ed89cdc6de9635e5c3d39e341153dbc949d56a3