IOMETE

target-iomete (iomete variant)

Serverless lakehouse platform.

The target-iomete loader sends data into IOMETE after it was pulled from a source using an extractor

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 target-iomete loader to your project using
    meltano add
    :
  2. meltano add loader target-iomete
  3. Configure the target-iomete settings using
    meltano config
    :
  4. meltano config target-iomete set --interactive

Next steps

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

Capabilities

The current capabilities for target-iomete may have been automatically set when originally added to the Hub. Please review the capabilities when using this loader. 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 loader.

This plugin has the following capabilities:

  • record-flattening
  • hard-delete

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

Settings

The target-iomete 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 target-iomete 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.

User (user)

  • Environment variable: TARGET_IOMETE_USER

iomete User


Configure this setting directly using the following Meltano command:

meltano config target-iomete set user [value]

S3 Key Prefix (s3_key_prefix)

  • Environment variable: TARGET_IOMETE_S3_KEY_PREFIX

(Default: None) A static prefix before the generated S3 key names. Using prefixes you can upload files into specific directories in the S3 bucket.


Configure this setting directly using the following Meltano command:

meltano config target-iomete set s3_key_prefix [value]

Primary Key Required (primary_key_required)

  • Environment variable: TARGET_IOMETE_PRIMARY_KEY_REQUIRED

(Default: True) Log based and Incremental replications on tables with no Primary Key cause duplicates when merging UPDATE events. When set to true, stop loading data if no Primary Key is defined.


Configure this setting directly using the following Meltano command:

meltano config target-iomete set primary_key_required [value]

Validate Records (validate_records)

  • Environment variable: TARGET_IOMETE_VALIDATE_RECORDS

(Default: False) Validate every single record message to the corresponding JSON schema. This option is disabled by default and invalid RECORD messages will fail only at load time by iomete. Enabling this option will detect invalid records earlier but could cause performance degradation.


Configure this setting directly using the following Meltano command:

meltano config target-iomete set validate_records [value]

Hard Delete (hard_delete)

  • Environment variable: TARGET_IOMETE_HARD_DELETE

(Default: False) When hard_delete option is true then DELETE SQL commands will be performed in iomete to delete rows in tables. It's achieved by continuously checking the _SDC_DELETED_AT metadata column sent by the singer tap. Due to deleting rows requires metadata columns, hard_delete option automatically enables the add_metadata_columns option as well.


Configure this setting directly using the following Meltano command:

meltano config target-iomete set hard_delete [value]

Aws Secret Access Key (aws_secret_access_key)

  • Environment variable: TARGET_IOMETE_AWS_SECRET_ACCESS_KEY

S3 Secret Access Key. If not provided, AWS_SECRET_ACCESS_KEY environment variable or IAM role will be used


Configure this setting directly using the following Meltano command:

meltano config target-iomete set aws_secret_access_key [value]

Data Flattening Max Level (data_flattening_max_level)

  • Environment variable: TARGET_IOMETE_DATA_FLATTENING_MAX_LEVEL

(Default: 0) Object type RECORD items from taps can be loaded into STRUCT columns as JSON (default) or we can flatten the schema by creating columns automatically. When value is 0 (default) then flattening functionality is turned off.


Configure this setting directly using the following Meltano command:

meltano config target-iomete set data_flattening_max_level [value]

Batch Wait Limit Seconds (batch_wait_limit_seconds)

  • Environment variable: TARGET_IOMETE_BATCH_WAIT_LIMIT_SECONDS

(Default: None) Maximum time to wait for batch to reach batch_size_rows.


Configure this setting directly using the following Meltano command:

meltano config target-iomete set batch_wait_limit_seconds [value]

Account Number (account_number)

  • Environment variable: TARGET_IOMETE_ACCOUNT_NUMBER

iomete account name (i.e. 645049172474)


Configure this setting directly using the following Meltano command:

meltano config target-iomete set account_number [value]

Add Metadata Columns (add_metadata_columns)

  • Environment variable: TARGET_IOMETE_ADD_METADATA_COLUMNS

(Default: False) Metadata columns add extra row level information about data ingestions, (i.e. when was the row read in source, when was inserted or deleted in iomete etc.) Metadata columns are creating automatically by adding extra columns to the tables with a column prefix SDC. The column names are following the stitch naming conventions documented at https://www.stitchdata.com/docs/data-structure/integration-schemas#sdc-columns. Enabling metadata columns will flag the deleted rows by setting the _SDC_DELETED_AT metadata column. Without the add_metadata_columns option the deleted rows from singer taps will not be recongisable in iomete.


Configure this setting directly using the following Meltano command:

meltano config target-iomete set add_metadata_columns [value]

Default Target Schema (default_target_schema)

  • Environment variable: TARGET_IOMETE_DEFAULT_TARGET_SCHEMA

Name of the schema where the tables will be created, without database prefix. If schema_mapping is not defined then every stream sent by the tap is loaded into this schema.


Configure this setting directly using the following Meltano command:

meltano config target-iomete set default_target_schema [value]

