The tap-postgres extractor pulls data from Postgres that can then be sent to a destination using a loader.
Available Variants
- airbyte
- meltanolabs
- singer-io
- transferwise (default)
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-postgres extractor to your
project using
:meltano add -
Configure the tap-postgres
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-postgres --variant meltanolabsmeltano config tap-postgres set --interactivemeltano config tap-postgres testNext steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-postgres
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this extractor. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this extractor.
This plugin has the following capabilities:
- about
- catalog
- discover
- schema-flattening
- state
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-postgres settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-postgres list
You can
override these settings or specify additional ones
in your meltano.yml by adding the settings key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_POSTGRES_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-postgres set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_POSTGRES_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-postgres set flattening_max_depth [value]Sqlalchemy URL (sqlalchemy_url)
-
Environment variable:
TAP_POSTGRES_SQLALCHEMY_URL
Example postgresql://[username]:[password]@localhost:5432/[db_name]
Configure this setting directly using the following Meltano command:
meltano config tap-postgres set sqlalchemy_url [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_POSTGRES_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config tap-postgres set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_POSTGRES_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config tap-postgres set stream_maps [value]Incremental Replication
- name: tap-postgres
variant: meltanolabs
pip_url: git+https://github.com/MeltanoLabs/tap-postgres.git
config:
sqlalchemy_url: postgresql://meltano_user:password@localhost:5432/my_postgres_db
select:
- <my_schema>-<my_table>.*
metadata:
<my_schema>-<my_table>:
replication-method: INCREMENTAL
replication_key: key
key_properties:
- key
See the replication docs for more details.
Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general-orange){kind=icon}
-107,295-c0c0c4){kind=icon}
-48-c0c0c4){kind=icon}
