Overview Add MySQL to any ModuleX agent or workflow. MySQL database integration via the aiomysql driver. Provides raw SQL execution + CRUD + stored procedures + introspection.
Categories : Databases · Database · Data Management · Storage · Auth : MySQL Database Credentials · Actions : 9
Authentication MySQL Database Credentials Authenticate using MySQL connection credentials (host/port/user/password/database).
Required Credentials Field Description Required Format Host MySQL server hostname or IP Yes localhost or mysql.example.comPort MySQL server port (defaults to 3306 if omitted) No 3306Username MySQL username for authentication Yes -Password MySQL password for authentication Yes -Database The database name to connect to Yes -SSL Mode SSL mode: ‘disabled’, ‘verify’ (default), or ‘skip_verification’ No `verify skip_verification disabled`
Available Actions
execute_raw_query — Execute any SQL statement. Use '%s' for parameterized queries (DB-API style).
Parameters Values for ‘%s’ placeholders
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "row_count" : { "default" : 0 , "title" : "Row Count" , "type" : "integer" }, "data" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Data" , "type" : "array" } }, "required" : [ "success" ], "title" : "ExecuteRawQueryOutput" , "type" : "object" }
create_row — INSERT a new row (returns affected_rows + last_insert_id)
Parameters Column-value pairs to insert
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "table" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Table" }, "affected_rows" : { "default" : 0 , "title" : "Affected Rows" , "type" : "integer" }, "last_insert_id" : { "anyOf" : [ { "type" : "integer" }, { "type" : "null" } ], "default" : null , "title" : "Last Insert Id" }, "columns" : { "items" : { "type" : "string" }, "title" : "Columns" , "type" : "array" } }, "required" : [ "success" ], "title" : "CreateRowOutput" , "type" : "object" }
delete_row — DELETE rows matching a WHERE condition
Parameters WHERE condition with ’?’ placeholders
Values matching the ’?’ placeholders
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "table" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Table" }, "affected_rows" : { "default" : 0 , "title" : "Affected Rows" , "type" : "integer" } }, "required" : [ "success" ], "title" : "DeleteRowOutput" , "type" : "object" }
update_row — UPDATE rows matching a WHERE condition
Parameters Column-value pairs to update
WHERE condition with ’?’ placeholders
Values matching the ’?’ placeholders
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "table" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Table" }, "affected_rows" : { "default" : 0 , "title" : "Affected Rows" , "type" : "integer" }, "updated_columns" : { "items" : { "type" : "string" }, "title" : "Updated Columns" , "type" : "array" } }, "required" : [ "success" ], "title" : "UpdateRowOutput" , "type" : "object" }
find_row — SELECT * FROM table WHERE column <op> value
Parameters =, >, >=, <, !=, <=, LIKE (Default: =)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "table" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Table" }, "row_count" : { "default" : 0 , "title" : "Row Count" , "type" : "integer" }, "data" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Data" , "type" : "array" } }, "required" : [ "success" ], "title" : "FindRowOutput" , "type" : "object" }
execute_query_with_condition — SELECT * FROM table WHERE <condition>
Parameters WHERE condition with ’?’ placeholders
Values matching the ’?’ placeholders
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "table" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Table" }, "row_count" : { "default" : 0 , "title" : "Row Count" , "type" : "integer" }, "data" : { "items" : { "additionalProperties" : true , "type" : "object" }, "title" : "Data" , "type" : "array" } }, "required" : [ "success" ], "title" : "ExecuteQueryWithConditionOutput" , "type" : "object" }
execute_stored_procedure — CALL <stored_procedure>(...) with optional parameters
Parameters Procedure name (may be qualified ‘db.proc’)
Response { "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "procedure" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Procedure" }, "row_count" : { "default" : 0 , "title" : "Row Count" , "type" : "integer" }, "data" : { "anyOf" : [ { "items" : { "additionalProperties" : true , "type" : "object" }, "type" : "array" }, { "additionalProperties" : true , "type" : "object" }, { "type" : "null" } ], "default" : null , "title" : "Data" } }, "required" : [ "success" ], "title" : "ExecuteStoredProcedureOutput" , "type" : "object" }
list_tables — List all tables and views in the current database
Response { "$defs" : { "TableEntry" : { "additionalProperties" : false , "properties" : { "name" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Name" }, "type" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Type" } }, "title" : "TableEntry" , "type" : "object" } }, "additionalProperties" : false , "properties" : { "success" : { "title" : "Success" , "type" : "boolean" }, "error" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Error" }, "database" : { "anyOf" : [ { "type" : "string" }, { "type" : "null" } ], "default" : null , "title" : "Database" }, "tables" : { "items" : { "$ref" : "#/$defs/TableEntry" }, "title" : "Tables" , "type" : "array" }, "count" : { "default" : 0 , "title" : "Count" , "type" : "integer" } }, "required" : [ "success" ], "title" : "ListTablesOutput" , "type" : "object" }
describe_table — Return column metadata for a table (SHOW COLUMNS)
Limits & Quotas
60s connection timeout.
Connections are not pooled — opened per call, closed via the
context manager.
find_row operator allowlist: =, >, >=, <, !=, <=,
LIKE.aiomysql is imported lazily so the manifest can be inspected
without the driver installed.
Links 
