PluginsSingerTasksTargetsPipelinewiseRedshift

PipelinewiseRedshift​Pipelinewise​Redshift

PipelinewiseRedshift PipelinewiseRedshift

yaml
type: "io.kestra.plugin.singer.targets.PipelinewiseRedshift"

A Singer target loads data into a Redshift database.

Full documentation can be found here

Properties

defaultTargetSchema

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min length: 1

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.

from

  • Type: string
  • Dynamic: ❓
  • Required: ✔️

The raw data from a tap.

host

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min length: 1

The database hostname.

port

  • Type: integer
  • Dynamic: ❌
  • Required: ✔️

The database port.

s3Bucket

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min length: 1

The S3 bucket name.

stateName

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Default: singer-state

The name of Singer state file stored in KV Store.

username

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min length: 1

The database user.

accessKeyId

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

S3 Access Key ID.

Used for S3 and Redshift copy operations.

addMetadataColumns

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌
  • Default: false

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.

batchSizeRows

  • Type: integer
  • Dynamic: ❌
  • Required: ❌
  • Default: 100000

Maximum number of rows in each batch.

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

command

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Override default singer command.

compression

  • Type: string
  • Dynamic: ❌
  • Required: ❌
  • Default: bzip2
  • Possible Values:
    • gzip
    • bzip2

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

containerImage

  • Type: string
  • Dynamic: ✔️
  • Required: ❌
  • Default: python:3.10.12

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

copyOptions

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

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.

dataFlatteningMaxLevel

  • Type: integer
  • Dynamic: ❌
  • Required: ❌
  • Default: 0

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..

dbName

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The database name.

defaultTargetSchemaSelectPermissions

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

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.

disableTableCache

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌
  • Default: false

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.

docker

Deprecated, use 'taskRunner' instead

flushAllStreams

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌
  • Default: false

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..

hardDelete

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌
  • Default: false

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.

maxParallelism

  • Type: integer
  • Dynamic: ❌
  • Required: ❌
  • Default: 16

Max number of parallel threads to use when flushing tables.

parallelism

  • Type: integer
  • Dynamic: ❌
  • Required: ❌
  • Default: 0

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.

password

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The database user's password.

pipPackages

  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

Override default pip packages to use a specific version.

primaryKeyRequired

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌
  • Default: true

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..

redshiftCopyRoleArn

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

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.

s3Acl

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

AWS S3 ACL.

S3 Object ACL.

s3KeyPrefix

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

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

  • Type: string
  • Dynamic: ❌
  • Required: ❌

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.

secretAccessKey

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

S3 Secret Access Key.

Used for S3 and Redshift copy operations.

sessionToken

  • Type: string
  • Dynamic: ✔️
  • Required: ❌

AWS S3 Session Token.

S3 AWS STS token for temporary credentials.

skipUpdates

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌
  • Default: false

**Do not update existing records when Primary Key is defined. **

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

slices

  • Type: integer
  • Dynamic: ❌
  • Required: ❌
  • Default: 1

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.

taskRunner

  • Type: TaskRunner
  • Dynamic: ❌
  • Required: ❌
  • Default: {type=io.kestra.plugin.scripts.runner.docker.Docker}

The task runner to use.

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

validateRecords

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌
  • Default: false

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..

Outputs

stateKey

  • Type: string
  • Required: ❌

Key of the state in KV Store

Definitions

io.kestra.plugin.scripts.runner.docker.Cpu

Properties

cpus
  • Type: integer
  • Dynamic: ❌
  • Required: ❌

The maximum amount of CPU resources a container can use.

Make sure to set that to a numeric value e.g. cpus: "1.5" or cpus: "4" or For instance, if the host machine has two CPUs and you set cpus: "1.5", the container is guaranteed at most one and a half of the CPUs.

io.kestra.core.models.tasks.runners.TaskRunner

Properties

type
  • Type: string
  • Dynamic: ❓
  • Required: ✔️
  • Validation regExp: \p{javaJavaIdentifierStart}\p{javaJavaIdentifierPart}*(\.\p{javaJavaIdentifierStart}\p{javaJavaIdentifierPart}*)*
  • Min length: 1

io.kestra.plugin.scripts.runner.docker.Memory

Properties

kernelMemory
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The maximum amount of kernel memory the container can use.

The minimum allowed value is 4MB. Because kernel memory cannot be swapped out, a container which is starved of kernel memory may block host machine resources, which can have side effects on the host machine and on other containers. See the kernel-memory docs for more details.

memory
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The maximum amount of memory resources the container can use.

Make sure to use the format number + unit (regardless of the case) without any spaces. The unit can be KB (kilobytes), MB (megabytes), GB (gigabytes), etc.

