PipelinewiseRedshift
A Singer target loads data into a Redshift database.
Full documentation can be found here
type: "io.kestra.plugin.singer.targets.PipelinewiseRedshift"
YES
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.
YES
The raw data from a tap.
YES
1
The database hostname.
YES
YES
1
The S3 bucket name.
YES
1
The database user.
YES
S3 Access Key ID.
Used for S3 and Redshift copy operations.
YES
false
YES
100000
YES
Override default singer command.
YES
bzip2
gzip
bzip2
The compression method to use when writing files to S3 and running Redshift COPY.
YES
python:3.10.12
The task runner container image, only used if the task runner is container-based.
YES
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
.
YES
0
YES
The database name.
YES
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.
YES
false
NO
Deprecated, use 'taskRunner' instead
YES
false
YES
false
YES
16
YES
0
YES
The database user's password.
YES
Override default pip packages to use a specific version.
YES
true
YES
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.
YES
AWS S3 ACL.
S3 Object ACL.
YES
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).
YES
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.
YES
S3 Secret Access Key.
Used for S3 and Redshift copy operations.
YES
AWS S3 Session Token.
S3 AWS STS token for temporary credentials.
YES
false
YES
1
YES
singer-state
The name of Singer state file stored in KV Store.
NO
{
"type": "io.kestra.plugin.scripts.runner.docker.Docker"
}
The task runner to use.
Task runners are provided by plugins, each have their own properties.
YES
false
Key of the state in KV Store
YES
YES
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.
YES
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
.
YES
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.
YES
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.
YES
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.
YES
YES
1
Docker image to use.
YES
Docker configuration file.
Docker configuration file that can set access credentials to private container registries. Usually located in ~/.docker/config.json
.
NO
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.
YES
YES
Docker entrypoint to use.
YES
Extra hostname mappings to the container network interface configuration.
YES
Docker API URI.
NO
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.
YES
Docker network mode to use e.g. host
, none
, etc.
YES
YES
ALWAYS
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.
YES
Size of /dev/shm
in bytes.
The size must be greater than 0. If omitted, the system uses 64MB.
YES
User in the Docker container.
YES
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
.
YES
The registry authentication.
The auth
field is a base64-encoded authentication string of username: password
or a token.
YES
The identity token.
YES
The registry password.
YES
The registry URL.
If not defined, the registry will be extracted from the image name.
YES
The registry token.
YES
The registry username.
YES
A list of capabilities; an OR list of AND lists of capabilities.
YES
YES
YES
YES
Driver-specific options, specified as key/value pairs.
These options are passed directly to the driver.