This repository has been archived by the owner on Sep 23, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 60768f8
Showing
13 changed files
with
1,362 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# IDE | ||
.vscode | ||
.idea/* | ||
|
||
|
||
# Python | ||
__pycache__/ | ||
*.py[cod] | ||
*$py.class | ||
.virtualenvs | ||
*.egg-info/ | ||
*__pycache__/ | ||
*~ | ||
dist/ | ||
|
||
# Singer JSON files | ||
properties.json | ||
config.json | ||
state.json | ||
|
||
*.db | ||
.DS_Store | ||
venv | ||
env | ||
blog_old.md | ||
node_modules | ||
*.pyc | ||
tmp | ||
|
||
# Docs | ||
docs/_build/ | ||
docs/_templates/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
MIT License | ||
|
||
Copyright (c) 2019 TransferWise Ltd. (https://transferwise.com) | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,93 @@ | ||
# 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: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) | ||
|
||
[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 | ||
python3 -m venv venv | ||
pip install pipelinewise-tap-snowflake | ||
``` | ||
|
||
or | ||
|
||
```bash | ||
python3 -m venv venv | ||
. venv/bin/activate | ||
pip install --upgrade pip | ||
pip install . | ||
``` | ||
|
||
### Configuration | ||
|
||
1. Create a `config.json` file with connection details to snowflake. | ||
|
||
```json | ||
{ | ||
"account": "rtxxxxx.eu-central-1", | ||
"dbname": "database_name", | ||
"user": "my_user", | ||
"password": "password", | ||
"warehouse": "my_virtual_warehouse", | ||
"filter_dbs": "database_name", | ||
"filter_schemas": "schema1,schema2" | ||
} | ||
``` | ||
|
||
`filter_dbs` and `filter_schemas` are optional. | ||
|
||
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 | ||
``` | ||
|
||
### 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
singer-python==5.3.1 | ||
snowflake-connector-python==1.7.4 | ||
backoff==1.3.2 | ||
pendulum==1.2.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
#!/usr/bin/env python | ||
|
||
from setuptools import setup | ||
|
||
setup(name='pipelinewise-tap-snowflake', | ||
version='1.0.0', | ||
description='Singer.io tap for extracting data from Snowflake', | ||
author="TransferWise", | ||
url='https://github.com/transferwise/pipelinewise-tap-postgres', | ||
classifiers=['Programming Language :: Python :: 3 :: Only'], | ||
py_modules=['tap_snowflake'], | ||
install_requires=[ | ||
'singer-python==5.3.1', | ||
'snowflake-connector-python==1.7.4', | ||
'backoff==1.3.2', | ||
'pendulum==1.2.0' | ||
], | ||
entry_points=''' | ||
[console_scripts] | ||
tap-snowflake=tap_snowflake:main | ||
''', | ||
packages=['tap_snowflake', 'tap_snowflake.sync_strategies'], | ||
) |
Oops, something went wrong.