pgquarrel is a program that compares PostgreSQL database schemas (DDL).

Given two connections, it outputs a file that represent the diference
between schemas. It means that if you run the output file into the
"first connection", it will have the same schema as the "second
connection". The main use case is to deploy changes into testing,
staging, and production environments.

pgquarrel doesn't rely on any tools (like pg_dump) instead it connects
directly to PostgreSQL server, obtain metadata from catalog, compare
objects and output SQL commands necessary to turn "first database" into
"second database".

It could work on different PostgreSQL versions. However, if the "second
database" version is greater than "first database" version, some SQL
commands could not work on a prior version when you try to run the
output file.

It was tested on Linux and FreeBSD. I didn't try Windows yet.

README file has a list of supported features. Not all of the objects
are covered but I will try to do my best to supported the most common
SQL commands.

CMakeLists.txt

@@ -0,0 +1,101 @@
+cmake_minimum_required(VERSION 2.8.11)
+
+project(pgquarrel C)
+add_executable(pgquarrel
+ src/common.c
+ src/common.h
+ src/domain.c
+ src/domain.h
+ src/eventtrigger.c
+ src/eventtrigger.h
+ src/extension.c
+ src/extension.h
+ src/function.c
+ src/function.h
+ src/index.c
+ src/index.h
+ src/language.c
+ src/language.h
+ src/matview.c
+ src/matview.h
+ src/quarrel.c
+ src/quarrel.h
+ src/rule.c
+ src/rule.h
+ src/schema.c
+ src/schema.h
+ src/sequence.c
+ src/sequence.h
+ src/table.c
+ src/table.h
+ src/trigger.c
+ src/trigger.h
+ src/type.c
+ src/type.h
+ src/view.c
+ src/view.h
+)
+
+add_subdirectory(mini)
+
+set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -O0 -Wall -Wmissing-prototypes -Wpointer-arith -Wdeclaration-after-statement -Wendif-labels -fno-strict-aliasing -fwrapv -g")
+
+# cmake -DCMAKE_PREFIX_PATH=/home/euler/pg945 .
+find_package(PostgreSQL REQUIRED)
+if(PostgreSQL_FOUND)
+ include_directories(${PostgreSQL_INCLUDE_DIR})
+ include_directories(${PostgreSQL_INCLUDE_DIR}/postgresql/server)
+else()
+ message(FATAL_ERROR "could not find PostgreSQL")
+endif(PostgreSQL_FOUND)
+
+set(LIBS ${LIBS} ${PostgreSQL_LIBRARY})
+
+include_directories(mini)
+
+set(LIBS ${LIBS} mini)
+
+target_link_libraries(pgquarrel ${LIBS})
+
+install(TARGETS pgquarrel DESTINATION "/tmp/test/bin")
+
+find_program(astyle_EXECUTABLE astyle DOC "source code indenter, formatter, and beautifier")
+
+add_custom_target("style" COMMAND
+ "${astyle_EXECUTABLE}"
+ --style=bsd
+ --indent=force-tab=4
+ --indent-switches
+ --pad-oper
+ --align-pointer=name
+ --remove-brackets
+ --max-code-length=80
+ -break-after-logical
+# --suffix=none
+ --lineend=linux
+ ${CMAKE_CURRENT_SOURCE_DIR}/src/*.c
+ ${CMAKE_CURRENT_SOURCE_DIR}/src/*.h
+ VERBATIM
+)
+
+# coverage
+#include(CodeCoverage)
+#set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -g -O0 -fprofile-arcs -ftest-coverage")
+#setup_target_for_coverage(coverage_target mytests coverage_dir)
+
+# cmake -DCMAKE_BUILD_TYPE=Debug ..
+# make
+# make coverage_target
+
+#
+# MANUAL COVERAGE
+#
+# uncomment the line below:
+#set (CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fprofile-arcs -ftest-coverage")
+#
+# $ cd pgquarrel/
+# $ rm -rf CMakeFiles/
+# $ cmake -DCMAKE_PREFIX_PATH=/home/euler/pg945 . ; make clean; make
+# $ cd test
+# $ ./run-test.sh init
+# point your browser to pgquarrel/coverage/index.html

README.md

@@ -1 +1,260 @@
-# pgquarrel
+Introduction
+============
+
+**pgquarrel** is a program that compares [PostgreSQL](http:https://www.postgresql.org/) database schemas (DDL).
+
+Given two database connections, it output a file that represent the difference between schemas. It means that if you run the output file into the *from* database, it'll have the same schema as the *to* database. The main use case is to deploy database changes into testing, staging or production environment.
+
+**pgquarrel** does not rely on another tool (such as **pg\_dump**) instead it connects directly to PostgreSQL server, obtain meta data from catalog, compare objects and output the commands necessary to turn *from* database into *to* database.
+
+It could work with different PostgreSQL versions. The generated file could not work as expected if the *to* PostgreSQL version is greater than *from* PostgreSQL version. That's because the tool could generate commands that does not exist in a prior PostgreSQL version.
+
+
+It works with different operating systems. It was tested on Linux. I didn't try Windows yet.
+
+Installation
+============
+
+**pgquarrel** is distributed as a source package and can be downloaded at [GitHub](http:https://github.com/euler/pgquarrel). The installation steps depend on your operating system.
+
+You can also keep up with the latest fixes and features cloning the Git repository.
+
+```
+$ git clone https://github.com/eulerto/pgquarrel.git
+```
+
+UNIX based Operating Systems
+----------------------------
+
+Before installing **pgquarrel**, you should have PostgreSQL 9.0+ installed (including the header files). If PostgreSQL is not in your search path add -DCMAKE_PREFIX_PATH=/path/to/pgsql to the cmake command.
+
+```
+$ tar -zxf pgquarrel-0.1.0.tgz
+$ cd pgquarrel-0.1.0
+$ cmake .
+$ make
+```
+
+Windows
+-------
+
+Sorry, never tried.
+
+Features
+========
+
+**pgquarrel** does not support all of the PostgreSQL objects. Also, **pgquarrel** does not manipulate data (i.e. DML).
+
+<table>
+ <tr>
+  <th>Object</th>
+  <th>Support</th>
+  <th>Comments</th>
+ </tr>
+ <tr>
+  <td>COMMENT</td>
+  <td>partial</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>DOMAIN</td>
+  <td>partial</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>EVENT TRIGGER</td>
+  <td>complete</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>EXTENSION</td>
+  <td>partial</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>FUNCTION</td>
+  <td>partial</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>INDEX</td>
+  <td>partial</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>LANGUAGE</td>
+  <td>partial</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>MATERIALIZED VIEW</td>
+  <td>partial</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>RULE</td>
+  <td>complete</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>SCHEMA</td>
+  <td>partial</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>SEQUENCE</td>
+  <td>partial</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>TABLE</td>
+  <td>partial</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>TRIGGER</td>
+  <td>complete</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>TYPE</td>
+  <td>partial</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>VIEW</td>
+  <td>partial</td>
+  <td></td>
+ </tr>
+
+ <tr>
+  <td>GRANT</td>
+  <td>not implemented</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>REVOKE</td>
+  <td>not implemented</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>FOREIGN DATA WRAPPER</td>
+  <td>not implemented</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>FOREIGN TABLE</td>
+  <td>not implemented</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>SERVER</td>
+  <td>not implemented</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>USER MAPPING</td>
+  <td>not implemented</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>SECURITY LABEL</td>
+  <td>not implemented</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>TEXT SEARCH CONFIGURATION</td>
+  <td>not implemented</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>TEXT SEARCH DICTIONARY</td>
+  <td>not implemented</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>TEXT SEARCH PARSER</td>
+  <td>not implemented</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>TEXT SEARCH TEMPLATE</td>
+  <td>not implemented</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>AGGREGATE</td>
+  <td>not implemented</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>CAST</td>
+  <td>not implemented</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>COLLATION</td>
+  <td>not implemented</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>CONVERSION</td>
+  <td>not implemented</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>OPERATOR</td>
+  <td>not implemented</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>OPERATOR CLASS</td>
+  <td>not implemented</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>OPERATOR FAMILY</td>
+  <td>not implemented</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>ALTER DEFAULT PRIVILEGES</td>
+  <td>uncertain</td>
+  <td></td>
+ </tr>
+ <tr>
+  <td>ALTER LARGE OBJECT</td>
+  <td>uncertain</td>
+  <td></td>
+ </tr>
+</table>
+
+Although **pgquarrel** does not support all PostgreSQL objects, it covers many of the use cases. In future releases, we expect to implement the TODO items to cover more cases. The main absences are:
+
+* inheritance;
+* permissions (GRANT/REVOKE);
+* roles.
+
+Tests
+=====
+
+```
+$ # adjust test/run-test.sh
+$ cd pgquarrel-0.1.0/test
+$ ./run-test.sh init
+```
+
+License
+=======
+
+> Copyright © 2015 Euler Taveira de Oliveira
+> All rights reserved.
+
+> Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+> Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer;
+> Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution;
+> Neither the name of the Euler Taveira de Oliveira nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+> THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

mini/CMakeLists.txt

@@ -0,0 +1,12 @@
+add_library(mini SHARED
+ mini-file.c
+ mini-file.h
+ mini-parser.c
+ mini-parser.h
+ mini-readline.c
+ mini-readline.h
+ mini-strip.c
+ mini-strip.h
+)
+
+install(TARGETS mini DESTINATION "/tmp/test/lib")