tap-ibm-db2 0.3.3

`Tap-DB2` is a Singer tap for IBM DB2 data sources.

Tap-DB2 👑

Tap-DB2 is a Singer tap for IBM DB2 data sources. Built with the Meltano Tap SDK for Singer Taps.

❗️ Caution: This tap has only been tested against an IBM DB2 running on z/OS.

Installation ⚙️

Install from PyPi:

pipx install tap-db2

Install from GitHub:

pipx install git+https://github.com/danielptv/tap-db2.git@main

Configuration 📝

Setting	Required	Description
host	True	The DB2 hostname.
port	True	The DB2 port.
database	True	The DB2 database.
schema	False	The DB2 schema.
user	True	The DB2 username.
password	True	The DB2 password.
encryption.encryption_method	True	The encryption method. Valid values are encrypted_verify_certificate and none.
encryption.ssl_server_certificate	False	The path to the SSL server certificate.
connection_parameters	False	Additional parameters to be appended to the connection string. This is an objects containing key-value pairs.
sqlalchemy_execution_options	False	Additional execution options to be passed to SQLAlchemy. This is an objects containing key-value pairs.
query_partitioning	False	EXPERIMENTAL: Partition query into smaller subsets. Useful when working with DB2 that has set strict resource limits per query. Partitioning is supported for columns of type number and datetime. Note: The currently supported methods do not guarantee a constant partition size.
stream_maps	False	Config object for stream maps capability. For more information check out Stream Maps.
stream_map_config	False	User-defined config values to be used within map expressions.

A full list of supported settings and capabilities for this tap is available by running:

tap-db2 --about --format json

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.

Usage 👷‍♀️

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

Executing the Tap Directly 🔨

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

Developer Resources 👩🏼‍💻

Follow these instructions to contribute to this project.

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-db2 CLI interface directly using poetry run:

poetry run tap-db2 --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-db2
meltano install

Now you can test and orchestrate using Meltano:

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