Skip to main content

PostgreSQL Component

Query and manage data in a PostgreSQL database

Component key: postgres


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

Query formatting

Instead of generating dynamic queries and sanitizing SQL yourself, you can use generic queries with query formatting. Formatted queries can either use numbered parameter placeholders like $1, $2, etc., or can use named parameter placeholders like ${variableKey}.

Index variables

Index variables are numbered parameter placeholders like $1, $2, etc. To use index variables, write a query that uses indexed placeholders (e.g. SELECT * FROM users WHERE id = $1 AND name = $2). Then, generate an array like [5, "John Doe"] and reference it from the Parameters Object or Array input.

Note: If you use indexed variables, you cannot use named variables in the same query.

Named variables

Named variables are written in the form ${variableKey}, $<variableKey> or $(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 as Named Parameters Inputs. Values provided as variables are sanitized automatically.

If you are dynamically generating SQL queries and do not know what parameters you will need ahead of time, create a key/value object in another step and reference them through the Parameters Object or Array input. In the example above, you could generate an object of the form {name: "John doe", email: ""}.


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.

On-prem enabled: this connection can be configured to connect to an on-prem resource on a private network. Learn more.



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