Flush All Streams (flush_all_streams)

  • Environment variable: TARGET_IOMETE_FLUSH_ALL_STREAMS

(Default: False) Flush and load every stream into iomete when one batch is full. Warning: This may trigger the COPY command to use files with low number of records, and may cause performance problems.


Configure this setting directly using the following Meltano command:

meltano config target-iomete set flush_all_streams [value]

Lakehouse (lakehouse)

  • Environment variable: TARGET_IOMETE_LAKEHOUSE

iomete lakehouse name


Configure this setting directly using the following Meltano command:

meltano config target-iomete set lakehouse [value]

Parallelism (parallelism)

  • Environment variable: TARGET_IOMETE_PARALLELISM

(Default: 0) The number of threads used to flush tables. 0 will create a thread for each stream, up to parallelism_max. -1 will create a thread for each CPU core. Any other positive number will create that number of threads, up to parallelism_max. Parallelism works only with external stages. If no s3_bucket defined with an external stage then flusing tables is enforced to use a single thread.


Configure this setting directly using the following Meltano command:

meltano config target-iomete set parallelism [value]

S3 Endpoint Url (s3_endpoint_url)

  • Environment variable: TARGET_IOMETE_S3_ENDPOINT_URL

The complete URL to use for the constructed client. This is allowing to use non-native s3 account.


Configure this setting directly using the following Meltano command:

meltano config target-iomete set s3_endpoint_url [value]

S3 Bucket (s3_bucket)

  • Environment variable: TARGET_IOMETE_S3_BUCKET

S3 Bucket name. Required if to use S3 External stage. When this is defined then stage has to be defined as well.


Configure this setting directly using the following Meltano command:

meltano config target-iomete set s3_bucket [value]

Aws Session Token (aws_session_token)

  • Environment variable: TARGET_IOMETE_AWS_SESSION_TOKEN

AWS Session token. If not provided, AWS_SESSION_TOKEN environment variable will be used


Configure this setting directly using the following Meltano command:

meltano config target-iomete set aws_session_token [value]

Aws Profile (aws_profile)

  • Environment variable: TARGET_IOMETE_AWS_PROFILE

AWS profile name for profile based authentication. If not provided, AWS_PROFILE environment variable will be used.


Configure this setting directly using the following Meltano command:

meltano config target-iomete set aws_profile [value]

No Compression (no_compression)

  • Environment variable: TARGET_IOMETE_NO_COMPRESSION

(Default: False) Generate uncompressed files when loading to iomete. Normally, by default GZIP compressed files are generated.


Configure this setting directly using the following Meltano command:

meltano config target-iomete set no_compression [value]

Parallelism Max (parallelism_max)

  • Environment variable: TARGET_IOMETE_PARALLELISM_MAX

(Default: 16) Max number of parallel threads to use when flushing tables.


Configure this setting directly using the following Meltano command:

meltano config target-iomete set parallelism_max [value]

Batch Size Rows (batch_size_rows)

  • Environment variable: TARGET_IOMETE_BATCH_SIZE_ROWS

(Default: 100000) Maximum number of rows in each batch. At the end of each batch, the rows in the batch are loaded into iomete.


Configure this setting directly using the following Meltano command:

meltano config target-iomete set batch_size_rows [value]

Temp Dir (temp_dir)

  • Environment variable: TARGET_IOMETE_TEMP_DIR

(Default: platform-dependent) Directory of temporary files with RECORD messages.


Configure this setting directly using the following Meltano command:

meltano config target-iomete set temp_dir [value]

Aws Access Key Id (aws_access_key_id)

  • Environment variable: TARGET_IOMETE_AWS_ACCESS_KEY_ID

S3 Access Key Id. If not provided, AWS_ACCESS_KEY_ID environment variable or IAM role will be used


Configure this setting directly using the following Meltano command:

meltano config target-iomete set aws_access_key_id [value]

Password (password)

  • Environment variable: TARGET_IOMETE_PASSWORD

iomete Password


Configure this setting directly using the following Meltano command:

meltano config target-iomete set password [value]

Schema Mapping (schema_mapping)

  • Environment variable: TARGET_IOMETE_SCHEMA_MAPPING

Useful if you want to load multiple streams from one tap to multiple iomete schemas


Configure this setting directly using the following Meltano command:

meltano config target-iomete set schema_mapping [value]

S3 Acl (s3_acl)

  • Environment variable: TARGET_IOMETE_S3_ACL

S3 ACL name to set on the uploaded files


Configure this setting directly using the following Meltano command:

meltano config target-iomete set s3_acl [value]

S3 Region Name (s3_region_name)

  • Environment variable: TARGET_IOMETE_S3_REGION_NAME

Default region when creating new connections


Configure this setting directly using the following Meltano command:

meltano config target-iomete set s3_region_name [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 target-iomete loader 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 loader target-iomete

Maintenance Status

  • Maintenance Status

Repo

https://github.com/iomete/singer-target-iomete
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • iomete

Keywords

  • lakehouse