@runnerty/executor-mysql v3.2.0

MySQL executor for Runnerty:

Installation:

Through NPM

npm i @runnerty/executor-mysql

You can also add modules to your project with runnerty

npx runnerty add @runnerty/executor-mysql

This command installs the module in your project, adds example configuration in your config.json and creates an example plan of use.

If you have installed runnerty globally you can include the module with this command:

runnerty add @runnerty/executor-mysql

Configuration:

Add in config.json:

{
  "id": "mysql_default",
  "type": "@runnerty-executor-mysql",
  "user": "mysqlusr",
  "password": "mysqlpass",
  "database": "MYDB",
  "host": "myhost.com",
  "port": "3306"
}

{
  "id": "mysql_default",
  "type": "@runnerty-executor-mysql",
  "user": "mysqlusr",
  "password": "mysqlpass",
  "database": "MYDB",
  "host": "myhost.com",
  "port": "3306",
  "ssl": {
    "ca": "./ssl/my.ca"
  }
}

Configuration params:

Plan sample:

Add in plan.json:

{
  "id": "mysql_default",
  "command_file": "/etc/runnerty/sql/test.sql"
}

{
  "id": "mysql_default",
  "command": "SELECT NOW()"
}

Generation of files:

The saved can be indicated in the file of the results obtained from a query in csv, xlsx and json format. These files will be generated with streams. You only have to indicate the corresponding property in the parameters:

XLSX

XLSX Format

Sample:

{
  "id": "mysql_sample",
  "command": "SELECT * FROM USERS",
  "xlsxFileExport": "./my_output.xlsx",
  "xlsxAuthorName": "Runnerty",
  "xlsxSheetName": "MySheetSample"
}

CSV

CSV Format

Sample:

{
  "id": "mysql_sample",
  "command": "SELECT * FROM USERS",
  "csvFileExport": "@GV(WORK_DIR)/users.csv",
  "csvOptions": {
    "delimiter": ";",
    "quote": "\""
  }
}

JSON

JSON Format

Sample:

{
  "id": "mysql_sample",
  "command": "SELECT * FROM USERS",
  "fileExport": "@GV(WORK_DIR)/users.json"
}

Loading files:

For file upload you must indicate the path of the file to be loaded in the localInFile parameter and in the LOAD DATA LOCAL INFILE statement you must indicate mystream. For example:

• localInFile: Plain file path

{
  "id": "mysql_sample",
  "command": "LOAD DATA LOCAL INFILE 'mystream' INTO TABLE DBSAMPLE.TABLESAMPLE FIELDS TERMINATED BY ',' LINES TERMINATED BY '\n'",
  "localInFile": "/sample.csv"
}

Output (Process values):

Standard

• PROCESS_EXEC_MSG_OUTPUT: MySQL output message.
• PROCESS_EXEC_ERR_OUTPUT: Error output message.

Query output

• PROCESS_EXEC_DATA_OUTPUT: MySQL query output data.
• PROCESS_EXEC_DB_COUNTROWS: MySQL query count rows.
• PROCESS_EXEC_DB_FIRSTROW: MySQL query first row data.
• PROCESS_EXEC_DB_FIRSTROW_[FILED_NAME]: MySQL first row field data.

Operation output

• PROCESS_EXEC_DB_FIELDCOUNT: MySQL field count.
• PROCESS_EXEC_DB_AFFECTEDROWS: MySQL affected rows count.
• PROCESS_EXEC_DB_CHANGEDROWS: MySQL changed rows count.
• PROCESS_EXEC_DB_INSERTID: MySQL insert ID.
• PROCESS_EXEC_DB_WARNINGCOUNT: MySQL warning count.
• PROCESS_EXEC_DB_MESSAGE: MySQL message.