← MySQL

Execute Query with MySQL API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Execute Query with the MySQL API
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

Create a workflow to Execute Query with the MySQL API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Execute Query action
    1. Connect your MySQL account
    2. Select a Table
    3. Configure Where condition
    4. Configure Values
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  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.

Execute Query on MySQL
Description:Find row(s) via a custom query. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/select.html)
Version:0.0.1
Key:mysql-execute-query

Code

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

export default {
  key: "mysql-execute-query",
  name: "Execute Query",
  description: "Find row(s) via a custom query. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/select.html)",
  type: "action",
  version: "0.0.1",
  props: {
    mysql,
    table: {
      description: "The table where the query will be executed",
      propDefinition: [
        mysql,
        "table",
      ],
    },
    condition: {
      propDefinition: [
        mysql,
        "whereCondition",
      ],
    },
    values: {
      propDefinition: [
        mysql,
        "whereValues",
      ],
    },
  },
  async run({ $ }) {
    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 result = await this.mysql.findRows({
      table,
      condition,
      values,
    });

    $.export("$summary", `Successfully found ${result.length} row(s) from table ${table}`);

    return result;
  },
};

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
MySQLmysqlappThis component uses the MySQL app.
TabletablestringSelect a value from the drop down menu.
Where conditionconditionstring

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.

Valuesvaluesstring[]

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"]}})

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.

These values correspond with your MySQL server:

  • host: IP address or domain to access your MySQL server
  • port: Default is 3306
  • username: The account username to log in
  • password: The account password to log in
  • database: The name of the database to open after logging in. Please note, MySQL must be connectable from Pipedream's IP address range. Otherwise, you'll receive a Connection Refused error.

About MySQL

Open-source relational database