SQL Server Table Info¶
Retrieves metadata for a specific Microsoft SQL Server table, including column names, data types, nullability, and common constraints. It formats a concise, readable summary and also returns the raw JSON metadata.
Usage¶
Use this node when you need to inspect the structure of a SQL Server table before building queries or performing data operations. Typical workflow: provide a valid SQL Server connection URI, specify the schema and table name, then connect its outputs to documentation, validation, or query-building steps.
Inputs¶
| Field | Required | Type | Description | Example |
|---|---|---|---|---|
| credentials_path | True | STRING | SQL Server connection URI containing host, port, database, and credentials. | mssql://username: |
| timeout | True | INT | Request timeout in seconds for the database service call. | 60 |
| table_name | True | STRING | The table name to describe. | users |
| schema | True | STRING | The database schema where the table resides. | dbo |
Outputs¶
| Field | Type | Description | Example |
|---|---|---|---|
| result | STRING | Human-readable table structure summary, listing columns with data types and attributes. | Table: dbo.users Column: id \| Type: INT \| Nullable: NO \| Precision: 10 \| Default: IDENTITY(1,1) Column: email \| Type: VARCHAR \| Nullable: NO \| Max Length: 255 ... |
| json_result | STRING | Raw JSON string with table metadata (columns and their properties). | {"columns": [{"column_name": "id", "data_type": "int", "is_nullable": "NO", "column_default": "identity(1,1)"}, {"column_name": "email", "data_type": "varchar", "is_nullable": "NO", "character_maximum_length": 255}]} |
Important Notes¶
- Ensure the credentials_path is a valid SQL Server URI (e.g., mssql://user:
@host:1433/database). - Schema is required; if unsure, use "dbo" which is the common default schema in SQL Server.
- This node returns table metadata only; it does not return table rows.
- If using Windows Integrated Security, include the appropriate parameter in the URI (e.g., mssql://host:1433/database?integrated_security=true).
- Network and service endpoint configuration must be set up beforehand; the node calls a configured database service endpoint.
Troubleshooting¶
- Invalid credentials URI: Verify the URI format and that it begins with mssql:// or sqlserver:// and includes required parts (host, port, database).
- Authentication failed: Check username/password or integrated_security settings in the URI.
- Table not found: Confirm the schema and table_name are correct and the user has permissions to access them.
- Schema not found: Ensure the provided schema exists in the target database.
- Timeout or connection error: Increase the timeout value and verify network connectivity and service endpoint availability.
- Empty or unexpected metadata: Confirm the connected service supports metadata retrieval for the target database and that your user has metadata inspection privileges.