V2

MySql

Provides integration with a MySQL Database.

Revision History

0.0.0.2 - Initial release.
0.0.0.3 - Template fixes.
0.0.0.7 - Fix attributes.

Connection

Parameter Type Description
Server String The name or IP address of the server hosting the MySQL instance.
Database String The name of the database to connect to.
Username String The MySQL username to be used for the connection.
Password Masked The MySQL password to be used for the connection.
UseSSH Boolean Whether to connect through an SSH tunnel. Default is false.
SSHServer String The SSH server used to establish the tunnel.
SSHPort Integer The SSH server port. Default is 22.
DatabasePort Integer The MySQL database port. Default is 3306.
SSHUsername String The SSH username.
SSHPassword Masked The SSH password used when key authentication is not provided.
SSHKeyFile String The SSH private key contents used for key authentication.
SSHKeyFilePassPhrase Masked The pass phrase for the SSH private key.
ConnectionTimeout Integer The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error. Default is 15 seconds.

Methods

Query

Executes a query against a MySQL Server database and returns the results.

Parameter Type Notes
Connection Connection The connection profile for the MySql Database.
Query String The SQL query to execute.
Return Type Notes
Items Array Output from Query.

Upsert

Upserts data to a MySQL Server database table.

Parameter Type Notes
Connection Connection The connection profile for the MySql Database.
TableName String The name of the table to upsert.
KeyFields String The primary keys used to identity which records to update.
Items Array The items to upsert.
BatchSize Integer Number of rows to upsert per batch. Default is 100.
Return Type Notes
RowsAffected Integer The amount of rows that were affected by the Upsert statement.

Known Issues

  • Listen method not implemented yet.