PipelinewisePostgres
A Singer target loads data into a Postgres database.
Full documentation can be found here
type: "io.kestra.plugin.singer.targets.PipelinewisePostgres"
YES
The raw data from a tap.
YES
1
The database hostname.
YES
The database port.
YES
1
The database user.
YES
false
Add singer 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 postgres etc.) Metadata columns are creating automatically by adding extra columns to the tables with a column prefix _SDC_
. The column names are following the stitch naming conventions. Enabling metadata columns will flag the deleted rows by setting the _SDC_DELETED_AT
metadata column. Without the add_metadata_columns
option the deleted rows from singer taps will not be recognisable in Postgres.
YES
100000
Maximum number of rows in each batch.
At the end of each batch, the rows in the batch are loaded into Postgres.
YES
Override default singer command.
YES
python:3.10.12
The task runner container image, only used if the task runner is container-based.
YES
0
Object type RECORD items from taps can be transformed to flattened columns by creating columns automatically.
When value is 0 (default) then flattening functionality is turned off.
YES
The database name.
YES
Name of the schema where the tables will be created.
If schemaMapping
is not defined then every stream sent by the tap is loaded into this schema.
YES
Grant USAGE privilege on newly created schemas and grant SELECT privilege on newly created.
NO
Deprecated, use 'taskRunner' instead
YES
false
Flush and load every stream into Postgres when one batch is full.
Warning: This may trigger the COPY command to use files with low number of records..
YES
false
Delete rows on Postgres.
When hard_delete option is true then DELETE SQL commands will be performed in Postgres 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, hard_delete option automatically enables the add_metadata_columns option as well.
YES
16
Max number of parallel threads to use when flushing tables.
YES
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.
YES
The database user's password.
YES
Override default pip packages to use a specific version.
YES
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.
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
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 Postgres. Enabling this option will detect invalid records earlier but could cause performance degradation..
Key of the state in KV Store
YES
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.
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
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.
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
Give extended privileges to this container.
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.
NO
\d+\.\d+\.\d+(-[a-zA-Z0-9-]+)?|([a-zA-Z0-9]+)
The version of the plugin to use.