Metadata-Version: 2.1
Name: tap-ibm-db2
Version: 0.1.0
Summary: `Tap-DB2` is a Singer tap for IBM DB2 data sources.
License: MIT
Keywords: ELT,IBM DB2,DB2
Author: Daniel Purtov
Requires-Python: >=3.8,<3.12
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: ibm-db-sa (>=0.4.0,<0.5.0)
Requires-Dist: singer-sdk (>=0.31.1,<0.32.0)
Requires-Dist: sqlalchemy (>=2.0.20,<3.0.0)
Description-Content-Type: text/markdown

<h1 align="center">Tap-DB2 👑</h1>

`Tap-DB2` is a Singer tap for IBM DB2 data sources. Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.

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

## Installation ⚙️

Install from PyPi:

```bash
pipx install tap-db2
```

Install from GitHub:

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

## Configuration 📝

| Setting               | Required | Default | Description                                                                                                                                 |
| :-------------------- | :------: | :-----: | :------------------------------------------------------------------------------------------------------------------------------------------ |
| host                  |   True   |  None   | The DB2 hostname.                                                                                                                           |
| port                  |   True   |  None   | The DB2 port.                                                                                                                               |
| database              |   True   |  None   | The DB2 database.                                                                                                                           |
| schema                |  False   |  None   | The DB2 schema.                                                                                                                             |
| user                  |   True   |  None   | The DB2 username.                                                                                                                           |
| password              |   True   |  None   | The DB2 password.                                                                                                                           |
| encryption            |  False   |  None   | Use to enable encrypted connection to DB2.                                                                                                  |
| connection_parameters |  False   |  None   | Additional parameters appended to the DB2 connection string.                                                                                |
| stream_maps           |  False   |  None   | Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html). |
| stream_map_config     |  False   |  None   | 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:

```bash
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](https://meltano.com/).

### Executing the Tap Directly 🔨

```bash
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

```bash
pipx install poetry
poetry install
```

### Create and Run Tests 🧪

Create tests within the `tests` subfolder and
  then run:

```bash
poetry run pytest
```

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

```bash
poetry run tap-db2 --help
```

### Testing with [Meltano](https://www.meltano.com)

_**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._

<!--
Developer TODO:
Your project comes with a custom `meltano.yml` project file already created. Open the `meltano.yml` and follow any "TODO" items listed in
the file.
-->

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

```bash
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-db2
meltano install
```

Now you can test and orchestrate using Meltano:

```bash
# 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](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to
develop your own taps and targets.

