Skip to main content
This gem runs in .

Overview

The Redshift Source and Target gems let you connect Prophecy pipelines to Amazon Redshift tables for reading and writing data. This page outlines how to configure Redshift sources and targets using the appropriate connections, locations, and properties.

Create a Redshift gem

To create a Redshift Source or Target gem in your pipeline:
1

Add a Source or Target gem to the pipeline

  1. Open your pipeline in the Studio.
  2. Click on Source/Target in the canvas.
  3. Select Source or Target from the dropdown.
  4. Click on the gem to open the configuration.
2

Select Redshift format

In the Type tab, select Redshift. Then, click Next.
3

Set location details

In the Location tab, set your connection details and table location. To learn more, jump to Source location and Target location.
4

Set table properties

In the Properties tab, set the table properties. To learn more, jump to Source properties and Target properties.
5

Preview data (Source only)

In the Preview tab, load a sample of the data and verify that it looks correct.

Source configuration

Use these settings to configure a Redshift Source gem for reading data.

Source location

ParameterDescription
Format typeTable format for the source. For Amazon Redshift tables, set to redshift.
Select or create connectionSelect or create a new Redshift connection in the Prophecy fabric you will use.
DatabaseDatabase containing the table you want to read from.
SchemaSchema within the database where the table is located.
NameExact name of the Amazon Redshift table to read data from.

Source properties

Infer or manually configure the schema of your Source gem. Optionally, add a description for your table. Additional properties are not supported at this time.

Target configuration

Use these settings to configure a Redshift Target gem for writing data.

Target location

ParameterDescription
Format typeTable format for the source. For Amazon Redshift tables, set to redshift.
Select or create connectionSelect or create a new Amazon Redshift connection in the Prophecy fabric you will use.
DatabaseDatabase where the target table will be created or updated.
SchemaSchema within the database where the target table resides or will be created.
NameName of the Amazon Redshift table to write data to. If the table doesn’t exist, it will be created automatically.

Target properties

PropertyDescriptionDefault
DescriptionDescription of the table.None
Write ModeWhether to overwrite the table, append new data to the table, or throw an error if the table exists.None