Skip to content
Listen for events from PostgreSQL and send them to AWS Kinesis
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
.gitignore
LICENSE.md
README.md
package.json
pg-kinesis-bridge.js
yarn.lock

README.md

pg-kinesis-bridge

A daemon that will listen to a PostgreSQL notification channel and send the data to an AWS Kinesis Stream.

Installation

Install with npm or yarn:

npm install -g pg-kinesis-bridge

Usage

usage: pg-kinesis-bridge [-h] -c CHANNEL -s STREAMNAME

Listen for events from PostgreSQL and send them to AWS Kinesis

Optional arguments:
  -h, --help            Show this help message and exit.
  -c CHANNEL, --channel CHANNEL
                        PostgreSQL channel name
  -s STREAMNAME, --streamName STREAMNAME
                        Kinesis stream name

The libraries used by pg-kinesis-bridge respect the normal environment variables used by postgres clients and aws clients. This can be used as a simple way to pass configuration. e.g.

PGHOST=localhost PGPORT=1234 PGDATABASE=postgres AWS_PROFILE=work AWS_SDK_LOAD_CONFIG=y pg-kinesis-bridge -c CHANNEL -s STREAMNAME

Similar Projects

Implementation Notes

The PostgreSQL notification channel name is used as the Kinesis PartitionKey.

You can’t perform that action at this time.