Add Or Update Records with Grist API on New Row (Custom Query) from MySQL API

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

Trigger workflow on

New Row (Custom Query) from the MySQL API

Next, do this

Add Or Update Records with the Grist API

No credit card required

▶

Watch us build a workflow

8 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 MySQL trigger and Grist 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 MySQL account
2. Configure timer
3. Select a Table
4. Optional- Select a De-duplication Key
5. Configure Where condition
6. Configure Values
Configure the Add Or Update Records action
1. Connect your Grist account
2. Configure Document ID
3. Select a Table ID
4. Optional- Configure Do Not Parse
5. Optional- Select a On Many
6. Optional- Configure No Add
7. Optional- Configure No Update
8. Configure Data Records
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 MySQL

Description:Emit new event when new rows are returned from a custom query. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/select.html)

Version:2.0.3

Key:mysql-new-row-custom-query

View on GitHub

MySQL Overview#

The MySQL application on Pipedream enables direct interaction with your MySQL databases, allowing you to perform CRUD operations—create, read, update, delete—on your data with ease. You can leverage these capabilities to automate data synchronization, report generation, and event-based triggers that kick off workflows in other apps. With Pipedream's serverless platform, you can connect MySQL to hundreds of other services without managing infrastructure, crafting complex code, or handling authentication.

Trigger Code#

import common from "../common/table.mjs";
import { v4 as uuidv4 } from "uuid";

const { mysql } = common.props;

export default {
  ...common,
  key: "mysql-new-row-custom-query",
  name: "New Row (Custom Query)",
  description: "Emit new event when new rows are returned from a custom query. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/select.html)",
  version: "2.0.3",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    column: {
      propDefinition: [
        mysql,
        "column",
        (c) => ({
          table: c.table,
        }),
      ],
      label: "De-duplication Key",
      description:
        "The name of a column in the table to use for de-duplication",
      optional: true,
    },
    condition: {
      propDefinition: [
        mysql,
        "whereCondition",
      ],
    },
    values: {
      propDefinition: [
        mysql,
        "whereValues",
      ],
    },
  },
  methods: {
    ...common.methods,
    async listResults() {
      const {
        table,
        condition,
        values,
      } = this;

      const numberOfQuestionMarks = condition?.match(/\?/g)?.length;

      if (!numberOfQuestionMarks) {
        throw new Error("No valid condition provided. At least one question mark character ? must be provided.");
      }

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

      if (values.length !== numberOfQuestionMarks) {
        throw new Error("The number of values provided does not match the number of question marks ? in the condition.");
      }

      const rows = await this.mysql.findRows({
        table,
        condition,
        values,
      });
      this.iterateAndEmitEvents(rows);
    },
    generateMeta(row) {
      const id = this.column
        ? row[this.column]
        : uuidv4();
      return {
        id,
        summary: `New Row ${id}`,
        ts: Date.now(),
      };
    },
  },
};

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
MySQL	`mysql`	`app`	This component uses the MySQL app.
	`timer`	`$.interface.timer`
Table	`table`	`string`	Select a value from the drop down menu.
De-duplication Key	`column`	`string`	Select a value from the drop down menu.
Where condition	`condition`	`string`	In this expression you can write your own conditions (eg. `column1 = ? or column2 = ?`). Depending on the number of `?` symbols likewise you need to add the same number of values.
Values	`values`	`string[]`	This is the list of values that will match every `?` symbol in the where expression. If you want to build yourself the values (eg. `{{["string1", "string2"]}}`)

Trigger Authentication#

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

Before you connect to your MySQL 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 3306), or
Accessible from a static IP that you've configured using a VPC in Pipedream, and enabled the workflow to connect through that VPC

SSL Setup

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

About MySQL#

MySQL is an open-source relational database management system.

Action#

Add Or Update Records on Grist

