← Pipedream

New Records from SQL Query from Pipedream API

Pipedream makes it easy to connect APIs for Pipedream and 700+ other apps remarkably fast.

Trigger workflow on
New Records from SQL Query from the Pipedream API
Next, do this
Connect to 700+ APIs using code and no-code building blocks
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Trigger a workflow on New Records from SQL Query with Pipedream API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the New Records from SQL Query trigger
    1. Configure timer
    2. Configure SQL Query
    3. Optional- Select a Result Type
    4. Optional- Configure Emit each record as its own event
    5. Connect your Pipedream account
  2. Add steps to connect to 700+ APIs using code and no-code building blocks
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is 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.

New Records from SQL Query on Pipedream
Description:Runs a query against the Pipedream SQL Service on a schedule, emitting the results in batch (default) or with each record as its own event
Version:0.0.2
Key:pipedream-new-records-from-sql-query

Code

const pipedream = require("../../pipedream.app.js");

module.exports = {
  key: "pipedream-new-records-from-sql-query",
  name: "New Records from SQL Query",
  description:
    "Runs a query against the Pipedream SQL Service on a schedule, emitting the results in batch (default) or with each record as its own event",
  version: "0.0.2",
  dedupe: "unique", // Dedupes records based on the query execution ID
  props: {
    timer: {
      type: "$.interface.timer",
      default: {
        cron: "0 0 * * *",
      },
    },
    sqlQuery: {
      type: "string",
      label: "SQL Query",
      description:
        "Your SQL query (try running in [https://pipedream.com/sql](https://pipedream.com/sql) first)",
    },
    resultType: {
      type: "string",
      label: "Result Type",
      description: `Specifies how you want the query results formatted`,
      optional: true,
      options: ["array", "object", "csv"],
      default: "array",
    },
    emitEachRecordAsEvent: {
      type: "boolean",
      label: "Emit each record as its own event",
      description:
        "If `true`, each record in your results set is emitted as its own event. Defaults to emitting results as a single event (an array of records)",
      optional: true,
      default: false,
    },
    pipedream,
  },
  async run() {
    const results = await this.pipedream.runSQLQuery(
      this.sqlQuery,
      this.resultType
    );
    if (this.resultType === "array" && this.emitEachRecordAsEvent) {
      // First, extract the properties to include in every event
      const { columnInfo, queryExecutionId, csvLocation } = results;
      let event = {
        columnInfo,
        queryExecutionId,
        csvLocation,
      };
      const header = results.results.shift();
      for (const [i, row] of results.results.entries()) {
        let record = {};
        for (const [j, col] of header.entries()) {
          record[col] = row[j];
        }
        // For each record, emit an event
        this.$emit(
          {
            query: this.sqlQuery,
            results: {
              columnInfo,
              queryExecutionId,
              csvLocation,
              record,
            },
          },
          {
            summary: `${this.sqlQuery} - ${i}`,
            id: `${results.queryExecutionId}-${i}`,
          }
        );
      }
      return;
    }
    this.$emit(
      { query: this.sqlQuery, results },
      {
        summary: this.sqlQuery,
        id: results.queryExecutionId,
      }
    );
  },
};

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.
LabelPropTypeDescription
timer$.interface.timer
SQL QuerysqlQuerystring

Your SQL query (try running in https://pipedream.com/sql first)

Result TyperesultTypestringSelect a value from the drop down menu:arrayobjectcsv
Emit each record as its own eventemitEachRecordAsEventboolean

If true, each record in your results set is emitted as its own event. Defaults to emitting results as a single event (an array of records)

PipedreampipedreamappThis component uses the Pipedream app.

Authentication

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

Your API key is in your Account Settings (Settings -> Account).

About Pipedream

Integration platform for developers