Help Desk

Submit a ticket My Tickets
Welcome
Login

Amazon Redshift Command Reference

Connector to Amazon Redshift via JDBC and SQL

Connections

Amazon Redshift

The connector to Amazon Redshift

Inputs

Input Type Detail Notes
Username TextField The username to authenticate with.
Password TextField The password to authenticate with.
Connection URL TextField The connection url. (e.g jdbc:redshift://endpoint:port/database)

Commands

Execute Create

Execute a CREATE statement

Inputs

Input Type Detail Notes
SQL Text/File TextField The SQL text or file to execute

Outputs

Output Output Type Notes
SQL Error Json

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs were given
3 Error Failed to run the command

Execute Query

Execute a SELECT query and receive the results as a CSV.

Inputs

Input Type Detail Notes
SQL Text/File TextField The SQL text or file to execute
Delimiter DropdownField The delimiter to use for the CSV file output.
Preview Results BooleanField Check this if you would like to see a preview of the returned rows.

Outputs

Output Output Type Notes
Record Count Integer
Result Set (CSV) File
SQL Error Json

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs were given
3 Error Failed to run the command

Execute SQL

Execute any SQL command. If there is a result set it will be available as a file output.

Inputs

Input Type Detail Notes
SQL Text/File TextField The SQL text or file to execute

Outputs

Output Output Type Notes
Record Count Integer
Result Set (CSV) File
Records Updated Integer
SQL Error Json

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs were given
3 Error Failed to run the command

Execute Update

Execute an UPDATE statement

Inputs

Input Type Detail Notes
SQL Text/File TextField The SQL text or file to execute

Outputs

Output Output Type Notes
Records Updated Integer
SQL Error Json

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs were given
3 Error Failed to run the command

Get Table Definition

Retrieve the details of a table including the columns, primary keys and foreign keys in a JSON format

Inputs

Input Type Detail Notes
Table TextField The table of which to retrieve the definition

Outputs

Output Output Type Notes
Table Metadata File
SQL Error Json

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs were given
3 Error Failed to run the command

Insert Records

Execute an INSERT statement. The source of the data can either be multi-lined text or a CSV file.

Inputs

Input Type Detail Notes
Table TextField The table to insert records into.
CSV Data Source TextField The CSV data to insert into the table. The columns in this data must match the same order specified in the columns input.
Delimiter DropdownField The delimiter used in the source data.
Is a file BooleanField If the data source is a file, check this box.
Includes Headers BooleanField Check this box if the source data's first row is the headers.
Columns ArrayField The list of columns that your source data will populate. Order is important and should match the CSV data source.
Value Template ArrayField Custom values declaration for the insert command. Indicate values with a "?". The number of "?"s should match the number of fields in the Target fields. You can leave this blank and they will be auto-generated.

Outputs

Output Output Type Notes
Records Inserted Integer
SQL Error Json

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs were given
3 Error Failed to run the command

Upsert Records

Execute an upsert. If the unique keys of an existing record have the same value as a record in the data source, the record will be updated, otherwise, the record will be inserted. The source of the data can either be multi-lined text or a CSV file.

Inputs

Input Type Detail Notes
Target Table TextField This is the table that the records will be upserted to.
Staging Table (Auto generated) TextField All of the records will be staged into this table, and then upserted into the Target Table. This table must not already exist and will be automatically created at the beginning of execution and dropped at the end of execution.
Unique Columns ArrayField This is the list of columns that make up the uniqueness of a record. If a record in the staging table has the same values as the target table for these columns the record will be updated, otherwise it will insert a new record.
CSV Data Source TextField The CSV data to insert into the table. The columns in this data must match the same order specified in the columns input.
Delimiter DropdownField The delimiter used in the source data.
Is a file BooleanField If the data source is a file, check this box.
Includes Headers BooleanField Check this box if the source data's first row is the headers.
Columns ArrayField The list of columns that your source data will populate. Order is important and should match the CSV data source.
Value Template ArrayField Custom values declaration for the insert command. Indicate values with a "?". The number of "?"s should match the number of fields in the Target fields. You can leave this blank and they will be auto-generated.

Outputs

Output Output Type Notes
Records Inserted Integer
SQL Error Json

Exit Codes

Code Type Detail
0 Success Success
1 Error Invalid inputs were given
3 Error Failed to run the command
B
Brian is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.