MySQL List Tables¶
Lists all tables available in a specified MySQL database using configured credentials. Returns a human-readable summary and a JSON payload, with optional HTML, XLSX, and PDF formatted outputs for downstream reporting or visualization.
Usage¶
Use this node when you need to explore schema structure or drive UI pickers by enumerating tables in a MySQL database. Typical workflows include running it before table info or query nodes to help users select a table, or exporting the table list for documentation and audits.
Inputs¶
| Field | Required | Type | Description | Example |
|---|---|---|---|---|
| credentials_path | True | STRING | Path or reference to stored MySQL credentials that include connection details and authentication. | /connections/mysql/prod.json |
| timeout | True | INT | Maximum time in seconds to wait for the operation before timing out. | 30 |
| database | True | STRING | The MySQL database name to list tables from. | analytics_db |
Outputs¶
| Field | Type | Description | Example |
|---|---|---|---|
| text | STRING | Plain-text summary of the tables found in the specified database. | Tables in Database: analytics_db - users - events - sessions |
| json | STRING | JSON string containing the raw result of the list tables operation. | {"data": [{"table_name": "users"}, {"table_name": "events"}]} |
| html | STRING | HTML representation (e.g., a table) of the listed tables for embedding in dashboards or reports. May be empty if not generated. | Tables in Database: analytics_db |
| xlsx | BYTES | Binary XLSX data containing the table list for download or archival. May be empty if not generated. | |
| BYTES | Binary PDF data with the table list formatted for printing/sharing. May be empty if not generated. |
Important Notes¶
- Credentials required: The node uses the MySQL credential template and must have valid host, port, database, and auth to access metadata.
- Permissions matter: The connected user must have privileges to read schema metadata; otherwise results may be empty or partial.
- Database parameter: Defaults may point to 'mysql', but set the target application database explicitly to get relevant tables.
- Timeouts: Large schemas or slow networks may require increasing the timeout to avoid premature failures.
- Output formats: The node always returns text and JSON; HTML/XLSX/PDF outputs may be empty unless specifically produced by the underlying formatter.
Troubleshooting¶
- Authentication error: Verify the credentials_path points to valid MySQL credentials and that the username/password are correct.
- Unknown database: Ensure the 'database' value exists on the target server and matches case/quoting rules.
- Empty results: Confirm the user has metadata access (e.g., to information_schema) and that the database actually contains tables.
- Network timeout: Increase the 'timeout' value or check network/firewall restrictions between the node runtime and the MySQL server.
- Intermittent failures: Check server load and connection limits; reduce concurrent requests or retry with backoff.