Run Node Code with Node API on New Row Custom Query from PostgreSQL API

Pipedream makes it easy to connect APIs for Node, PostgreSQL and 2,000+ other apps remarkably fast.

Trigger workflow on

New Row Custom Query from the PostgreSQL API

Next, do this

Run Node Code with the Node API

No credit card required

▶

Watch us build a workflow

4 min

Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a PostgreSQL trigger and Node action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Row Custom Query trigger
1. Connect your PostgreSQL account
2. Configure Polling Interval
3. Select a Schema
4. Select a Table
5. Select a Column
6. Configure SQL Query
7. Optional- Configure Values
Configure the Run Node Code action
1. Connect your Node account
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Row Custom Query on PostgreSQL

Description:Emit new event when new rows are returned from a custom query that you provide. [See Docs](https://node-postgres.com/features/queries)

Version:2.0.2

Key:postgresql-new-row-custom-query

View on GitHub

PostgreSQL Overview#

Assuming you want a few paragraphs on what you can do with the PostgreSQL API:

The following examples demonstrate some of the things that can be done with the
PostgreSQL API:

Developing a custom storage engine for PostgreSQL
Adding a new data type to PostgreSQL
Creating a new function for PostgreSQL
Building a graphical user interface for PostgreSQL
And much more!

Trigger Code#

import common from "../common.mjs";

export default {
  ...common,
  name: "New Row Custom Query",
  key: "postgresql-new-row-custom-query",
  description: "Emit new event when new rows are returned from a custom query that you provide. [See Docs](https://node-postgres.com/features/queries)",
  version: "2.0.2",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    schema: {
      propDefinition: [
        common.props.postgresql,
        "schema",
      ],
    },
    table: {
      propDefinition: [
        common.props.postgresql,
        "table",
        (c) => ({
          schema: c.schema,
        }),
      ],
    },
    column: {
      propDefinition: [
        common.props.postgresql,
        "column",
        (c) => ({
          table: c.table,
          schema: c.schema,
        }),
      ],
    },
    query: {
      propDefinition: [
        common.props.postgresql,
        "query",
      ],
    },
    values: {
      propDefinition: [
        common.props.postgresql,
        "values",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateMeta(row, column) {
      return {
        id: row[column],
        summary: "New Row",
        ts: Date.now(),
      };
    },
  },
  async run() {
    const {
      schema,
      table,
      column,
      query,
      values = [],
    } = this;

    if (!Array.isArray(values)) {
      throw new Error("No valid values provided. The values property must be an array.");
    }

    const numberOfValues = query?.match(/\$/g)?.length || 0;
    if (values.length !== numberOfValues) {
      throw new Error("The number of values provided does not match the number of values in the query.");
    }

    const isColumnUnique = await this.isColumnUnique(schema, table, column);
    if (!isColumnUnique) {
      throw new Error("The column selected contains duplicate values. Column must be unique");
    }

    const rows = await this.postgresql.executeQuery({
      text: query,
      values,
    });
    for (const row of rows) {
      const meta = this.generateMeta(row, column);
      this.$emit(row, meta);
    }
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
PostgreSQL	`postgresql`	`app`	This component uses the PostgreSQL app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling Interval	`timer`	`$.interface.timer`	Pipedream will poll the API on this schedule
Schema	`schema`	`string`	Select a value from the drop down menu.
Table	`table`	`string`	Select a value from the drop down menu.
Column	`column`	`string`	Select a value from the drop down menu.
SQL Query	`query`	`string`	Your custom SQL Query using `$1`, `$2`... to represent values (eg. `INSERT INTO users(name, email) VALUES($1, $2)`
Values	`values`	`string[]`	List of values represented in your SQL Query above

Trigger Authentication#

PostgreSQL uses API keys for authentication. When you connect your PostgreSQL account, Pipedream securely stores the keys so you can easily authenticate to PostgreSQL APIs in both code and no-code steps.

Before you connect to your PostgreSQL database from Pipedream, please make sure your database is either:

Accessible from the public internet (You may need to add a firewall rule on 0.0.0.0/0 on port 5432), or
Accessible from a static IP that you've configured from a VPC in Pipedream, and enabled the workflow to connect through that VPC

SSL Setup

Configure SSL on your PostgreSQL database by providing the CA (Certificate Authority), and choosing between Full Verification, or Skip Verification. Skipping verification is not recommended as this has serious security implications.

About PostgreSQL#

PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.

Action#

Run Node Code on Node

Description:Write custom Node.js code and use any of the 400k+ npm packages available. Refer to the [Pipedream Node docs](https://pipedream.com/docs/code/nodejs) to learn more.

Version:0.0.2

Key:node-run-node-code

View on GitHub

Action Code#

import node from "../../node.app.mjs";

export default {
  name: "Run Node Code",
  version: "0.0.2",
  key: "node-run-node-code",
  description: "Write custom Node.js code and use any of the 400k+ npm packages available. Refer to the [Pipedream Node docs](https://pipedream.com/docs/code/nodejs) to learn more.",
  props: {
    node,
  },
  type: "action",
  methods: {},
  async run({
    steps, $,
  }) {
    // Return data to use it in future steps
    return steps.trigger.event;
  },
};