Skip to main content

MySQL - Download Query Results to Platform

Overview​

Turn the results of your SQL SELECT statement into a CSV file. Extract your MySQL data into files for easier delivery to clients and partners.

Variables​

NameReferenceTypeRequiredDefaultOptionsDescription
HostMYSQL_HOSTAlphanumericβœ…--The domain or the IP address of the database you want to connect to.
PortMYSQL_PORTIntegerβœ…"3306"-Number for the database port to connect to. Defaults to 3306.
UsernameMYSQL_USERNAMEAlphanumericβœ…--Name of the user to connect to the database with.
PasswordMYSQL_PASSWORDPasswordβž–--Password associated to the provided username.
DatabaseMYSQL_DATABASEAlphanumericβœ…--Name of the database in MySQL to connect to.
Extra URL ParametersMYSQL_URL_PARAMETERSAlphanumericβž–--Extra parameters that will be placed at the end of the connection string, after the "?". Must be separated by "&".
QueryMYSQL_QUERYAlphanumericβœ…--A SELECT statement that returns data. Formatting is ignored.
Shipyard Folder NameMYSQL_DESTINATION_FOLDER_NAMEAlphanumericβž–--The folder structure that you want your CSV to be created in. If left blank, the file will be created in the home directory.
Shipyard File NameMYSQL_DESTINATION_FILE_NAMEAlphanumericβœ…output.csv-The file name that you want your generated CSV to have.
Include Column Names as Header?MYSQL_FILE_HEADERBooleanβœ…True-If checked, your CSV file will include a header row with column names.

YAML​

Below is the YAML template for this Blueprint and can be used in the Fleet YAML Editor.

source:
blueprint: MySQL - Download Query Results to Shipyard
inputs:
MYSQL_HOST: null ## REQUIRED
MYSQL_PORT: '3306' ## REQUIRED
MYSQL_USERNAME: null ## REQUIRED
MYSQL_PASSWORD: null
MYSQL_DATABASE: null ## REQUIRED
MYSQL_URL_PARAMETERS: null
MYSQL_QUERY: null ## REQUIRED
MYSQL_DESTINATION_FOLDER_NAME: null
MYSQL_DESTINATION_FILE_NAME: output.csv ## REQUIRED
MYSQL_FILE_HEADER: true ## REQUIRED
type: BLUEPRINT
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- '0'