Skip to main content

PostgreSQL Component

Query and manage data in a PostgreSQL database

Component key: postgres

Description#

PostgreSQL is a popular relational database system. This component allows you to query a PostgreSQL database.

This component returns data as an object that can be used in subsequent steps. Instead of generating dynamic queries and sanitizing SQL yourself, you can use generic queries with named parameter placeholders like ${variableKey}. For example, you can enter a query that reads INSERT INTO users (name, email) VALUES (${name}, ${email}). Then, you can enter values with keys of name and email, and whatever values you like. Values provided for name and email are sanitized automatically.

Authorization Methods#

PostgreSQL requires one of the following authorization methods:

Auth TypeKeyDescriptionFields
Basic AuthbasicBasic authorization using a username/password combination

Username |  username

Password |  password

The Postgres username and password can be put directly into a basic auth credential, alongside the database host, port, and database name.

Actions#

Query#

Performs a query on a PostgreSQL database. | key: query

InputKeyDefaultNotesExample

Database Name

string
/ Required
databaseThe name of the Database.

Host

string
/ Required
hostThe address of the Database server.192.168.1.120

Optional Parameters

data
paramsOptional parameters to insert into a query.

Port

string
/ Required
port5432The port of the Database server.5432

Query Field

string
/ Required
queryFieldThe query to be executedINSERT INTO users(first_name, last_name, age) VALUES(${name.first}, ${name.last}, ${age})