Skip to content

Latest commit

 

History

History
124 lines (85 loc) · 4.07 KB

README.md

File metadata and controls

124 lines (85 loc) · 4.07 KB
Raw

target-iceberg

target-iceberg is a Singer target for Iceberg.

Build with the Meltano Target SDK.

Installation

Install from GitHub:

pipx install git+https://github.com/ORG_NAME/target-iceberg.git@main

Configuration

Accepted Config Options

Setting Required Default Description
credential True None Rest catalog user credential
catalog_uri True None Catalog URI, e.g. https://api.catalog.io/ws/
warehouse True None Warehouse name
catalog_type True None rest or jdbc
namespace True None The namespace where data will be written
add_record_metadata False None Add metadata to records.
validate_records False 1 Whether to validate the schema of the incoming streams.
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.
faker_config False None Config for the Faker instance variable fake used within map expressions. Only applicable if the plugin specifies faker as an addtional dependency (through the singer-sdk faker extra or directly).
faker_config.seed False None Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator
faker_config.locale False None One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization
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.
target is available by running: 
target-iceberg --about

Configure using environment variables

This Singer target 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 target-iceberg by itself or in a pipeline using Meltano.

Executing the Target Directly

target-iceberg --version
target-iceberg --help
# Test using the "Carbon Intensity" sample:
tap-carbon-intensity | target-iceberg --config /path/to/target-iceberg-config.json

Developer Resources

Follow these instructions to contribute to this project.

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

Start by setting up the local catalog environment:

docker compose up

Create tests within the tests subfolder and then run:

poetry run pytest

You can also test the target-iceberg CLI interface directly using poetry run:

poetry run target-iceberg --help

Testing with Meltano

Note: This target 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 target-iceberg
meltano install

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke target-iceberg --version
# OR run a test `elt` pipeline with the Carbon Intensity sample tap:
meltano run tap-carbon-intensity target-iceberg

SDK Dev Guide

See the dev guide for more instructions on how to use the Meltano Singer SDK to develop your own Singer taps and targets.