SQL Server Table Info¶
Retrieves detailed metadata for a specific Microsoft SQL Server table. It loads database credentials, queries metadata for the given schema and table, and returns results in multiple output formats (plain text summary and raw JSON, with placeholders for rich formats).
Usage¶
Use this node when you need to inspect the structure of a SQL Server table before writing queries or building data pipelines. Typical workflows include validating column names and types, checking keys and nullability, or documenting a table prior to transformations.
Inputs¶
| Field | Required | Type | Description | Example |
|---|---|---|---|---|
| credentials_path | True | STRING | Path to the stored SQL Server credentials configured for this environment. The node uses these credentials to authenticate. | /workspace/credentials/mssql.json |
| timeout | False | INT | Maximum time in seconds to wait for the database operation before failing. | 60 |
| table_name | True | STRING | The name of the target table to inspect. | users |
| schema | True | STRING | The database schema containing the target table. Defaults to dbo if not specified. | dbo |
Outputs¶
| Field | Type | Description | Example |
|---|---|---|---|
| text | STRING | Human-readable summary of the table information (columns, data types, and other highlights). | Table Info: dbo.users - id: INT, NOT NULL (PK) - email: NVARCHAR(255), NULL - created_at: DATETIME2, NOT NULL |
| json | STRING | Raw JSON payload containing the full metadata response for the table. | {"table":"users","schema":"dbo","columns":[{"name":"id","type":"INT","nullable":false,"primary_key":true},{"name":"email","type":"NVARCHAR(255)","nullable":true}]} |
| html | STRING | HTML representation of the results (may be empty if not generated). | Table Info: dbo.users |
| xlsx | BYTES | Excel (.xlsx) data containing the table info (may be empty if not generated). | |
| BYTES | PDF data containing the table info (may be empty if not generated). |
Important Notes¶
- Default schema is dbo. If your table is under a different schema, set the schema input accordingly.
- Ensure the provided credentials have permission to read metadata for the target schema and table.
- The JSON output contains the most complete representation of metadata; text/HTML are summaries.
- Timeout governs the end-to-end metadata request; increase it for slower networks or large catalogs.
- Never include real secrets in the credentials path file; store them securely and reference the file path only.
Troubleshooting¶
- Table not found: Verify the schema and table_name inputs (including correct casing and spelling).
- Permission denied: Confirm the database user in credentials has rights to read system catalog metadata.
- Connection timeout: Increase the timeout input and check network/firewall connectivity to the SQL Server host.
- Invalid credentials: Re-upload or correct the credentials file at credentials_path and ensure it matches the MSSQL template.
- Empty outputs: Check logs and the JSON output for error details; misconfigured schema or missing permissions commonly cause empty results.