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.

PostgreSQL Connections#

PostgreSQL Connection#

Create a new PostgreSQL connection and enter the host, port, and database for your PostgreSQL server. The username and password are optional inputs that can be put directly into a PostgreSQL connection.

InputDefaultNotesExample
Input
Database
string
/ Required
Default
 
Notes
The database in PostgreSQL
Example
admin
Input
Host
string
/ Required
Default
192.168.0.1
Notes
Provide the string value for the host of the server.
Example
 
Input
Password
string
Default
 
Notes
 
Example
 
Input
Port
string
/ Required
Default
 
Notes
The port of the PostgreSQL server.
Example
 
Input
Username
string
Default
 
Notes
 
Example
 

Actions#

Query#

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

InputNotesExample
Input
Optional Parameters
data
Key Value List
Notes
Optional parameters to insert into a query.
Example
 
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Query Field
string
/ Required
Notes
The query to be executed
Example
INSERT INTO users(first_name, last_name, age) VALUES(${name.first}, ${name.last}, ${age})