Snowflake

tap-snowflake (meltanolabs variant)🥇

Extractor for Snowflake data warehouse

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

Alternate Implementations

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

Next steps

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

Capabilities

The current capabilities for tap-snowflake 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-snowflake 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-snowflake 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.

Account (account)

  • Environment variable: TAP_SNOWFLAKE_ACCOUNT

Your account identifier. See Account Identifiers.


Configure this setting directly using the following Meltano command:

meltano config tap-snowflake set account [value]

Database (database)

  • Environment variable: TAP_SNOWFLAKE_DATABASE

The initial database for the Snowflake session.


Configure this setting directly using the following Meltano command:

meltano config tap-snowflake set database [value]

Password (password)

  • Environment variable: TAP_SNOWFLAKE_PASSWORD

The password for your Snowflake user. One of [password, private_key, private_key_path] is required.


Configure this setting directly using the following Meltano command:

meltano config tap-snowflake set password [value]

Private Key (private_key)

  • Environment variable: TAP_SNOWFLAKE_PRIVATE_KEY

The private key is used to connect to snowflake. One of [password, private_key, private_key_path] is required.


Configure this setting directly using the following Meltano command:

meltano config tap-snowflake set private_key [value]

Private Key Passphrase (private_key_passphrase)

  • Environment variable: TAP_SNOWFLAKE_PRIVATE_KEY_PASSPHRASE

The passprhase used to protect the private key


Configure this setting directly using the following Meltano command:

meltano config tap-snowflake set private_key_passphrase [value]

Private Key Path (private_key_path)

  • Environment variable: TAP_SNOWFLAKE_PRIVATE_KEY_PATH

Path to where the private key is stored. The private key is used to connect to snowflake. One of [password, private_key, private_key_path] is required.


Configure this setting directly using the following Meltano command:

meltano config tap-snowflake set private_key_path [value]

Role (role)

  • Environment variable: TAP_SNOWFLAKE_ROLE

The initial role for the session.


Configure this setting directly using the following Meltano command:

meltano config tap-snowflake set role [value]

Schema (schema)

  • Environment variable: TAP_SNOWFLAKE_SCHEMA

The initial schema for the Snowflake session.


Configure this setting directly using the following Meltano command:

meltano config tap-snowflake set schema [value]

Tables (tables)

  • Environment variable: TAP_SNOWFLAKE_TABLES

An array of the table names that you want to sync. The table names should be fully qualified, including schema and table name. NOTE: this limits discovery to the tables specified, for performance reasons. Do not specify tables if you intend to discover the entire available catalog. See readme for more details on the tables configuration parameter.


Configure this setting directly using the following Meltano command:

meltano config tap-snowflake set tables [value]

Use Browser Authentication (use_browser_authentication)

  • Environment variable: TAP_SNOWFLAKE_USE_BROWSER_AUTHENTICATION
  • Default Value: false

If authentication should be done using SSO (via external browser). See SSO browser authentication.


Configure this setting directly using the following Meltano command:

meltano config tap-snowflake set use_browser_authentication [value]

User (user)

  • Environment variable: TAP_SNOWFLAKE_USER

The login name for your Snowflake user.


Configure this setting directly using the following Meltano command:

meltano config tap-snowflake set user [value]

Warehouse (warehouse)

  • Environment variable: TAP_SNOWFLAKE_WAREHOUSE

The initial warehouse for the session.


Configure this setting directly using the following Meltano command:

meltano config tap-snowflake set warehouse [value]
Expand To Show SDK Settings

Batch Config Encoding Compression (batch_config.encoding.compression)

  • Environment variable: TAP_SNOWFLAKE_BATCH_CONFIG_ENCODING_COMPRESSION

Compression format to use for batch files.


Configure this setting directly using the following Meltano command:

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

Batch Config Encoding Format (batch_config.encoding.format)

  • Environment variable: TAP_SNOWFLAKE_BATCH_CONFIG_ENCODING_FORMAT

Format to use for batch files.


Configure this setting directly using the following Meltano command:

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

Batch Config Storage Prefix (batch_config.storage.prefix)

  • Environment variable: TAP_SNOWFLAKE_BATCH_CONFIG_STORAGE_PREFIX

Prefix to use when writing batch files.


Configure this setting directly using the following Meltano command:

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

Batch Config Storage Root (batch_config.storage.root)

  • Environment variable: TAP_SNOWFLAKE_BATCH_CONFIG_STORAGE_ROOT

Root path to use when writing batch files.


Configure this setting directly using the following Meltano command:

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

Faker Config Locale (faker_config.locale)

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

Faker Config Seed (faker_config.seed)

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

Flattening Enabled (flattening_enabled)

  • Environment variable: TAP_SNOWFLAKE_FLATTENING_ENABLED

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


Configure this setting directly using the following Meltano command:

meltano config tap-snowflake set flattening_enabled [value]

Flattening Max Depth (flattening_max_depth)

  • Environment variable: TAP_SNOWFLAKE_FLATTENING_MAX_DEPTH

The max depth to flatten schemas.


Configure this setting directly using the following Meltano command:

meltano config tap-snowflake set flattening_max_depth [value]

Stream Map Config (stream_map_config)

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

Stream Maps (stream_maps)

  • Environment variable: TAP_SNOWFLAKE_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-snowflake 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-snowflake 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-snowflake

Maintenance Status

  • Maintenance Status
  • Built with the Meltano SDK

Repo

https://github.com/MeltanoLabs/tap-snowflake
  • Stars
  • Forks
  • Last Commit Date
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Meltano

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

PyPI Stats

  • PyPI Downloads
  • PyPI Package Version

Keywords

  • meltano_sdkdatabase