Description:Add records in a specified table or updates existing matching records. [See the documentation](https://support.getgrist.com/api/#tag/records/operation/replaceRecords)

Version:0.0.1

Key:grist-add-update-records

View on GitHub

Grist Overview#

Grist API on Pipedream enables you to automate data management tasks in your Grist documents. This might mean syncing data across different platforms, triggering notifications based on data changes, or processing data through custom logic. With Pipedream, you can use the Grist API to build workflows that react to events in real-time, connect to hundreds of other services, manipulate data in sophisticated ways, and create custom endpoints to integrate with your Grist data.

Action Code#

import app from "../../grist.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "grist-add-update-records",
  name: "Add Or Update Records",
  description: "Add records in a specified table or updates existing matching records. [See the documentation](https://support.getgrist.com/api/#tag/records/operation/replaceRecords)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    docId: {
      propDefinition: [
        app,
        "docId",
      ],
    },
    tableId: {
      propDefinition: [
        app,
        "tableId",
        ({ docId }) => ({
          docId,
        }),
      ],
    },
    noParse: {
      propDefinition: [
        app,
        "noParse",
      ],
    },
    onMany: {
      type: "string",
      label: "On Many",
      description: "Which records to update if multiple records are found to match.",
      optional: true,
      options: [
        {
          value: "first",
          label: "The first matching record (default)",
        },
        {
          value: "none",
          label: "Do not update anything",
        },
        {
          value: "all",
          label: "Update all matches",
        },
      ],
    },
    noAdd: {
      type: "boolean",
      label: "No Add",
      description: "Set to true to prohibit adding records.",
      optional: true,
    },
    noUpdate: {
      type: "boolean",
      label: "No Update",
      description: "Set to true to prohibit updating records.",
      optional: true,
    },
    records: {
      description: app.propDefinitions.records.description + " Instead of an id, a `require` object is provided, with the same structure as `fields`. If no query parameter options are set, then the operation is as follows. First, we check if a record exists matching the values specified for columns in `require`. If so, we update it by setting the values specified for columns in fields. If not, we create a new record with a combination of the values in `require` and `fields`, with `fields` taking priority if the same column is specified in both. The query parameters allow for variations on this behavior. Eg. `[ { \"require\": { \"pet\": \"cat\" }, \"fields\": { \"popularity\": 67 } } ]`",
      propDefinition: [
        app,
        "records",
      ],
    },
  },
  methods: {
    addUpdateRecords({
      docId, tableId, ...args
    } = {}) {
      return this.app.put({
        path: `/docs/${docId}/tables/${tableId}/records`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      addUpdateRecords,
      docId,
      tableId,
      noParse: noparse,
      onMany: onmany,
      noAdd: noadd,
      noUpdate: noupdate,
      records,
    } = this;

    await addUpdateRecords({
      $,
      docId,
      tableId,
      params: {
        noparse,
        onmany,
        noadd,
        noupdate,
      },
      data: {
        records: utils.parseArray(records),
      },
    });

    $.export("$summary", "Successfully ran this action");

    return {
      success: true,
    };
  },
};

Action Configuration#

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

Label	Prop	Type	Description
Grist	`app`	`app`	This component uses the Grist app.
Document ID	`docId`	`string`	The ID of the Grist document to operate on. You can find this in the Settings menu of the document.
Table ID	`tableId`	`string`	Select a value from the drop down menu.
Do Not Parse	`noParse`	`boolean`	Set to `true` to prohibit parsing strings according to the column type.
On Many	`onMany`	`string`	Select a value from the drop down menu:`{ "value": "first", "label": "The first matching record (default)" }{ "value": "none", "label": "Do not update anything" }{ "value": "all", "label": "Update all matches" }`
No Add	`noAdd`	`boolean`	Set to true to prohibit adding records.
No Update	`noUpdate`	`boolean`	Set to true to prohibit updating records.
Data Records	`records`	`string[]`	The data for the records to append or update. Each record should be a JSON-formatted string, mapping column names to cell values. Eg. `[ { "fields": { "pet": "cat", "popularity": 67 } } ]`. Instead of an id, a `require` object is provided, with the same structure as `fields`. If no query parameter options are set, then the operation is as follows. First, we check if a record exists matching the values specified for columns in `require`. If so, we update it by setting the values specified for columns in fields. If not, we create a new record with a combination of the values in `require` and `fields`, with `fields` taking priority if the same column is specified in both. The query parameters allow for variations on this behavior. Eg. `[ { "require": { "pet": "cat" }, "fields": { "popularity": 67 } } ]`

Action Authentication#

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

To retrieve your API key,

Navigate to your Girst account and sign in
Go to “Profile Settings” > “API”

Add Or Update Records with Grist API on New Row (Custom Query) from MySQL API

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

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

Developers ♥ Pipedream

SSL Setup

1-24of2,000+apps by most popular

1
-
24
of
2,000+
apps by most popular