SQL Server Table Info¶
Retrieves structural metadata for a specific Microsoft SQL Server table. Returns a concise summary and machine‑readable details such as column names, data types, nullability, and related table properties. Designed to help you quickly inspect schemas before building queries or pipelines.
Usage¶
Use this node when you need to understand a table’s structure before querying or transforming data. Typical workflow: provide credentials, pick a schema (often 'dbo'), specify the table name, run to get columns and types, then feed the results into downstream nodes (e.g., query builders, validators, or data mapping steps).
Inputs¶
| Field | Required | Type | Description | Example |
|---|---|---|---|---|
| credentials_path | True | STRING | Path or reference to stored MSSQL credentials that the node will use to authenticate. | |
| timeout | False | INT | Maximum time in seconds to wait for the operation before timing out. | 60 |
| table_name | True | STRING | Name of the SQL Server table to inspect. | users |
| schema | True | STRING | Database schema containing the table. Defaults to 'dbo' if unsure. | dbo |
Outputs¶
| Field | Type | Description | Example |
|---|---|---|---|
| text | STRING | Human‑readable summary of the table (e.g., number of columns, key columns, and data types). | Table 'dbo.users' has 8 columns. Primary key: id. Notable columns: email (VARCHAR(255), NOT NULL), created_at (DATETIME). |
| json | JSON | Raw metadata for the table, including columns, data types, nullability, default values, and other properties. | {"table":"users","schema":"dbo","columns":[{"name":"id","type":"INT","nullable":false,"is_primary_key":true},{"name":"email","type":"VARCHAR(255)","nullable":false}]} |
| table | DATAFRAME | Tabular representation of the table’s columns and properties for easy downstream processing. | A table-like structure with columns: [name, type, nullable, default, is_primary_key]. |
Important Notes¶
- Ensure your credentials grant metadata access to the specified schema and table.
- If the schema is omitted or incorrect, the node may not find the table. Use 'dbo' when in doubt.
- Large or complex schemas can increase response time; adjust the timeout accordingly.
- This node does not read actual row data; it only returns schema/metadata details.
Troubleshooting¶
- Table not found: Verify schema and table_name are correct and exist in the target database.
- Authentication failed: Confirm the credentials file is valid and has permission to access the database metadata.
- Timeouts: Increase the timeout input and confirm network connectivity to the SQL Server instance.
- Empty or partial metadata: Ensure the account has sufficient privileges (VIEW DEFINITION or equivalent) on the schema/table.