Amazon Redshift - Download Query Results to Shipyard

Overview

Turn the results of your SQL SELECT statement into a CSV file. Extract your Amazon Redshift data into files for easier delivery to clients and partners.

Variables

Name	Reference	Type	Required	Default	Options	Description
Host	REDSHIFT_HOST	Alphanumeric	✅	-	-	The domain or the IP address of the database you want to connect to.
Port	REDSHIFT_PORT	Integer	✅	"5439"	-	Port number where the database accepts inbound connections.
Username	REDSHIFT_USERNAME	Alphanumeric	✅	-	-	Username configured as part of the database credentials. See Authorization documentation for more information.
Password	REDSHIFT_PASSWORD	Password	➖	-	-	Password for the provided username
Database	REDSHIFT_DATABASE	Alphanumeric	✅	-	-	Name of the database to connect to.
Extra URL Parameters	REDSHIFT_URL_PARAMETERS	Alphanumeric	➖	-	-	Extra parameters that will be placed at the end of the connection string, after the "?". Must be separated by "&"
Query	REDSHIFT_QUERY	Alphanumeric	✅	-	-	A SELECT statement that returns data. Formatting is ignored
Shipyard Folder Name	REDSHIFT_DESTINATION_FOLDER_NAME	Alphanumeric	➖	-	-	Folder where the file will be created. Leave blank to store in the current working directory
Shipyard File Name	REDSHIFT_DESTINATION_FILE_NAME	Alphanumeric	✅	output.csv	-	File name that will be created with the results of the query
Include Column Names as Header?	REDSHIFT_FILE_HEADER	Boolean	✅	True	-	If checked, your CSV file will include a header row with column names.

YAML

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
  blueprint: Amazon Redshift - Download Query Results to Shipyard
  inputs:
    REDSHIFT_HOST: null  ## REQUIRED
    REDSHIFT_PORT: '5439' ## REQUIRED
    REDSHIFT_USERNAME: null ## REQUIRED
    REDSHIFT_PASSWORD: null
    REDSHIFT_DATABASE: null  ## REQUIRED
    REDSHIFT_URL_PARAMETERS: null
    REDSHIFT_QUERY: null ## REQUIRED
    REDSHIFT_DESTINATION_FOLDER_NAME: null
    REDSHIFT_DESTINATION_FILE_NAME: output.csv  ## REQUIRED
    REDSHIFT_FILE_HEADER: true ## REQUIRED
  type: BLUEPRINT
guardrails:
  retry_count: 1
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - '200'
    - '222'
    - '249'