MySQL Table Info¶
Retrieves schema details for a specified MySQL table. Returns a human-readable summary and a JSON payload describing the table (e.g., columns, data types, and other available metadata). Uses provided database credentials and honors a configurable timeout.
Usage¶
Use this node when you need to inspect the structure of a MySQL table before querying, building joins, or validating data assumptions. Commonly placed early in a workflow to explore available columns and metadata for downstream query or transformation nodes.
Inputs¶
| Field | Required | Type | Description | Example |
|---|---|---|---|---|
| credentials_path | True | STRING | Database connection URI for MySQL. The node uses this to authenticate and connect. | mysql:// |
| timeout | True | INT | Maximum time in seconds to wait for the operation before failing. | 60 |
| table_name | True | STRING | Name of the table to describe. | users |
| database | True | STRING | Target database/schema containing the table. | mysql |
Outputs¶
| Field | Type | Description | Example |
|---|---|---|---|
| result | STRING | Readable summary of the table information, suitable for logs or quick review. | Table Info: sales_db.users Columns: - id (INT) - email (VARCHAR) - created_at (DATETIME) ... |
| json_result | STRING | JSON string containing the detailed table metadata returned by the service. | {"data": [{"column":"id","type":"INT","nullable":false},{"column":"email","type":"VARCHAR(255)","nullable":false}]} |
| html_table | STRING | HTML representation of results when available; for this operation it is typically empty. | |
| xlsx_data | STRING | Base64-encoded XLSX content when applicable; for this operation it is typically empty. | |
| pdf_data | STRING | Base64-encoded PDF content when applicable; for this operation it is typically empty. |
Important Notes¶
- Credentials URI required: You must provide a valid MySQL URI in credentials_path (e.g., "mysql://
: @ : / "). - Read-only operation: This node fetches metadata only; it does not modify data.
- Permissions matter: The connected user must have privileges to read metadata for the specified database/table.
- Timeout handling: Long-running metadata calls will fail if they exceed the specified timeout.
- Output formats: This node primarily returns text and JSON; HTML/XLSX/PDF outputs are typically empty for table info.
Troubleshooting¶
- Authentication failed or invalid URI: Verify credentials_path format and values. Ensure the user, password, host, port, and database are correct.
- Table not found: Confirm table_name and database are correct and that the table exists.
- Insufficient privileges: Ensure the user has permissions to access information_schema and the target table metadata.
- Request timed out: Increase the timeout input if the database is slow or under load, or optimize network connectivity.
- Malformed JSON in output: If downstream nodes parse json_result, ensure they parse it as a JSON string and handle empty/non-standard fields gracefully.