Release 0.9.1 first commit

Former-commit-id: 1ff96bf

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,8 +1,8 @@
 # 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 databases and generates alter statements to be *manually* run against the second database.  The provided pgdiff.sh script helps automate the process.  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. 
 
-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. 
+An important feature is that pgdiff never modifies a database directly. You alone are responsible for verifying the generated SQL *before* running it against your database, so you can have confidence this is safe to try and see what SQL gets generated.
 
 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)
 
@@ -17,20 +17,25 @@ It is written to be easy to add and improve the accuracy of the diff.  If you fi
 
 ### usage
 
-	pgdiff [database flags] <schemaType>
+	pgdiff [options] <schemaType>
 
 
- 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
+### options
 
-&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
+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
+
+
+&lt;schemaType&gt; can be: ROLE, SEQUENCE, TABLE, COLUMN, INDEX, FOREIGN_KEY, OWNER, GRANT_RELATIONSHIP, GRANT_ATTRIBUTE

flags.go

@@ -1,29 +1,31 @@
 //
 // Copyright (c) 2014 Jon Carlson.  All rights reserved.
-// Use of this source code is governed by an MIT-style
+// Use of this source code is governed by the MIT
 // license that can be found in the LICENSE file.
 //
 
 package main
 
-import "flag"
-import "github.com/joncrlsn/pgutil"
+import (
+	"github.com/joncrlsn/pgutil"
+	flag "github.com/ogier/pflag"
+)
 
 func parseFlags() (pgutil.DbInfo, pgutil.DbInfo) {
 
-	var dbUser1 = flag.String("U1", "", "db user")
-	var dbPass1 = flag.String("pw1", "", "db password")
-	var dbHost1 = flag.String("h1", "localhost", "db host")
-	var dbPort1 = flag.Int("p1", 5432, "db port")
-	var dbName1 = flag.String("d1", "", "db name")
-	var dbOptions1 = flag.String("o1", "", "db options (eg. sslmode=disable)")
-
-	var dbUser2 = flag.String("U2", "", "db user")
-	var dbPass2 = flag.String("pw2", "", "db password")
-	var dbHost2 = flag.String("h2", "localhost", "db host")
-	var dbPort2 = flag.Int("p2", 5432, "db port")
-	var dbName2 = flag.String("d2", "", "db name")
-	var dbOptions2 = flag.String("o2", "", "db options (eg. sslmode=disable)")
+	var dbUser1 = flag.StringP("user1", "U", "", "db user")
+	var dbPass1 = flag.StringP("password1", "W", "", "db password")
+	var dbHost1 = flag.StringP("host1", "H", "localhost", "db host")
+	var dbPort1 = flag.IntP("port1", "P", 5432, "db port")
+	var dbName1 = flag.StringP("dbname1", "D", "", "db name")
+	var dbOptions1 = flag.StringP("options1", "O", "", "db options (eg. sslmode=disable)")
+
+	var dbUser2 = flag.StringP("user2", "u", "", "db user")
+	var dbPass2 = flag.StringP("password2", "w", "", "db password")
+	var dbHost2 = flag.StringP("host2", "h", "localhost", "db host")
+	var dbPort2 = flag.IntP("port2", "p", 5432, "db port")
+	var dbName2 = flag.StringP("dbname2", "d", "", "db name")
+	var dbOptions2 = flag.StringP("options2", "o", "", "db options (eg. sslmode=disable)")
 
 	flag.Parse()
 

index.go

@@ -11,6 +11,7 @@ import "fmt"
 import "strings"
 import "database/sql"
 import "github.com/joncrlsn/pgutil"
+import "github.com/joncrlsn/misc"
 
 // ==================================
 // IndexRows definition
@@ -86,14 +87,14 @@ func (c *IndexSchema) Compare(obj interface{}) int {
 		fmt.Printf("--Comparing (table_name or index_name is empty): %v\n--           %v\n", c.getRow(), c2.getRow())
 	}
 
-	val := _compareString(c.get("table_name"), c2.get("table_name"))
+	val := misc.CompareStrings(c.get("table_name"), c2.get("table_name"))
 	if val != 0 {
 		// Table name differed so return that value
 		return val
 	}
 
 	// Table name was the same so compare index name
-	val = _compareString(c.get("index_name"), c2.get("index_name"))
+	val = misc.CompareStrings(c.get("index_name"), c2.get("index_name"))
 	return val
 }
 

owner.go

@@ -86,7 +86,7 @@ func (c OwnerSchema) Add() {
 	if c.get("type") == "TABLE" || c.get("type") == "SEQUENCE" {
 		fmt.Printf("-- Notice, db2 has no %s. You probably need to run pgdiff with the %s option first.\n", c.get("relationship_name"), c.get("type"))
 	} else if c.get("type") == "VIEW" {
-		fmt.Printf("-- Notice, db2 has no view named %s. pgdiff does not yet compare view definitions.\n", c.get("relationship_name"))
+		fmt.Printf("-- Notice, db2 has no view named %s.  Cannot compare owners.  (pgdiff does not (yet?) generate view definitions)\n", c.get("relationship_name"))
 	}
 }
 
