Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Introduction

One of the most efficient ways to load data from Amazon Redshift to s3 is using the UNLOAD command:  http://docs.aws.amazon.com/redshift/latest/dg/t_Unloading_tables.html

Use case(s)

  • A financial customer would like to quickly unload financial reports into S3 that have been generated from processing that is happening in Redshift. The pipeline would have a Redshift to S3 action at the beginning, and then leverage the s3 source to read that data into a processing pipeline.

User Storie(s)

  • As a user, i would like to unload data from redshift to s3 using the unload command.
  • I would like to authenticate with IAM credentials as well as id and secret key pairs.
  • I would like to use that s3 data as an input into a hydrator pipeline
  • I would like the location of the data to be passed via workflow token so that they next plugin can use it in a macro

Plugin Type

  • Action

Configurables

This section defines properties that are configurable for this plugin. 

User Facing NameTypeDescriptionConstraints
QueryStringQuery to be used for unloading the data 
Access KeyStringAWS access key for S3 
Secret Access KeyStringAWS secret access key for S3 
AWS IAM RoleStringIAM Role 
S3 BucketStringAmazon S3 bucket (including key prefix) 
S3 RegionStringRegion for S3Optional
ManifestBooleanSpecify whether manifest file is to be created during unloading the data into S3 
S3 DelimiterStringThe delimiter by which fields in a character-delimited file are to be separated 
ParallelStringTo write data in parallel to multiple files, according to the number of slices in the cluster or to a single file. The default option is ON or TRUE. 
CompressionStringUnload a compressed file of type BZIP2 or GZIP 
ALLOWOVERWRITEStringBy default, UNLOAD fails if it finds files that it would possibly overwrite. If ALLOWOVERWRITE is specified, UNLOAD will overwrite existing files, including the manifest file. 
Redshift Cluster DB UrlStringJDBC Redshift DB url for connecting to the redshift cluster 
Master UserStringMaster user for redshift 
Master User PasswordStringMaster user password 
Redshift Table NameStringRedshift table name from which data is to be unloaded 

Design / Implementation Tips

Design

  1. User can connect to the S3 buckets using Either access and secret access key or using IAM role.
  2. By default unload command assumes that Redshift and s3 are in the same region, If S3 bucket is not in same region as of the Redshift cluster, then user can provide the region using 'Region for S3'.

Approach(s)

Properties

Security

Limitation(s)

Future Work

  • Some future work – HYDRATOR-99999
  • Another future work – HYDRATOR-99999

Test Case(s)

  • Test case #1
  • Test case #2

Sample Pipeline

Please attach one or more sample pipeline(s) and associated data. 

Pipeline #1

Pipeline #2

 

 

Table of Contents

Checklist

  • User stories documented 
  • User stories reviewed 
  • Design documented 
  • Design reviewed 
  • Feature merged 
  • Examples and guides 
  • Integration tests 
  • Documentation for feature 
  • Short video demonstrating the feature
  • No labels