`tap-postgres`

Singer tap for Postgres.

Capabilities

catalog
state
discover
about
stream-maps
schema-flattening

Settings

Setting	Required	Default	Description
sqlalchemy_url	True	None	Example postgresql://postgres:postgres@localhost:5432/postgres
ssh_tunnel	False	None	SSH Tunnel Configuration, this is a json object.
ssh_tunnel.enable	True (if ssh_tunnel set)	False	Enable an ssh tunnel (also known as bastion host), see the other ssh_tunnel.* properties for more details.
ssh_tunnel.host	True (if ssh_tunnel set)	False	Host of the bastion host, this is the host we'll connect to via ssh
ssh_tunnel.username	True (if ssh_tunnel set)	False	Username to connect to bastion host
ssh_tunnel.port	True (if ssh_tunnel set)	22	Port to connect to bastion host
ssh_tunnel.private_key	True (if ssh_tunnel set)	None	Private Key for authentication to the bastion host
ssh_tunnel.private_key_password	False	None	Private Key Password, leave None if no password is set
stream_maps	False	None	Config object for stream maps capability. For more information check out Stream Maps.
stream_map_config	False	None	User-defined config values to be used within map expressions.
flattening_enabled	False	None	'True' to enable schema flattening and automatically expand nested properties.
flattening_max_depth	False	None	The max depth to flatten schemas.

A full list of supported settings and capabilities is available by running: tap-postgres --about

Configure using environment variables

This Singer tap will automatically import any environment variables within the working directory's .env if the --config=ENV is provided, such that config values will be considered if a matching environment variable is set either in the terminal context or in the .env file.

SSH Tunnels (Bastion Hosts)

This tap supports connecting to a Postgres database via an SSH tunnel (also known as a bastion host). This is useful if you need to connect to a database that is not publicly accessible. This is the same as using ssh -L and ssh -R, but this is done inside the tap itself.

Installation

Developer TODO: Update the below as needed to correctly describe the install procedure. For instance, if you do not have a PyPi repo, or if you want users to directly install from your git repo, you can modify this step as appropriate.

pipx install tap-postgres

Usage

You can easily run tap-postgres by itself or in a pipeline using Meltano.

Executing the Tap Directly

tap-postgres --version
tap-postgres --help
tap-postgres --config CONFIG --discover > ./catalog.json

Developer Resources

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

Create tests within the tap_postgres/tests subfolder and then run:

poetry run pytest

You can also test the tap-postgres CLI interface directly using poetry run:

poetry run tap-postgres --help

Testing with Meltano

Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.

Your project comes with a custom meltano.yml project file already created.

Next, install Meltano (if you haven't already) and any needed plugins:

# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-postgres
meltano install

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-postgres --version
# OR run a test `elt` pipeline:
meltano elt tap-postgres target-jsonl

SDK Dev Guide

See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.

Download files

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

Source Distribution

meltanolabs_tap_postgres-0.0.0.tar.gz (7.8 kB view details)

Uploaded Apr 30, 2023 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

meltanolabs_tap_postgres-0.0.0-py3-none-any.whl (7.8 kB view details)

Uploaded Apr 30, 2023 Python 3

File details

Details for the file meltanolabs_tap_postgres-0.0.0.tar.gz.

File metadata

Download URL: meltanolabs_tap_postgres-0.0.0.tar.gz
Upload date: Apr 30, 2023
Size: 7.8 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: poetry/1.3.1 CPython/3.8.16 Linux/5.15.90.1-microsoft-standard-WSL2

File hashes

Hashes for meltanolabs_tap_postgres-0.0.0.tar.gz
Algorithm	Hash digest
SHA256	`a658caac5c791af8eca42f1aba40e18deb50babec9ef78ece48469523f1491fd`
MD5	`ccbd72c52d79743ae9eeb3188de6e194`
BLAKE2b-256	`3bf43d02ef8b77d940799ff52624b7eccf9867376aa4c79e3e1a0022bf0df2ea`

See more details on using hashes here.

File details

Details for the file meltanolabs_tap_postgres-0.0.0-py3-none-any.whl.

File metadata

Download URL: meltanolabs_tap_postgres-0.0.0-py3-none-any.whl
Upload date: Apr 30, 2023
Size: 7.8 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: poetry/1.3.1 CPython/3.8.16 Linux/5.15.90.1-microsoft-standard-WSL2

File hashes

Hashes for meltanolabs_tap_postgres-0.0.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`d271771c326dd2d160e90fa96864b00d2d0bf776d19101253f154eafbb3207f8`
MD5	`11412637eaf523924fc8c5b5c9f89fe8`
BLAKE2b-256	`f0c9ae9a71b4b4290afbfcc2625d188c2c263438f07322e8423ee6f0e688744f`