Run Model with Summit API on New Column from MySQL API

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

Trigger workflow on

New Column from the MySQL API

Next, do this

Run Model with the Summit API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

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

Select this integration
Configure the New Column trigger
1. Connect your MySQL account
2. Configure timer
3. Select a Table
Configure the Run Model action
1. Connect your Summit account
2. Select a Model
3. Optional- Configure Experimental Flatten
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 Column on MySQL

Description:Emit new event when you add a new column to a table. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/show-columns.html)

Version:2.0.5

Key:mysql-new-column

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";

export default {
  ...common,
  key: "mysql-new-column",
  name: "New Column",
  description: "Emit new event when you add a new column to a table. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/show-columns.html)",
  type: "source",
  version: "2.0.5",
  dedupe: "unique",
  props: {
    ...common.props,
    db: "$.service.db",
  },
  methods: {
    ...common.methods,
    _getPreviousColumns() {
      return this.db.get("previousColumns");
    },
    _setPreviousColumns(previousColumns) {
      this.db.set("previousColumns", previousColumns);
    },
    async listResults() {
      const { table } = this;
      let previousColumns = this._getPreviousColumns() || [];
      const columns = await this.mysql.listNewColumns({
        table,
        previousColumns,
      });
      this.iterateAndEmitEvents(columns);

      const newColumnNames =
        columns
          .map((column) => column.Field)
          .filter((c) => !previousColumns.includes(c));

      previousColumns = previousColumns.concat(newColumnNames);
      this._setPreviousColumns(previousColumns);
    },
    generateMeta(column) {
      const columnName = column.Field;
      return {
        id: `${columnName}${this.table}`,
        summary: columnName,
        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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

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.

Connecting to Restricted Databases

Either enable the shared static IP for this account below, or configure a VPC to deploy any workflow in your workspace to a private network with a dedicated static IP. Learn more in our docs.

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#

Run Model on Summit

Description:Executes a model within Summit and captures the response fields. [See the documentation](https://summit.readme.io/reference/model-api)

Version:0.0.1

Key:summit-run-model

View on GitHub

Action Code#

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

export default {
  key: "summit-run-model",
  name: "Run Model",
  description: "Executes a model within Summit and captures the response fields. [See the documentation](https://summit.readme.io/reference/model-api)",
  version: "0.0.1",
  type: "action",
  props: {
    summit,
    model: {
      propDefinition: [
        summit,
        "model",
      ],
      reloadProps: true,
    },
    experimentalFlatten: {
      type: "integer",
      label: "Experimental Flatten",
      description: "This allows you to choose the index of the column you'd like to pull from the grid. -1 is the last column, which is useful for grabbing the last slice of a time series model, like a forecast.",
      optional: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (!this.model) {
      return props;
    }
    const { parameters } = await this.summit.getModel({
      model: this.model,
    });
    for (const parameter of parameters) {
      props[parameter.name] = {
        type: "string",
        label: `${parameter.name}`,
        default: `${parameter.default_value}`,
      };
      if (parameter.value_choices) {
        props[parameter.name].options = parameter.value_choices;
      }
    }
    return props;
  },
  async run({ $ }) {
    const { parameters } = await this.summit.getModel({
      model: this.model,
    });
    const parametersObj = {};
    for (const parameter of parameters) {
      parametersObj[parameter.name] = this[parameter.name];
    }
    const data = {
      parameters: parametersObj,
    };
    if (this.experimentalFlatten !== undefined) {
      data.output = {
        "__experimental_flatten": this.experimentalFlatten,
      };
    }
    const response = await this.summit.runModel({
      $,
      model: this.model,
      data,
    });
    $.export("$summary", `Successfully executed model \`${(this.model).split("/").pop()}\``);
    return response;
  },
};

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
Summit	`summit`	`app`	This component uses the Summit app.
Model	`model`	`string`	Select a value from the drop down menu.
Experimental Flatten	`experimentalFlatten`	`integer`	This allows you to choose the index of the column you'd like to pull from the grid. -1 is the last column, which is useful for grabbing the last slice of a time series model, like a forecast.