Skip to main content

Singer-compatible inline map transformer, built with the Meltano SDK for Singer Taps.

Project description

meltano-map-transformer

pre-commit.ci status

A map transformer to duplicate, filter, hash, mask and do many more small transformations in your extract & load pipelines. Implements the Stream Maps capability.

This mapper plugin is fully compliant with the Singer Spec and can be placed in between any Singer tap and target.

Requirements

  • Python 3.10+

meltano-map-transformer in action

For a collection of examples, take a look at examples/README.md.

Settings

Setting Required Default Description
stream_maps True None Stream maps
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.
stream_map_config False None User-defined config values to be used within map expressions.

A full list of supported settings and capabilities is available by running: meltano-map-transformer --about

Installation

We recommend using release tags when installing from GitHub. We also recommend using uv or or meltano instead of installing with pip directly.

You can see a full list of published releases here.

For example:

# Use `uv` so that virtual environments are managed automatically:
uv tool install meltano-map-transform

# Alternatively, use `pipx`:
pipx install meltano-map-transform

Meltano installation instructions

  1. Add this plugin to your Meltano project

    meltano add mapper meltano-map-transformer
    
  2. Install the plugin

    meltano install
    
  3. Configure the plugin

    # meltano.yml
    plugins:
      mappers:
      - name: meltano-map-transformer
        pip_url: meltano-map-transform
        executable: meltano-map-transform
        mappings:
        - name: hash_email
          config:
            stream_maps:
              customers:
                email: null # drop the PII field from RECORD and SCHEMA messages
                email_domain: email.split('@')[-1]
                email_hash: md5(config['hash_seed'] + email)
                __else__: null # drop all other fields
            stream_map_config:
              hash_seed: 01AWZh7A6DzGm6iJZZ2T
    
  4. Use the plugin in your pipelines

    meltano run tap-csv hash_email target-sqlite
    

Capabilities

  • stream-maps

Settings

Setting Required Default Description
stream_maps True None Stream maps

A full list of supported settings and capabilities is available by running: meltano-map-transformer --about

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

meltano_map_transform-0.12.1.tar.gz (982.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

meltano_map_transform-0.12.1-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file meltano_map_transform-0.12.1.tar.gz.

File metadata

  • Download URL: meltano_map_transform-0.12.1.tar.gz
  • Upload date:
  • Size: 982.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for meltano_map_transform-0.12.1.tar.gz
Algorithm Hash digest
SHA256 94ce2a4b6596952310040d76b63316247be58dde06403dd19eebaa01850e2057
MD5 1ca402cc28fd58b2dbd46b0754e09075
BLAKE2b-256 c775b7bf7717b0aba89ba0734064c44bd01c3f632329a3697e873cab586228df

See more details on using hashes here.

Provenance

The following attestation bundles were made for meltano_map_transform-0.12.1.tar.gz:

Publisher: build.yaml on MeltanoLabs/meltano-map-transform

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file meltano_map_transform-0.12.1-py3-none-any.whl.

File metadata

File hashes

Hashes for meltano_map_transform-0.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d0ef4b38fcf35192ec0913dec8f6f5fb2f74c4f22779d74b33d94793e0109b2c
MD5 46ebbcf19ebdeee045e829772d158c3c
BLAKE2b-256 5f11a26d5bdca5b74647a47b749f6894f79359bf7e267195781c42e071403aa0

See more details on using hashes here.

Provenance

The following attestation bundles were made for meltano_map_transform-0.12.1-py3-none-any.whl:

Publisher: build.yaml on MeltanoLabs/meltano-map-transform

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page