Metadata-Version: 2.1
Name: redshift-unloader
Version: 0.1.3
Summary: Unload utility for Amazon Redshift
Home-page: https://github.com/cryeo/redshift-unloader
Author: Chaerim Yeo
Author-email: yeochaerim@gmail.com
License: MIT License
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
Requires-Dist: boto3 (==1.7.84)
Requires-Dist: psycopg2 (==2.7.5)
Requires-Dist: psycopg2-binary (==2.7.5)

# redshift-unloader
Unloads the result of a query on Amazon Redshift to local storage.

## Prerequisites
- Python 3.6+
- boto3 1.7.84
- psycopg2 2.7.5
- psycopg2-binary 2.7.5

## Installation
The package is available on PyPI:

```bash
pip install redshift-unloader
```

### Usage
Unloaded data is supposed to be gzipped csv.

```py
from redshift_unloader import RedshiftUnloader

ru = RedshiftUnloader(host='<redshift host>',
                      port=<redshift port>,
                      user='<redshift user>',
                      password='<redshift password>',
                      database='<redshift database name>',
                      s3_bucket='<s3 bucket name>',
                      access_key_id='<aws access key id>',
                      secret_access_key='<aws secret access key>',
                      region='<aws region>',
                      verbose=False)

# If you don't need header, set with_header as False
ru.unload(query="SELECT * FROM my_table WHERE log_time >= ''", 
          filename="/path/to/result.csv.gz",
          with_header=True)
```