Given that it's case-insensitive, the following values are equivalent:

  • "512MB"
  • "512Mb"
  • "512mb"
  • "512000KB"
  • "0.5GB"

It is recommended that you allocate at least 6MB.

memoryReservation
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Allows you to specify a soft limit smaller than memory which is activated when Docker detects contention or low memory on the host machine.

If you use memoryReservation, it must be set lower than memory for it to take precedence. Because it is a soft limit, it does not guarantee that the container doesn’t exceed the limit.

memorySwap
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The total amount of memory and swap that can be used by a container.

If memory and memorySwap are set to the same value, this prevents containers from using any swap. This is because memorySwap includes both the physical memory and swap space, while memory is only the amount of physical memory that can be used.

memorySwappiness
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

A setting which controls the likelihood of the kernel to swap memory pages.

By default, the host kernel can swap out a percentage of anonymous pages used by a container. You can set memorySwappiness to a value between 0 and 100 to tune this percentage.

oomKillDisable
  • Type: boolean
  • Dynamic: ❌
  • Required: ❌

By default, if an out-of-memory (OOM) error occurs, the kernel kills processes in a container.

To change this behavior, use the oomKillDisable option. Only disable the OOM killer on containers where you have also set the memory option. If the memory flag is not set, the host can run out of memory, and the kernel may need to kill the host system’s processes to free the memory.

io.kestra.plugin.scripts.exec.scripts.models.DockerOptions

Properties

image
  • Type: string
  • Dynamic: ✔️
  • Required: ✔️
  • Min length: 1

Docker image to use.

config
  • Type:
    • string
    • object
  • Dynamic: ✔️
  • Required: ❌

Docker configuration file.

Docker configuration file that can set access credentials to private container registries. Usually located in ~/.docker/config.json.

cpu
  • Type: Cpu
  • Dynamic: ❌
  • Required: ❌

Limits the CPU usage to a given maximum threshold value.

By default, each container’s access to the host machine’s CPU cycles is unlimited. You can set various constraints to limit a given container’s access to the host machine’s CPU cycles.

credentials
deviceRequests

A list of device requests to be sent to device drivers.

entryPoint
  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

Docker entrypoint to use.

extraHosts
  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

Extra hostname mappings to the container network interface configuration.

host
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Docker API URI.

memory
  • Type: Memory
  • Dynamic: ❌
  • Required: ❌

Limits memory usage to a given maximum threshold value.

Docker can enforce hard memory limits, which allow the container to use no more than a given amount of user or system memory, or soft limits, which allow the container to use as much memory as it needs unless certain conditions are met, such as when the kernel detects low memory or contention on the host machine. Some of these options have different effects when used alone or when more than one option is set.

networkMode
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Docker network mode to use e.g. host, none, etc.

pullPolicy
  • Type: string
  • Dynamic: ❌
  • Required: ❌
  • Default: ALWAYS
  • Possible Values:
    • IF_NOT_PRESENT
    • ALWAYS
    • NEVER

The image pull policy for a container image and the tag of the image, which affect when Docker attempts to pull (download) the specified image.

shmSize
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

Size of /dev/shm in bytes.

The size must be greater than 0. If omitted, the system uses 64MB.

user
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

User in the Docker container.

volumes
  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌

List of volumes to mount.

Must be a valid mount expression as string, example : /home/user:/app.

Volumes mount are disabled by default for security reasons; you must enable them on server configuration by setting kestra.tasks.scripts.docker.volume-enabled to true.

io.kestra.plugin.scripts.runner.docker.Credentials

Properties

auth
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The registry authentication.

The auth field is a base64-encoded authentication string of username:password or a token.

identityToken
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The identity token.

password
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The registry password.

registry
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The registry URL.

If not defined, the registry will be extracted from the image name.

registryToken
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The registry token.

username
  • Type: string
  • Dynamic: ✔️
  • Required: ❌

The registry username.

io.kestra.plugin.scripts.runner.docker.DeviceRequest

Properties

capabilities
  • Type: array
  • SubType: array
  • Dynamic: ❌
  • Required: ❌

A list of capabilities; an OR list of AND lists of capabilities.

count
  • Type: integer
  • Dynamic: ❌
  • Required: ❌
deviceIds
  • Type: array
  • SubType: string
  • Dynamic: ✔️
  • Required: ❌
driver
  • Type: string
  • Dynamic: ✔️
  • Required: ❌
options
  • Type: object
  • SubType: string
  • Dynamic: ❌
  • Required: ❌

Driver-specific options, specified as key/value pairs.

These options are passed directly to the driver.

Was this page helpful?