CopyIn

Load data into a PostgreSQL table.

Copys in CSV, Text, or Binary data into PostgreSQL table.

yaml
type: "io.kestra.plugin.jdbc.postgresql.CopyIn"

Load CSV data into a PostgreSQL table.

yaml
id: postgres_copy_in
namespace: company.team

tasks:
  - id: copy_in
    type: io.kestra.plugin.jdbc.postgresql.CopyIn
    url: jdbc:postgresql://127.0.0.1:5432/
    username: pg_user
    password: pg_password
    format: CSV
    from: "{{ outputs.export.uri }}"
    table: my_destination_table
    header: true
    delimiter: "\t"

Use Postgres CopyIn to ingest CSV data into Postgres table

yaml
    id: postgres_copyin
    namespace: company.team

    tasks:
      - id: download_products
        type: io.kestra.plugin.core.http.Download
        uri: https://huggingface.co/datasets/kestra/datasets/raw/main/csv/products.csv

      - id: create_products_table
        type: io.kestra.plugin.jdbc.postgresql.Query
        url: "jdbc:postgresql://{{ secret('POSTGRES_HOST') }}:5432/postgres"
        username: "{{ secret('POSTGRES_USERNAME') }}"
        password: "{{ secret('POSTGRES_PASSWORD') }}"
        sql: |
          CREATE TABLE IF NOT EXISTS products(
            product_id varchar(5),
            product_name varchar(100),
            product_category varchar(50),
            brand varchar(50)
          );

      - id: copyin_products
        type: io.kestra.plugin.jdbc.postgresql.CopyIn
        url: "jdbc:postgresql://{{ secret('POSTGRES_HOST') }}:5432/postgres"
        username: "{{ secret('POSTGRES_USERNAME') }}"
        password: "{{ secret('POSTGRES_PASSWORD') }}"
        format: CSV
        from: "{{ outputs.download_products.uri }}"
        table: products
        header: true
        delimiter: ","

Dynamic YES

Source file URI.

Dynamic YES

The JDBC URL to connect to the database.

SubType string

Dynamic YES

An optional list of columns to be copied.

If no column list is specified, all columns of the table will be copied.

Dynamic YES

Specifies the character that separates columns within each row (line) of the file.

The default is a tab character in text format, a comma in CSV format. This must be a single one-byte character. This option is not allowed when using binary.

Dynamic YES

Specifies that the file is encoded in the encoding_name.

If this option is omitted, the current client encoding is used. See the Notes below for more details.

Dynamic YES

Specifies the character that should appear before a data character that matches the QUOTE value.

The default is the same as the QUOTE value (so that the quoting character is doubled if it appears in the data). This must be a single one-byte character. This option is allowed only when using CSV format.

SubType string

Dynamic YES

Do not match the specified columns' values against the null string.

In the default case where the null string is empty, this means that empty values will be read as zero-length strings rather than nulls, even when they are not quoted. This option is allowed only in COPY FROM, and only when using CSV format.

SubType string

Dynamic YES

Match the specified columns' values against the null string, even if it has been quoted, and if a match is found set the value to NULL.

In the default case where the null string is empty, this converts a quoted empty string into NULL. This option is allowed only in COPY FROM, and only when using CSV format.

SubType string

Dynamic YES

Forces quoting to be used for all non-NULL values in each specified column.

NULL output is never quoted. If * is specified, non-NULL values will be quoted in all columns. This option is allowed only in COPY TO, and only when using CSV format.

Dynamic YES

Default TEXT

Possible Values

TEXTCSVBINARY

Selects the data format to be read or written.

Dynamic YES

Requests copying the data with rows already frozen, just as they would be after running the VACUUM FREEZE command.

This is intended as a performance option for initial data loading. Rows will be frozen only if the table being loaded has been created or truncated in the current sub-transaction, there are no cursors open and there are no older snapshots held by this transaction. It is currently not possible to perform a COPY FREEZE on a partitioned table.

Note that all other sessions will immediately be able to see the data once it has been successfully loaded. This violates the normal rules of MVCC visibility and users specifying should be aware of the potential problems this might cause.

Dynamic YES

Specifies that the file contains a header line with the names of each column in the file.

On output, the first line contains the column names from the table, and on input, the first line is ignored. This option is allowed only when using CSV.

Dynamic YES

Specifies the string that represents a null value.

The default is \N (backslash-N) in text format, and an unquoted empty string in CSV format. You might prefer an empty string even in text format for cases where you don't want to distinguish nulls from empty strings. This option is not allowed when using binary format.

Dynamic YES

Specifies copying the OID for each row.

An error is raised if OIDs is specified for a table that does not have OIDs, or in the case of copying a query.

Dynamic YES

The database user's password.

Dynamic YES

Specifies the quoting character to be used when a data value is quoted.

The default is double-quote. This must be a single one-byte character. This option is allowed only when using CSV format.

Dynamic YES

Default false

Is the connection SSL?

Dynamic YES

The SSL cert.

Must be a PEM encoded certificate

Dynamic YES

The SSL key.

Must be a PEM encoded key

Dynamic YES

The SSL key password.

Dynamic YES

Possible Values

DISABLEALLOWPREFERREQUIREVERIFY_CAVERIFY_FULL

The SSL mode.

Dynamic YES

The SSL root cert.

Must be a PEM encoded certificate

Dynamic YES

The name (optionally schema-qualified) of an existing table.

Dynamic YES

The database user.

The rows count from this COPY.

​Copy​In

CopyIn