MySQL Table Info¶
Retrieves structural information for a specified MySQL table. Returns a human-readable summary along with a JSON payload that typically includes columns, data types, nullability, and other metadata. Uses provided credentials to connect and queries a backend service for the table details.
Usage¶
Use this node when you need to inspect the schema of a table before writing queries or building data pipelines. Commonly placed early in a workflow to validate column names, data types, and keys prior to running queries or transformations.
Inputs¶
| Field | Required | Type | Description | Example |
|---|---|---|---|---|
| credentials_path | True | STRING | Path or reference to the stored MySQL credentials to authenticate the request. | /configs/credentials/mysql.json |
| timeout | True | INT | Maximum time in seconds to wait for the operation before it times out. | 60 |
| table_name | True | STRING | Name of the MySQL table to retrieve metadata for. | users |
| database | True | STRING | MySQL database (schema) containing the table. | analytics_db |
Outputs¶
| Field | Type | Description | Example |
|---|---|---|---|
| text | STRING | A readable summary of the table information, suitable for logs or quick inspection. | Table Info: analytics_db.users - id (INT, NOT NULL) - email (VARCHAR(255), NULL) - created_at (DATETIME, NOT NULL) ... |
| json | STRING | JSON string containing the raw table metadata returned by the service (columns, types, and related attributes). | {"columns": [{"name": "id", "type": "INT", "nullable": false}, {"name": "email", "type": "VARCHAR(255)", "nullable": true}]} |
| html | STRING | HTML content (if provided for this operation). For this node it is typically empty. | |
| xlsx | BYTES | Binary Excel data (if provided for this operation). For this node it is typically empty. | |
| BYTES | Binary PDF data (if provided for this operation). For this node it is typically empty. |
Important Notes¶
- Credentials required: Ensure the credentials_path points to valid MySQL credentials; the node will load and use them before making the request.
- Database and table must exist: The specified database and table_name must be accessible by the provided user.
- Timeouts: Operations that exceed the provided timeout will fail; increase the timeout for large or slow databases.
- Result formats: The text and JSON outputs are the primary outputs for this node; other formats (HTML/XLSX/PDF) will generally be empty for this operation.
- Service interaction: The node relies on a backend service endpoint for table metadata; network connectivity is required.
Troubleshooting¶
- Authentication error: Verify credentials_path points to a valid file/reference and the credentials are correct.
- Table not found: Confirm table_name is correct and exists in the specified database. Check for typos or case sensitivity.
- Insufficient privileges: Ensure the database user has rights to read metadata for the target table.
- Network or timeout issues: Increase the timeout input and verify network connectivity to the database service.
- Malformed output parsing: If JSON output cannot be parsed downstream, inspect the raw json output field for error messages from the service.