​Pipelinewise​Redshift

Name of the schema where the tables will be created.

If schema_mapping is not defined then every stream sent by the tap is loaded into this schema.

The raw data from a tap.

The database hostname.

The database port.

The S3 bucket name.

The database user.

S3 Access Key ID.

Used for S3 and Redshift copy operations.

Add metadata columns.

Metadata columns add extra row level information about data ingestions, (i.e. when was the row read in source, when was inserted or deleted in redshift etc.) Metadata columns are creating automatically by adding extra columns to the tables with a column prefix SDC. The metadata columns are documented at here. Enabling metadata columns will flag the deleted rows by setting the _SDC_DELETED_AT metadata column. Without the addMetadataColumns option the deleted rows from singer taps will not be recongisable in Redshift.

Maximum number of rows in each batch.

At the end of each batch, the rows in the batch are loaded into Redshift.

Override default singer command.

The compression method to use when writing files to S3 and running Redshift COPY.

The task runner container image, only used if the task runner is container-based.

COPY options.

Parameters to use in the COPY command when loading data to Redshift. Some basic file formatting parameters are fixed values and not recommended overriding them by custom values. They are like: CSV GZIP DELIMITER ',' REMOVEQUOTES ESCAPE.

Object type RECORD items from taps can be transformed to flattened columns by creating columns automatically.

When hardDelete option is true then DELETE SQL commands will be performed in Redshift to delete rows in tables. It's achieved by continuously checking the _SDC_DELETED_AT metadata column sent by the singer tap. Due to deleting rows requires metadata columns, hardDelete option automatically enables the addMetadataColumns option as well..

The database name.

Grant USAGE privilege on newly created schemas and grant SELECT privilege on newly created tables to a specific list of users or groups.

If schemaMapping is not defined then every stream sent by the tap is granted accordingly.

Disable table cache.

By default the connector caches the available table structures in Redshift at startup. In this way it doesn't need to run additional queries when ingesting data to check if altering the target tables is required. With disable_table_cache option you can turn off this caching. You will always see the most recent table structures but will cause an extra query runtime.

Deprecated, use 'taskRunner' instead

Flush and load every stream into Redshift when one batch is full.

Warning: This may trigger the COPY command to use files with low number of records..

Delete rows on Redshift.

When hardDelete option is true then DELETE SQL commands will be performed in Redshift to delete rows in tables. It's achieved by continuously checking the _SDC_DELETED_AT metadata column sent by the singer tap. Due to deleting rows requires metadata columns, hardDelete option automatically enables the addMetadataColumns option as well.

Max number of parallel threads to use when flushing tables.

The number of threads used to flush tables.

0 will create a thread for each stream, up to parallelism_max. -1 will create a thread for each CPU core. Any other positive number will create that number of threads, up to parallelism_max.

The database user's password.

Override default pip packages to use a specific version.

Log based and Incremental replications on tables with no Primary Key cause duplicates when merging UPDATE events.

When set to true, stop loading data if no Primary Key is defined..

AWS Redshift COPY role ARN.

AWS Role ARN to be used for the Redshift COPY operation. Used instead of the given AWS keys for the COPY operation if provided - the keys are still used for other S3 operations.

AWS S3 ACL.

S3 Object ACL.

S3 Key Prefix.

A static prefix before the generated S3 key names. Using prefixes you can upload files into specific directories in the S3 bucket. Default(None).

Schema mapping.

Useful if you want to load multiple streams from one tap to multiple Redshift schemas. If the tap sends the stream_id in <schema_name>-<table_name> format then this option overwrites the default_target_schema value. Note, that using schema_mapping you can overwrite the default_target_schema_select_permissions value to grant SELECT permissions to different groups per schemas or optionally you can create indices automatically for the replicated tables.

S3 Secret Access Key.

Used for S3 and Redshift copy operations.

AWS S3 Session Token.

S3 AWS STS token for temporary credentials.

Do not update existing records when Primary Key is defined.

Useful to improve performance when records are immutable, e.g. events.

number of slices to split files into prior to running COPY on Redshift.

This should be set to the number of Redshift slices. The number of slices per node depends on the node size of the cluster - run SELECT COUNT(DISTINCT slice) slices FROM stv_slices to calculate this.

The name of Singer state file stored in KV Store.

The task runner to use.

Task runners are provided by plugins, each have their own properties.

Validate every single record message to the corresponding JSON schema.

This option is disabled by default and invalid RECORD messages will fail only at load time by Redshift. Enabling this option will detect invalid records earlier but could cause performance degradation..