@@ -95,7 +95,7 @@ func (c OwnerSchema) Drop() {
 	if c.get("type") == "TABLE" || c.get("type") == "SEQUENCE" {
 		fmt.Printf("-- Notice, db2 has a %s that db1 does not: %s. \n", c.get("type"), c.get("relationship_name"))
 	} else if c.get("type") == "VIEW" {
-		fmt.Printf("-- Notice, db2 has a view that db1 does not: %s. pgdiff does not yet compare view definitions.\n", c.get("relationship_name"))
+		fmt.Printf("-- Notice, db2 has a view that db1 does not: %s.  Cannot compare owners.\n", c.get("relationship_name"))
 	}
 }
 

pgdiff.go

@@ -1,14 +1,14 @@
 //
-// Copyright (c) 2014 Jon Carlson.  All rights reserved.
-// Use of this source code is governed by an MIT-style
+// Copyright (c) 2016 Jon Carlson.  All rights reserved.
+// Use of this source code is governed by the MIT
 // license that can be found in the LICENSE file.
 //
 
 package main
 
 import "fmt"
 import "log"
-import "flag"
+import flag "github.com/ogier/pflag"
 import "os"
 import "strings"
 import _ "github.com/lib/pq"
@@ -24,10 +24,16 @@ type Schema interface {
 	NextRow() bool
 }
 
