tap-snowflake

tap-snowflake is a Singer tap for Snowflake.

Built with the Meltano Tap SDK for Singer Taps.

Custom setup

Adapted from Meltano's tap to support key pair authentication to Snowflake.

• install with meltano add --custom extractor tap-snowflake
  • namespace: tap-snowflake
  • pip_url: git+https://github.com/Obakalash/tap-snowflake.git
  • executable name: tap-snowflake
  • capabilities: catalog,batch,state,discover,about,stream-maps,schema-flattening
  • settings: account,database,schema,user,password:password,warehouse,role,private_key:password,private_key_passphrase:password,tables,stream_maps:object,stream_map_config:object,flattening_enabled:boolean,flattening_max_depth:integer

Installation

pipx install git+https://github.com/MeltanoLabs/tap-snowflake.git

Configuration

Accepted Config Options

A full list of supported settings and capabilities for this tap is available by running:

tap-snowflake --about

Configure using environment variables

This Singer tap 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.

Source Authentication and Authorization

Standard username and password auth is supported.

Enabling Batch Messaging

This tap is built using the Meltano SDK and therefore supports a BATCH message type, in addition to the RECORD messages of the Singer spec. This can be enabled either by adding the following to your config.json:

{
  // ...
  "batch_config": {
    "encoding": {
      "format": "jsonl",
      "compression": "gzip"
    },
    "storage": {
      "root": "file://tests/core/resources",
      "prefix": "test-batch"
    }
  }
}

or its equivalent to your meltano.yml

config:
  plugins:
    extractors:
      - name: tap-snowflake
        config:
          batch_config:
            encoding:
              format: jsonl
              compression: gzip
            storage:
              root: "file://tests/core/resources"
              prefix: test-batch

Note: This variant of tap-snowflake does not yet support the INCREMENTAL replication strategy in BATCH mode. Follow here for updates.

Usage

You can easily run tap-snowflake by itself or in a pipeline using Meltano.

Executing the Tap Directly

tap-snowflake --version
tap-snowflake --help
tap-snowflake --config CONFIG --discover > ./catalog.json

Developer Resources

Initialize your Development Environment

pipx install poetry
poetry install

Create and Run Tests

Create tests within the tap_snowflake/tests subfolder and then run:

poetry run pytest

You can also test the tap-snowflake CLI interface directly using poetry run:

poetry run tap-snowflake --help

Testing with Meltano

Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.

Your project comes with a custom meltano.yml project file already created. Open the meltano.yml and follow any "TODO" items listed in the file.

Next, install Meltano (if you haven't already) and any needed plugins:

# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-snowflake
meltano install

Now you can test and orchestrate using Meltano:

# Test invocation:
meltano invoke tap-snowflake --version
# OR run a test `elt` pipeline:
meltano elt tap-snowflake target-jsonl

SDK Dev Guide

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