🚀 New! Kestra raises $3 million to grow Learn more

PipelinewisePostgres PipelinewisePostgres

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

A Singer target loads data into a Postgres database.

Full documentation can be found here

Properties

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

stateName

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

The name of singer state file

username

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

The database user

addMetadataColumns

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌
  • Default: 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.

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

command

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

Override default singer command

dataFlatteningMaxLevel

  • Type: integer
  • Dynamic: ❌
  • Required: ❌
  • Default: 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.

dbName

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

The database name

defaultTargetSchema

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

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.

defaultTargetSchemaSelectPermission

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

Grant USAGE privilege on newly created schemas and grant SELECT privilege on newly created.

docker

  • Type: DockerOptions
  • Dynamic: ❌
  • Required: ❌
  • Default: {image=python:3.10.12, pullPolicy=ALWAYS}

Docker options when for the DOCKER runner

flushAllStreams

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌
  • Default: 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..

hardDelete

  • Type: boolean
  • Dynamic: ❌
  • Required: ❌
  • Default: 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.

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.

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 Postgres. Enabling this option will detect invalid records earlier but could cause performance degradation..

Outputs

state

  • Type: string

Uri of the state file

Definitions

DeviceRequest

capabilities

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

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

count

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

A request for devices to be sent to device drivers

deviceIds

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

A request for devices to be sent to device drivers

driver

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

A request for devices to be sent to device drivers

options

  • Type: object
  • SubType: string
  • Dynamic: ❌
  • Required: ❌

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

These options are passed directly to the driver.

Credentials

auth

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

The registry auth.

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.

Memory

kernelMemory

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

The maximum amount of kernel memory the container can use.

The minimum allowed value is 4m. 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 --kernel-memory details.

memory

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

The maximum amount of memory resources the container can use.

That is, you must set the value to at least 6 megabytes.

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 amount of memory this container is allowed to swap to disk

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

memorySwappiness

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

The amount of memory this container is allowed to swap to disk

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.

DockerOptions

image

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

Docker image to use

config

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

Docker config 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

Credentials for a private container registry.

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: object
  • Dynamic: ❓
  • Required: ❌

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 within the 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

Cpu

cpus

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

The maximum amount of CPU resources a container can use.

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