-var args []string
-var dbInfo1 pgutil.DbInfo
-var dbInfo2 pgutil.DbInfo
-var schemaType string
+const (
+	version = "0.9.1"
+)
+
+var (
+	args       []string
+	dbInfo1    pgutil.DbInfo
+	dbInfo2    pgutil.DbInfo
+	schemaType string
+)
 
 /*
  * Initialize anything needed later
@@ -40,18 +46,36 @@ func init() {
  */
 func main() {
 
+	var helpPtr = flag.BoolP("help", "?", false, "print help information")
+	var versionPtr = flag.BoolP("version", "V", false, "print version information")
+
 	dbInfo1, dbInfo2 = parseFlags()
-	fmt.Println("-- db1:", dbInfo1)
-	fmt.Println("-- db2:", dbInfo2)
-	fmt.Println("-- Run the following SQL againt db2:")
 
 	// Remaining args:
 	args = flag.Args()
+
+	if *helpPtr {
+		usage()
+	}
+
+	if *versionPtr {
+		fmt.Fprintf(os.Stderr, "%s - version %s\n", os.Args[0], version)
+		fmt.Fprintln(os.Stderr, "Copyright (c) 2016 Jon Carlson.  All rights reserved.")
+		fmt.Fprintln(os.Stderr, "Use of this source code is governed by the MIT license")
+		fmt.Fprintln(os.Stderr, "that can be found here: http://opensource.org/licenses/MIT")
+		os.Exit(1)
+	}
+
 	if len(args) == 0 {
 		fmt.Println("The required first argument is SchemaType: ROLE, SEQUENCE, TABLE, COLUMN, INDEX, FOREIGN_KEY, OWNER, GRANT_RELATIONSHIP, GRANT_ATTRIBUTE")
 		os.Exit(1)
 	}
 	schemaType = strings.ToUpper(args[0])
+	fmt.Println("-- schemaType:", schemaType)
+
+	fmt.Println("-- db1:", dbInfo1)
+	fmt.Println("-- db2:", dbInfo2)
+	fmt.Println("-- Run the following SQL againt db2:")
 
 	conn1, err := dbInfo1.Open()
 	check("opening database 1", err)
@@ -135,24 +159,26 @@ func doDiff(db1 Schema, db2 Schema) {
 }
 
 func usage() {
-	fmt.Fprintf(os.Stderr, "usage: %s [database flags] <schemaType> \n", os.Args[0])
+	fmt.Fprintf(os.Stderr, "%s - version %s\n", os.Args[0], version)
+	fmt.Fprintf(os.Stderr, "usage: %s [<options>] <schemaType> \n", os.Args[0])
 	fmt.Fprintln(os.Stderr, `
 Compares the schema between two PostgreSQL databases and generates alter statements 
-to be *manually* run against the second database.
-
-[database flags]: (optional)
-  -U1     : postgres user (matches psql flag)
-  -h1     : database host -- default is localhost (matches psql flag)
-  -p1     : port.  defaults to 5432 (matches psql flag)
-  -d1     : database name (matches psql flag)
-  -pw1    : password for the postgres user (otherwise you'll be prompted)
-  -U2     : postgres user (matches psql flag)
-  -h2     : database host -- default is localhost (matches psql flag)
-  -p2     : port.  defaults to 5432 (matches psql flag)
-  -d2     : database name (matches psql flag)
-  -pw2    : password for the postgres user (otherwise you'll be prompted)
-
-<schemaTpe> : type of schema to check: TABLE, COLUMN, FOREIGN_KEY (soon: CONSTRAINT, ROLE)
+that can be *manually* run against the second database.
+
+Options:
+  -?, --help    : print help information
+  -V, --version : print version information
+  -v, --verbose : print extra run information
+  -U, --user1   : first postgres user 
+  -u, --user2   : second postgres user 
+  -H, --host1   : first database host. default is localhost 
+  -h, --host2   : second database host. default is localhost 
+  -P, --port1   : first port. default is 5432 
+  -p, --port2   : second port. default is 5432 
+  -D, --dbname1 : first database name 
+  -d, --dbname2 : second database name 
+
+<schemaTpe> can be: ROLE, SEQUENCE, TABLE, COLUMN, INDEX, FOREIGN_KEY, OWNER, GRANT_RELATIONSHIP, GRANT_ATTRIBUTE
 `)
 
 	os.Exit(2)
@@ -163,13 +189,3 @@ func check(msg string, err error) {
 		log.Fatal("Error "+msg, err)
 	}
 }
-
-func _compareString(s1 string, s2 string) int {
-	if s1 == s2 {
-		return 0
-	} else if s1 < s2 {
-		return -1
-	} else {
-		return +1
-	}
-}

pgdiff.sh

@@ -1,37 +1,51 @@
 #!/bin/bash
 #
-# pgdiff.sh runs a compare on each database type in the proper order.  At each step you are allowed to review 
+# pgdiff.sh runs a compare on each schema type in the proper order.  At each step you are allowed to review 
 # and optionally change and/or run the generated SQL.
 #
 # If you convert this to a windows batch file, please share it.
 #
-# pgdiff -U1 postgres -pw1 supersecret -d1 maindb -o1 sslmode=disable -U2 postgres -pw2 supersecret -d2 stagingdb -o2 sslmode=disable COLUMN
+# pgdiff -U postgres -W supersecret -D maindb -O sslmode=disable -u postgres -w supersecret -d stagingdb -o sslmode=disable COLUMN
 #
 
-USER1=c42
-HOST1=dbwan
-NAME1=crashplan
-OPT1=
+[[ -z $USER1 ]] && USER1=c42
+[[ -z $HOST1 ]] && HOST1=localhost
+[[ -z $NAME1 ]] && NAME1=cp
+[[ -z $OPT1 ]]  && OPT1='sslmode=disable'
 
-USER2=c42
-HOST2=fkd-msp
-NAME2=cp_staging
-OPT2=
+[[ -z $USER2 ]] && USER2=c42
+[[ -z $HOST2 ]] && HOST2=localhost
+[[ -z $NAME2 ]] && NAME2=cp-pentest
+[[ -z $OPT2 ]]  && OPT2='sslmode=disable'
 
-echo -n "Enter password: "; read passw
+echo "This is the reference database:"
+echo "   ${USER1}@${HOST1}/$NAME1"
+read -sp "Enter DB password: " passw
 PASS1=$passw
 PASS2=$passw
 
+echo
+echo "This database may be changed (if you choose):"
+echo "   ${USER2}@${HOST2}/$NAME2"
+read -sp "Enter DB password (defaults to previous password): " passw
+[[ -n $passw ]] && PASS2=$passw
+echo
+
+let i=0
 function rundiff() {
+    ((i++))
     local TYPE=$1
-    echo "Generating diff for $TYPE..."
-    pgdiff -U1 $USER1 -pw1 $PASS1 -h1 $HOST1 -d1 $NAME1 -o1 "$OPT1" -U2 $USER2 -pw2 $PASS2 -h2 $HOST2 -d2 $NAME2 -o2 "$OPT2" $TYPE > "${TYPE}.sql"
+    local sqlFile="${i}-${TYPE}.sql"
+    echo "Generating diff for $TYPE... $PASS1"
+    ./pgdiff -U "$USER1" -W "$PASS1" -H "$HOST1" -D "$NAME1" -O "$OPT1" \
+           -u "$USER2" -w "$PASS2" -h "$HOST2" -d "$NAME2" -o "$OPT2" \
+           $TYPE > "$sqlFile"
     RC=$? && [[ $RC != 0 ]] && exit $RC
     echo -n "Press Enter to review the generated output: "; read x
-    vi "${TYPE}.sql"
+    vi "$sqlFile"
     echo -n "Do you wish to run this against ${NAME2}? [yN]: "; read x
-    if [[ $x =~ y ]]; then
-       pgrun -U $USER2 -pw $PASS2 -h $HOST2 -d $NAME2 -o "$OPT2" -f "${TYPE}.sql"
+    if [[ $x =~ ^y ]]; then
+       PGPASSWORD="$PASS2" pgrun -U $USER2 -h $HOST2 -d $NAME2 -O "$OPT2" -f "$sqlFile"
     fi
     echo
 }