Skip to content

Commit d1864a0

Browse files
committed
Updated the README
Former-commit-id: eca13f0
1 parent 38733e2 commit d1864a0

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ pgdiff is written to be easy to expand and improve the accuracy of the diff.
1616

1717
(where options and <schemaType> are listed below)
1818

19-
I have found that there is an ideal order for running the different schema types. This order should minimize the problems you encounter. For example, you will always want to add new tables before you add new columns. This is the order that has worked for me.
19+
There seems to be an ideal order for running the different schema types. This order should minimize the problems you encounter. For example, you will always want to add new tables before you add new columns.
2020

2121
In addition, some types can have dependencies which are not in the right order. A classic case is views which depend on other views. The missing view SQL is generated in alphabetical order so if a view create fails due to a missing view, just run the views SQL file over again. The pgdiff.sh script will prompt you about running it again.
2222

@@ -63,8 +63,8 @@ options | explanation
6363
-p, --port2 | second db port number. default is 5432
6464
-D, --dbname1 | first db name
6565
-d, --dbname2 | second db name
66-
-S, --schema1 | first schema name. default is public
67-
-s, --schema2 | second schema name. default is public
66+
-S, --schema1 | first schema name. default is * (all non-system schemas)
67+
-s, --schema2 | second schema name. default is * (all non-system schemas)
6868
-O, --option1 | first db options. example: sslmode=disable
6969
-o, --option2 | second db options. example: sslmode=disable
7070

@@ -84,17 +84,21 @@ linux and osx binaries are packaged with an extra, optional bash script and pgru
8484
### getting started on windows
8585

8686
1. download pgdiff.exe from the bin-win directory on github
87-
1. edit the db connection defaults in pgdiff.sh or...
88-
1. manually run pgdiff for each schema type listed in the usage section above
89-
1. review the SQL output and, if you want to make them match, run it against db2
87+
1. either install cygwin so you can run pgdiff.sh or...
88+
1. manually run pgdiff.exe for each schema type listed in the usage section above
89+
1. review the SQL output and, if you want to make them match, run it against the second db
90+
91+
Unfortunately this project does not have as much support for Windows as it does for Linux and Mac. If you are inclined to write a Windows complement to the pgdiff.sh script, feel free to contribute it or we can link to it. Even better would be a replacement written in Go.
9092

9193

9294
### version history
9395
1. 0.9.0 - Implemented ROLE, SEQUENCE, TABLE, COLUMN, INDEX, FOREIGN\_KEY, OWNER, GRANT\_RELATIONSHIP, GRANT\_ATTRIBUTE
9496
1. 0.9.1 - Added VIEW, FUNCTION, and TRIGGER (Thank you, Shawn Carroll AKA SparkeyG)
9597
1. 0.9.2 - Fixed bug when using the non-default port
96-
1. 0.9.3 - Added support for comparing two different schemas, one schema between databases, or all schemas. Fixed VARCHAR bug when no max length specified
98+
1. 0.9.3 - Added support for comparing two different schemas (same or different db), one schema between databases, or all schemas between databases. Fixed VARCHAR bug when no max length specified.
9799

100+
### getting help
101+
If you think you found a bug, find the appropriate test script (in the test directory) and modify it to show the problem. Attach the script to an Issue request.
98102

99103
### todo
100104
1. fix SQL for adding an array column

0 commit comments

Comments
 (0)