Iceberg

tap-iceberg (shaped-ai variant)

Meltano Tap for ingesting Apache Iceberg data

The tap-iceberg extractor pulls data from Iceberg that can then be sent to a destination using a loader.

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-iceberg extractor to your project using 
    meltano add
     : 
    2. meltano add extractor tap-iceberg
  2. Configure the tap-iceberg settings using 
    meltano config
     : 
    3. meltano config tap-iceberg set --interactive
  3. Test that extractor settings are valid using 
    meltano config
     : 
    4. meltano config tap-iceberg test

Next steps

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

Capabilities

The current capabilities for tap-iceberg 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
  • batch
  • catalog
  • discover
  • schema-flattening
  • state
  • stream-maps

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

Settings

The tap-iceberg 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-iceberg 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.

Catalog Name (catalog_name)

  • Environment variable: TAP_ICEBERG_CATALOG_NAME

The name of the Iceberg catalog


Configure this setting directly using the following Meltano command:

meltano config tap-iceberg set catalog_name [value]

Catalog Properties (catalog_properties)

  • Environment variable: TAP_ICEBERG_CATALOG_PROPERTIES

Additional properties for the Iceberg catalog


Configure this setting directly using the following Meltano command:

meltano config tap-iceberg set catalog_properties [value]

Catalog Type (catalog_type)

  • Environment variable: TAP_ICEBERG_CATALOG_TYPE

The type of Iceberg catalog (e.g., 'hive', 'rest', 'glue')


Configure this setting directly using the following Meltano command:

meltano config tap-iceberg set catalog_type [value]

Client Access Key ID (client_access_key_id)

  • Environment variable: TAP_ICEBERG_CLIENT_ACCESS_KEY_ID

The AWS access key ID for accessing S3/Glue catalogs


Configure this setting directly using the following Meltano command:

meltano config tap-iceberg set client_access_key_id [value]

Client Iam Role Arn (client_iam_role_arn)

  • Environment variable: TAP_ICEBERG_CLIENT_IAM_ROLE_ARN

The ARN of the IAM role to use for accessing S3/Glue catalog


Configure this setting directly using the following Meltano command:

meltano config tap-iceberg set client_iam_role_arn [value]

Client Region (client_region)

  • Environment variable: TAP_ICEBERG_CLIENT_REGION

The AWS region for accessing S3/Glue catalogs


Configure this setting directly using the following Meltano command:

meltano config tap-iceberg set client_region [value]

Client Secret Access Key (client_secret_access_key)

  • Environment variable: TAP_ICEBERG_CLIENT_SECRET_ACCESS_KEY

The AWS secret access key for accessing S3/Glue catalogs


Configure this setting directly using the following Meltano command:

meltano config tap-iceberg set client_secret_access_key [value]

Client Session Token (client_session_token)

  • Environment variable: TAP_ICEBERG_CLIENT_SESSION_TOKEN

The AWS session token for accessing S3/Glue catalogs


Configure this setting directly using the following Meltano command:

meltano config tap-iceberg set client_session_token [value]
Expand To Show SDK Settings

Batch Config Encoding Compression (batch_config.encoding.compression)

  • Environment variable: TAP_ICEBERG_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-iceberg set batch_config encoding.compression [value]

Batch Config Encoding Format (batch_config.encoding.format)

  • Environment variable: TAP_ICEBERG_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-iceberg set batch_config encoding.format [value]

Batch Config Storage Prefix (batch_config.storage.prefix)

  • Environment variable: TAP_ICEBERG_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-iceberg set batch_config storage.prefix [value]

Batch Config Storage Root (batch_config.storage.root)

  • Environment variable: TAP_ICEBERG_BATCH_CONFIG_STORAGE_ROOT

Root path to use when writing batch files.


Configure this setting directly using the following Meltano command:

meltano config tap-iceberg set batch_config storage.root [value]

Faker Config Locale (faker_config.locale)

  • Environment variable: TAP_ICEBERG_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-iceberg set faker_config locale [value]

Faker Config Seed (faker_config.seed)

  • Environment variable: TAP_ICEBERG_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-iceberg set faker_config seed [value]

Flattening Enabled (flattening_enabled)

  • Environment variable: TAP_ICEBERG_FLATTENING_ENABLED

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


Configure this setting directly using the following Meltano command:

meltano config tap-iceberg set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

  • Environment variable: TAP_ICEBERG_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-iceberg set flattening_max_depth [value]

Stream Map Config (stream_map_config)

  • Environment variable: TAP_ICEBERG_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-iceberg set stream_map_config [value]

Stream Maps (stream_maps)

  • Environment variable: TAP_ICEBERG_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-iceberg 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-iceberg 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-iceberg

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK

Repo

https://github.com/shaped-ai/tap-iceberg
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Shaped

Keywords

  • meltano_sdk