SQL Server List Tables¶
Lists all table names within a specified SQL Server schema. It uses provided MSSQL connection details to contact the database service and returns both a readable summary and a JSON payload containing the tables.
Usage¶
Use this node to explore or validate what tables exist in a given schema before running queries or building downstream workflows. Provide a valid MSSQL connection URI and the schema name (e.g., dbo). You can construct the URI manually or by using the SQL Server Connection String node, then feed it here.
Inputs¶
| Field | Required | Type | Description | Example |
|---|---|---|---|---|
| credentials_path | True | STRING | MSSQL connection URI containing host, port, database, and authentication details. | mssql://sa: |
| timeout | True | INT | Maximum time in seconds to wait for the operation to complete. | 60 |
| schema | True | STRING | Database schema name to list tables from. | dbo |
Outputs¶
| Field | Type | Description | Example |
|---|---|---|---|
| result | STRING | Human-readable list of tables found in the specified schema. | Tables in schema 'dbo' (3 tables): - users - orders - products |
| json_result | STRING | JSON string containing raw results, typically including an array of table names under the 'tables' key. | {"tables": ["users", "orders", "products"]} |
Important Notes¶
- Credentials URI required: The credentials_path must be a valid database URI (e.g., mssql://user:
@host:port/database). - Schema scope: Only tables within the specified schema are listed.
- Service configuration: Requires the SQL Server data connector service endpoint to be configured in the environment.
- Timeout bounds: Typical allowed range is 10–300 seconds; adjust based on network and database load.
- Security: Do not hardcode real passwords in workflows; use secure storage or a separate node to assemble the connection string.
Troubleshooting¶
- Invalid credentials URI: If you see an error about an invalid URI, ensure the format is correct (scheme, host, port, database, and credentials).
- No tables returned: Verify the schema name is correct and that the database contains tables in that schema.
- Connection failures: Check network connectivity, firewall rules, and that the MSSQL service is reachable from the runtime environment.
- Service URL not configured: If you get a service URL configuration error, ensure the SQL Server data connector endpoint is set in the platform settings.
- Timeouts: Increase the timeout value if the database is slow or the schema contains a very large number of tables.