The tap-postgres Singer tap pulls data from PostgreSQL that can then be sent to a destination using a Singer target.

Alternative variants #

Multiple variants of tap-postgres are available. This document describes the default transferwise variant, which is recommended for new users.

Alternative variants are:

Standalone usage #

Install the package using pip: 

pip install pipelinewise-tap-postgres

For additional instructions, refer to the README in the repository.

Usage with Meltano #

Meltano helps you manage your configuration, incremental replication, and scheduled pipelines.

View the Meltano-specific tap-postgres instructions to learn more.

Capabilities #

Settings #

tap-postgres requires the configuration of the following settings:

These and other supported settings are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

Host (host) #

  • Default: localhost

PostgreSQL host

Port (port) #

  • Default: 5432

PostgreSQL port

User (user) #

PostgreSQL user

Password (password) #

PostgreSQL password

Database Name (dbname) #

PostgreSQL database name

SSL (ssl) #

  • Default: false

Using SSL via postgres sslmode='require' option. If the server does not accept SSL connections or the client certificate is not recognized the connection will fail

Filter Schemas (filter_schemas) #

Scan only the specified comma-separated schemas to improve the performance of data extraction

Default Replication Method (default_replication_method) #

Max Run Seconds (max_run_seconds) #

  • Default: 43200

Stop running the tap after certain number of seconds

Logical Poll Total Seconds (logical_poll_total_seconds) #

  • Default: 10800

Stop running the tap when no data received from wal after certain number of seconds

Break At End LSN (break_at_end_lsn) #

  • Default: true

Stop running the tap if the newly received lsn is after the max lsn that was detected when the tap started

Troubleshooting #

Error: pg_config executable not found or libpq-fe.h: No such file or directory #

This error message indicates that the libpq dependency is missing.

To resolve this, refer to the “Dependencies” section above.

Looking for help? #

If you're having trouble getting the tap-postgres tap to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the #plugins-general channel.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!