IBM DB2

tap-db2 (danielptv variant)🥈

IBM DB2 Relational Database

The tap-db2 extractor pulls data from IBM DB2 that can then be sent to a destination using a loader.

Alternate Implementations

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-db2 extractor to your project using 
    meltano add
     : 
    2. meltano add extractor tap-db2 --variant danielptv
  2. Configure the tap-db2 settings using 
    meltano config
     : 
    3. meltano config tap-db2 set --interactive
  3. Test that extractor settings are valid using 
    meltano config
     : 
    4. meltano config tap-db2 test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-db2 may have been automatically set when originally added to the Hub. Please review the capabilities when using this extractor. If you find they are out of date, please consider updating them by making a pull request to the YAML file that defines the capabilities for this extractor.

This plugin has the following capabilities:

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

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-db2 settings that are known to Meltano are documented below. To quickly find the setting you're looking for, click on any setting name from the list:

You can also list these settings using 

meltano config
with the list subcommand: 

meltano config tap-db2 list

You can override these settings or specify additional ones in your meltano.yml by adding the settings key.

Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.

Connection Parameters (connection_parameters)

  • Environment variable: TAP_DB2_CONNECTION_PARAMETERS

Additional parameters to be appended to the connection string. This is an objects containing key-value pairs.


Configure this setting directly using the following Meltano command:

meltano config tap-db2 set connection_parameters [value]

Database (database)

  • Environment variable: TAP_DB2_DATABASE

The DB2 database.


Configure this setting directly using the following Meltano command:

meltano config tap-db2 set database [value]

Encryption SSL Client Key Store Database Database (encryption.ssl_client_key_store_db.database)

  • Environment variable: TAP_DB2_ENCRYPTION_SSL_CLIENT_KEY_STORE_DB_DATABASE

The full path to the client keystore database.


Configure this setting directly using the following Meltano command:

meltano config tap-db2 set encryption ssl_client_key_store_db.database [value]

Encryption SSL Client Key Store Database Key Stash (encryption.ssl_client_key_store_db.key_stash)

  • Environment variable: TAP_DB2_ENCRYPTION_SSL_CLIENT_KEY_STORE_DB_KEY_STASH

The full path to the client key stash.


Configure this setting directly using the following Meltano command:

meltano config tap-db2 set encryption ssl_client_key_store_db.key_stash [value]

Encryption SSL Client Key Store Database Password (encryption.ssl_client_key_store_db.password)

  • Environment variable: TAP_DB2_ENCRYPTION_SSL_CLIENT_KEY_STORE_DB_PASSWORD

The keystore password.


Configure this setting directly using the following Meltano command:

meltano config tap-db2 set encryption ssl_client_key_store_db.password [value]

Encryption SSL Server Certificate (encryption.ssl_server_certificate)

  • Environment variable: TAP_DB2_ENCRYPTION_SSL_SERVER_CERTIFICATE

The path to the SSL server certificate.


Configure this setting directly using the following Meltano command:

meltano config tap-db2 set encryption ssl_server_certificate [value]

Filter (filter)

  • Environment variable: TAP_DB2_FILTER

Apply a custom WHERE condition per stream. Unlike the filter available in stream_maps, this will be evaluated BEFORE extracting the data.


Configure this setting directly using the following Meltano command:

meltano config tap-db2 set filter [value]

Host (host)

  • Environment variable: TAP_DB2_HOST
  • Default Value: localhost

The DB2 hostname.


Configure this setting directly using the following Meltano command:

meltano config tap-db2 set host [value]

Ignore Supplied Tables (ignore_supplied_tables)

  • Environment variable: TAP_DB2_IGNORE_SUPPLIED_TABLES
  • Default Value: true

Ignore DB2-supplied user tables. For more info check out Db2-supplied user tables.


Configure this setting directly using the following Meltano command:

meltano config tap-db2 set ignore_supplied_tables [value]

Ignore Views (ignore_views)

  • Environment variable: TAP_DB2_IGNORE_VIEWS
  • Default Value: false

Ignore views.


Configure this setting directly using the following Meltano command:

meltano config tap-db2 set ignore_views [value]

Password (password)

  • Environment variable: TAP_DB2_PASSWORD

The DB2 password.


Configure this setting directly using the following Meltano command:

meltano config tap-db2 set password [value]

Port (port)

  • Environment variable: TAP_DB2_PORT
  • Default Value: 50000

The DB2 port.


Configure this setting directly using the following Meltano command:

meltano config tap-db2 set port [value]

Query Partition (query_partition)

  • Environment variable: TAP_DB2_QUERY_PARTITION

Partition query into smaller subsets. Useful when working with DB2 that has set strict resource limits per query. Only works for streams with numeric primary keys.


Configure this setting directly using the following Meltano command:

meltano config tap-db2 set query_partition [value]

Schema (schema)

  • Environment variable: TAP_DB2_SCHEMA

The DB2 schema.


Configure this setting directly using the following Meltano command:

meltano config tap-db2 set schema [value]

SQLAlchemy Execution Options (sqlalchemy_execution_options)

  • Environment variable: TAP_DB2_SQLALCHEMY_EXECUTION_OPTIONS

Additional execution options to be passed to SQLAlchemy. This is an objects containing key-value pairs.


Configure this setting directly using the following Meltano command:

meltano config tap-db2 set sqlalchemy_execution_options [value]

User (user)

  • Environment variable: TAP_DB2_USER

The DB2 username.


Configure this setting directly using the following Meltano command:

meltano config tap-db2 set user [value]
Expand To Show SDK Settings

Faker Locale (faker_config.locale)

  • Environment variable: TAP_DB2_FAKER_CONFIG_LOCALE

One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization


Configure this setting directly using the following Meltano command:

meltano config tap-db2 set faker_config locale [value]

Faker Seed (faker_config.seed)

  • Environment variable: TAP_DB2_FAKER_CONFIG_SEED

Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator


Configure this setting directly using the following Meltano command:

meltano config tap-db2 set faker_config seed [value]

Enable Schema Flattening (flattening_enabled)

  • Environment variable: TAP_DB2_FLATTENING_ENABLED

'True' to enable schema flattening and automatically expand nested properties.


Configure this setting directly using the following Meltano command:

meltano config tap-db2 set flattening_enabled [value]

Max Flattening Depth (flattening_max_depth)

  • Environment variable: TAP_DB2_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-db2 set flattening_max_depth [value]

Stream Map Config (stream_map_config)

  • Environment variable: TAP_DB2_STREAM_MAP_CONFIG

User-defined config values to be used within map expressions.


Configure this setting directly using the following Meltano command:

meltano config tap-db2 set stream_map_config [value]

Stream Maps (stream_maps)

  • Environment variable: TAP_DB2_STREAM_MAPS

Config object for stream maps capability. For more information check out Stream Maps.


Configure this setting directly using the following Meltano command:

meltano config tap-db2 set stream_maps [value]

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-db2 extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the 
#plugins-general
channel.

Install

meltano add extractor tap-db2 --variant danielptv

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK

Repo

https://github.com/danielptv/tap-db2
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • danielptv

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

Keywords

  • meltano_sdkELTIBM DB2DB2