PostgreSQL - Upload File to Table from Platform

Overview

Upload one or more CSV files to any table in PostgreSQL. With the file data, you can:

Append Data - Add the contents of your file to the end of the table.
Replace Data - Write over the entire contents of table with the contents of your file.

Column names are inferred from the header row of your CSV file. Column names must not be null or be duplicate values.

If the table already exists, the header values are matched to the table column names. The header names must match the existing column names in your table, otherwise the Vessel will error.

Data is inserted into the table by using multiple INSERT statements.

In all instances, if the table name does not already exist, a new table will be created with datatypes inferred from the CSV contents.

Note: This Vessel cannot be used to upload a local file from your computer.

Recommended Setup:

A Vessel built with this Blueprint should typically run after a Vessel that either downloads a file to Platform or generates a file with code.

Variables

Name	Reference	Type	Required	Default	Options	Description
Host	POSTGRES_HOST	Alphanumeric	✅	-	-	The domain or the IP address of the database you want to connect to.
Port	POSTGRES_PORT	Integer	✅	`"5432"`	-	Number for the database port to connect to. Defaults to 5432.
Username	POSTGRES_USERNAME	Alphanumeric	✅	-	-	Name of the user to connect to the database with.
Password	POSTGRES_PASSWORD	Password	➖	-	-	Password associated to the provided username.
Database	POSTGRES_DATABASE	Alphanumeric	✅	-	-	Name of the database in PostgreSQL to connect to.
Extra URL Parameters	POSTGRES_URL_PARAMETERS	Alphanumeric	➖	-	-	Extra parameters that will be placed at the end of the connection string, after the "?". Must be separated by "&".
Shipyard Folder Name	POSTGRES_SOURCE_FOLDER_NAME	Alphanumeric	➖	-	-	Folder where the file to upload can be found. If left blank, will search in the current working directory.
Shipyard File Name Match Type	POSTGRES_SOURCE_FILE_NAME_MATCH_TYPE	Select	✅	`exact_match`	Exact Match: `exact_match` Regex Match: `regex_match`	Determines if the text in "File Name" will match exactly to a single file, or use regex to match to multiple files.
Shipyard File Name	POSTGRES_SOURCE_FILE_NAME	Alphanumeric	✅	-	-	The file name that contains the data you want uploaded.
Schema	POSTGRES_SCHEMA	Alphanumeric	➖	-	-	Schema where the table you're creating or uploading to exists.
Table Name	POSTGRES_TABLE_NAME	Alphanumeric	✅	-	-	Name of the table where you want data inserted. If the table doesn't already exist, it will be created.
Insertion Method	POSTGRES_INSERT_METHOD	Select	✅	`append`	Append Data: `append` Replace Data: `replace`	Determines how the data in your file will be added into the target table.

YAML

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
  blueprint: PostgreSQL - Upload File to Table from Shipyard
  inputs:
    POSTGRES_HOST: null  ## REQUIRED
    POSTGRES_PORT: '5432' ## REQUIRED
    POSTGRES_USERNAME: null ## REQUIRED
    POSTGRES_PASSWORD: null
    POSTGRES_DATABASE: null  ## REQUIRED
    POSTGRES_URL_PARAMETERS: null
    POSTGRES_SOURCE_FOLDER_NAME: null
    POSTGRES_SOURCE_FILE_NAME_MATCH_TYPE: exact_match ## REQUIRED
    POSTGRES_SOURCE_FILE_NAME: null ## REQUIRED
    POSTGRES_SCHEMA: null
    POSTGRES_TABLE_NAME: null ## REQUIRED
    POSTGRES_INSERT_METHOD: append ## REQUIRED
  type: BLUEPRINT
guardrails:
  retry_count: 1
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - '200'
    - '220'
    - '249'

PostgreSQL - Upload File to Table from Platform

Overview​

Variables​

YAML​

Overview

Variables

YAML