Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/transferwise/pipelinewise-tap-snowflake

Singer.io Tap for Snowflake - PipelineWise compatible
https://github.com/transferwise/pipelinewise-tap-snowflake

Last synced: 2 months ago
JSON representation

Singer.io Tap for Snowflake - PipelineWise compatible

Awesome Lists containing this project

README 

        
# Notice

To better serve Wise business and customer needs, the PipelineWise codebase needs to shrink.

We have made the difficult decision that, going forward many components of PipelineWise will be removed or incorporated in the main repo.

The last version before this decision is [v0.64.1](https://github.com/transferwise/pipelinewise/tree/v0.64.1)



We thank all in the open-source community, that over the past 6 years, have helped to make PipelineWise a robust product for heterogeneous replication of many many Terabytes, daily



# pipelinewise-tap-snowflake



[![PyPI version](https://badge.fury.io/py/pipelinewise-tap-snowflake.svg)](https://badge.fury.io/py/pipelinewise-tap-snowflake)

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pipelinewise-tap-snowflake.svg)](https://pypi.org/project/pipelinewise-tap-snowflake/)

[![License: Apache2](https://img.shields.io/badge/License-Apache2-yellow.svg)](https://opensource.org/licenses/Apache-2.0)



[Singer](https://www.singer.io/) tap that extracts data from a [Snowflake](https://www.snowflake.com/) database and produces JSON-formatted data following the [Singer spec](https://github.com/singer-io/getting-started/blob/master/docs/SPEC.md).



This is a [PipelineWise](https://transferwise.github.io/pipelinewise) compatible tap connector.



## How to use it



The recommended method of running this tap is to use it from [PipelineWise](https://transferwise.github.io/pipelinewise). When running it from PipelineWise you don't need to configure this tap with JSON files and most of things are automated. Please check the related documentation at [Tap Snowflake](https://transferwise.github.io/pipelinewise/connectors/taps/snowflake.html)



If you want to run this [Singer Tap](https://singer.io) independently please read further.



### Install and Run



First, make sure Python 3 is installed on your system or follow these

installation instructions for [Mac](http://docs.python-guide.org/en/latest/starting/install3/osx/) or

[Ubuntu](https://www.digitalocean.com/community/tutorials/how-to-install-python-3-and-set-up-a-local-programming-environment-on-ubuntu-16-04).



It's recommended to use a virtualenv:



```bash

make venv

```



### Configuration



1. Create a `config.json` file with connection details to snowflake, here is a [sample config file](./config_sample.json).



**Note**: `tables` is a mandatory parameter as well to avoid a long-running catalog discovery process.

Please specify fully qualified table and view names and only that ones that you need to extract otherwise you can

end up with very long running discovery mode of this tap. Discovery mode is analysing table structures but

Snowflake doesn't like selecting lot of rows from `INFORMATION_SCHEMA` or running `SHOW` commands that returns lot of

rows. Please be as specific as possible.



2. Run it in discovery mode to generate a `properties.json`



3. Edit the `properties.json` and select the streams to replicate



4. Run the tap like any other singer compatible tap:



```

  tap-snowflake --config config.json --properties properties.json --state state.json

```



### Authentication Methods



You can either use basic user/password authentication or Key Pair authentication.



#### User / Password authentication



Populate `user` and `password` in the `config.json` file



#### Key Pair authentication



To use key pair authentication, omit the `password` and instead provide the `private_key_path` to the unencrypted version of the private key and, optionally, the `private_key_passphrase`.



### Discovery mode



The tap can be invoked in discovery mode to find the available tables and

columns in the database:



```bash

$ tap-snowflake --config config.json --discover



```



A discovered catalog is output, with a JSON-schema description of each table. A

source table directly corresponds to a Singer stream.



## Replication methods



The two ways to replicate a given table are `FULL_TABLE` and `INCREMENTAL`.



### Full Table



Full-table replication extracts all data from the source table each time the tap

is invoked.



### Incremental



Incremental replication works in conjunction with a state file to only extract

new records each time the tap is invoked. This requires a replication key to be

specified in the table's metadata as well.



### To run tests:



1. Define environment variables that requires running the tests

```

  export TAP_SNOWFLAKE_ACCOUNT=

  export TAP_SNOWFLAKE_DBNAME=

  export TAP_SNOWFLAKE_USER=

  export TAP_SNOWFLAKE_PASSWORD=

  export TAP_SNOWFLAKE_PRIVATE_KEY_PATH=

  export TAP_SNOWFLAKE_PRIVATE_KEY_PASSPHRASE=

  export TAP_SNOWFLAKE_WAREHOUSE=

```



2. Install python dependencies

```bash

make venv

```



3. To run unit tests:



**PS**: There are no unit tests at the time of writing this document



```bash

make unit_test

```



4. To run Integration tests

```bash

make integration_test

```



### To run formatting and linting:



```bash

make venv format pylint

```



## License



Apache License Version 2.0



See [LICENSE](LICENSE) to see the full text.