tap-neon 0.0.3

`tap-neon` is a Singer tap for Neon Serverless Postgres, built with the Meltano SDK for Singer Taps.

tap-neon

Singer tap for Neon Serverless Postgres.

Built with the Meltano Singer SDK.

Capabilities

• catalog
• state
• discover
• about
• stream-maps
• schema-flattening

Settings

Setting	Required	Default	Description
api_key	True	None	API Key for Neon Serverless Postgres
start_date	False	None	Earliest datetime to get data from
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-neon --about

Source Authentication and Authorization

Read the docs to learn how to generate an API key.

Usage

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

Executing the Tap Directly

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

Developer Resources

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

Create tests within the tests subfolder and then run:

poetry run pytest

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

poetry run tap-neon --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.

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

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

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-neon --version
# OR run a pipeline:
meltano run tap-neon 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.