Skip to main content

Postgres to elasticsearch sync

Project description

PostgreSQL to Elasticsearch sync

PGSync <>__ is a middleware for syncing data from Postgres <>__ to Elasticsearch <>.
It allows you to keep Postgres <>
as your source of truth data source and expose structured denormalized documents in Elasticsearch <>__.


  • Python <>__ 3.6+
  • Postgres <>__ 9.4+
  • Redis <>__
  • Elasticsearch <>__ 6.3.1+

Postgres setup

Enable logical decoding <>__ in your Postgres setting.

  • you would also need to set up two parameters in your Postgres config postgresql.conf

    wal_level = logical

    max_replication_slots = 1


You can install PGSync from PyPI <>__:

$ pip install pgsync


Create a schema for the application named e.g schema.json

Example schema <>__

Example spec

.. code-block::

        "database": "[database name]",
        "index": "[elasticsearch index]",
        "nodes": [
                "table": "[table A]",
                "schema": "[table A schema]",
                "columns": [
                    "column 1 from table A",
                    "column 2 from table A",
                    ... additional columns
                "children": [
                        "table": "[table B with relationship to table A]",
                        "schema": "[table B schema]",
                        "columns": [
                          "column 1 from table B",
                          "column 2 from table B",
                          ... additional columns
                        "relationship": {
                            "variant": "object",
                            "type": "one_to_many"
                        ... any other additional children

Environment variables

Setup required environment variables for the application



PG_USER=i-am-root # this must be a postgres superuser



bootstrap the database (one time only) $ bootstrap --config schema.json run pgsync as a daemon $ pgsync --config schema.json --daemon

======= History

1.0.1 (2020-15-01)

  • First release on PyPI.

1.0.1 (2020-01-01)

  • RC1 release

1.1.0 (2020-04-13)

  • Postgres multi schema support for multi-tennant applications

  • Show resulting Query with verbose mode

  • this release required you to re-bootstrap your database with

    • bootstrap -t
    • bootstrap

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pgsync, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size pgsync-1.1.0-cp36-cp36m-manylinux1_x86_64.whl (3.3 MB) File type Wheel Python version cp36 Upload date Hashes View
Filename, size pgsync-1.1.0-cp37-cp37m-macosx_10_15_x86_64.whl (863.6 kB) File type Wheel Python version cp37 Upload date Hashes View
Filename, size pgsync-1.1.0-cp37-cp37m-manylinux1_x86_64.whl (3.1 MB) File type Wheel Python version cp37 Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page