`Tap-DB2` is a Singer tap for IBM DB2 data sources.
Project description
Tap-DB2 👑
Tap-DB2
is a Singer tap for IBM DB2 data sources. Built with the Meltano Tap SDK for Singer Taps.
Installation ⚙️
Install from PyPi:
pipx install tap-ibm-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 | True | Encryption settings for the DB2 connection. Setting this to an empty object will append 'SECURITY=SSL' to the connection string. For more information check out python-ibmdb. |
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 | Partition query into smaller subsets. Useful when working with DB2 that has set strict resource limits per query. Only works for streams with a numeric primary key. |
ignore_supplied_tables | False | Ignore DB2-supplied user tables. Defaults to 'True'. For more info check out Db2-supplied user tables. |
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for tap_ibm_db2-0.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | facaadb3738c5dce8df5b5170778c9140440152ac94dbbccf7f5f52fe4811838 |
|
MD5 | 1ec6c671ad97801b8f6f2c00829d7c0d |
|
BLAKE2b-256 | d49092512d35f34f8ea3b3818156e96443706df76ef7ee4382bf3dc6db8e74aa |