SQL Server List Tables¶
Lists all tables available within a specified SQL Server schema. Uses a provided database URI to connect via the configured SQL Server data connector and returns both a readable list and a JSON payload. Designed for discovery and inspection of database structures.
Usage¶
Use this node when you need to enumerate tables in a given schema before querying or building downstream data workflows. Typical flow: provide a valid SQL Server connection URI, specify the schema (defaults to dbo), optionally adjust the timeout, and pass the outputs to selection or documentation steps.
Inputs¶
| Field | Required | Type | Description | Example |
|---|---|---|---|---|
| credentials_path | True | STRING | A SQL Server connection URI used to connect to the database. | mssql://sa: |
| timeout | True | INT | Request timeout in seconds for the database operation. | 60 |
| schema | True | STRING | The database schema to list tables from. | dbo |
Outputs¶
| Field | Type | Description | Example |
|---|---|---|---|
| result | STRING | Human-readable summary of tables found in the schema. | Tables in schema 'dbo' (3 tables): - users - orders - products |
| json_result | STRING | JSON string with the raw service response, typically including an array of table names under 'tables'. | {"tables": ["users", "orders", "products"]} |
| html_table | STRING | HTML representation. For this operation, this field is typically empty. | |
| xlsx_data | STRING | Base64-encoded XLSX content. For this operation, this field is typically empty. | |
| pdf_data | STRING | Base64-encoded PDF content. For this operation, this field is typically empty. |
Important Notes¶
- The credentials_path must be a valid database URI and should start with mssql:// or sqlserver://.
- If the target schema has no tables, the node returns a clear 'No tables found' message and an empty list in JSON.
- The schema input defaults to 'dbo' if not changed.
- Timeout is in seconds and applies to the request made to the data connector service.
- Ensure your user has permissions to read metadata for the specified schema; insufficient privileges may result in errors or empty results.
- If using username/password in the URI, never include real secrets in shared documents; use placeholders like
.
Troubleshooting¶
- Invalid credentials URI: Ensure the URI format is correct, e.g., mssql://user:
@host:1433/database. - Service not configured: If you encounter a 'Service URL is not configured' error, verify that the SQL Server data connector endpoint is set up in your environment.
- Authentication or permission errors: Confirm the provided credentials have rights to access the database and read schema metadata.
- Connection/timeout issues: Increase the timeout value or check network connectivity and firewall settings to the SQL Server and connector service.
- Empty result: Confirm the schema name is correct and that tables exist; also verify the user’s permissions on that schema.