Breadcrumbs

MySQL - Upload File to Table from Workflows

Overview

Upload one or more CSV files to any table in MySQL. With the file data, you can: - Append Data - Add the contents of your file to the end of the table. - Replace Data - Write over the entire contents of table with the contents of your file. - Column names are inferred from the header row of your CSV file. Column names must not be null or be duplicate values.

If the table already exists, the header values are matched to the table column names. The header names must match the existing column names in your table, otherwise the Vessel will error.

Data is inserted into the table by using multiple INSERT statements.

In all instances, if the table name does not already exist, a new table will be created with datatypes inferred from the CSV contents.

Note: This Vessel cannot be used to upload a local file from your computer.

Recommended Setup:

  1. A Vessel built with this Blueprint should typically run after a Vessel that either downloads a file to Workflows or generates a file with code.

Variables

Name

Reference

Type

Required

Default

Options

Description

Host

MYSQL_HOST

Alphanumeric

None

-

The domain or the IP address of the database you want to connect to.

Port

MYSQL_PORT

Integer

3306

-

Number for the database port to connect to. Defaults to 3306.

Username

MYSQL_USERNAME

Alphanumeric

None

-

Name of the user to connect to the database with.

Password

MYSQL_PASSWORD

Password

None

-

Password associated to the provided username.

Database

MYSQL_DATABASE

Alphanumeric

None

-

Name of the database in MySQL to connect to.

Extra URL Parameters

MYSQL_URL_PARAMETERS

Alphanumeric

None

-

Extra parameters that will be placed at the end of the connection string, after the "?". Must be separated by "&".

Workflows Folder Name

MYSQL_SOURCE_FOLDER_NAME

Alphanumeric

None

-

Folder where the file to upload can be found. If left blank, will search in the current working directory.

Workflows File Name Match Type

MYSQL_SOURCE_FILE_NAME_MATCH_TYPE

Select

exact_match

Exact Match: exact_match

Regex Match: regex_match

Determines if the text in "File Name" will match exactly to a single file, or use regex to match to multiple files.

Workflows File Name

MYSQL_SOURCE_FILE_NAME

Alphanumeric

None

-

The file name that contains the data you want uploaded.

Table Name

MYSQL_TABLE_NAME

Alphanumeric

None

-

Name of the table where you want data inserted. If the table doesn't already exist, it will be created.

Insertion Method

MYSQL_INSERT_METHOD

Select

append

Append Data: append

Replace Data: replace

Determines how the data in your file will be added into the target table.

YAML

Below is the YAML template

YAML

source:
  template: MySQL - Upload File to Table from Workflows
  inputs:
    MYSQL_HOST:
    MYSQL_PORT: '3306'
    MYSQL_USERNAME:
    MYSQL_PASSWORD:
    MYSQL_DATABASE:
    MYSQL_URL_PARAMETERS:
    MYSQL_SOURCE_FOLDER_NAME:
    MYSQL_SOURCE_FILE_NAME_MATCH_TYPE: exact_match
    MYSQL_SOURCE_FILE_NAME:
    MYSQL_TABLE_NAME:
    MYSQL_INSERT_METHOD: append
  type: TEMPLATE
guardrails:
  retry_count: 1
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - 101
    - 102
    - 200
    - 210
    - 212
    - 220
    - 221
    - 222
    - 249