All Projects → sebastian-r-schmidt → logicaldecoding

sebastian-r-schmidt / logicaldecoding

Licence: MIT license
Parses PostgreSQL Logical Decoding output

Programming Languages

java
68154 projects - #9 most used programming language
ANTLR
299 projects

Travis CI build status

Parsing PostgreSQL Logical Decoding Output

Logical Deocding introduced with PostgreSQL 9.4 makes it possible to keep track of all commits into your database in commit order. This opens possibilities for auditing and other cool stuff.

No triggers needed.

No changes needed in your applications writing data.

This software is targeted for PostGIS users and can do two things:

  1. Writing an audit log back into the database. The audit log will be in a table containing all values before the change and after the change (both in a JSONB column), timestamp of the commit and a geometry column describing the Bounding box of the affected region.
  2. Publishing changes into a GeoWebCache instance triggering Seed, Reseed, or Truncate operations in the region the change has happened.

###Prerequisites

  • PostgreSQL 9.4 or higher
  • Java 8 JRE (tested with Oracle JRE and OpenJDK JRE)

####PostgreSQL Configuration

  1. In your postgresql.conf set wal_level to logical
  2. In your postgresql.conf set max_replication_slots to > 1
  3. Set the tables you want to audit to replica identity full
ALTER TABLE schema.tablename REPLICA IDENTITY FULL;
  1. create a replication slot:
SELECT * FROM pg_create_logical_replication_slot('repslot_test', 'test_decoding');

###Usage

git clone https://github.com/sebastian-r-schmidt/logicaldecoding
mvn clean package
cd target
java -jar logicaldecoding-<version>.jar

####Configuration Create a application.properties file in the same folder where you placed the jarfile containing all settings.

Those values will override the .properties file packaged inside the jar file.

See src/main/resources/application.properties for examples and default values.

###Cleanup Make sure you drop your replication slot when you do not need it anymore and no consumer is attached to it. Otherwise your PostgreSQL instance will keep all WAL files forver inside pg_xlog directory and bloat your harddisk:

SELECT * FROM pg_drop_replication_slot('repslot_test');

To check how far "behind master" your replication slot is, check

select pg_xlog_location_diff(pg_current_xlog_location(),(select restart_lsn from pg_replication_slots where slot_name='repslot_test'));

which will give you the number of bytes that still need to be checked. Values around 50 can be treated as zero.

Sample SQL Statements for management of replication slots can be found in the src/main/resources directory.

###Used Libraries

  • Spring Boot
  • ANTLR v4.5 for parsing
  • Google Guava
  • Jackson for JSON generation
  • JTS for PostGIS Geometry processing

####License

This software is distributed under the MIT License. See LICENSE file for details.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].