SQL Server Query¶
Executes a SQL SELECT query against a Microsoft SQL Server database using configured credentials. Accepts multiline SQL text and returns the query results. Intended for read-only operations; use the execute variant for INSERT/UPDATE/DELETE.
Usage¶
Use this node when you need to fetch data from a SQL Server database as part of a workflow. Provide a valid credentials reference and a SELECT statement. Typically chained before data processing, filtering, or visualization nodes.
Inputs¶
| Field | Required | Type | Description | Example |
|---|---|---|---|---|
| credentials_path | True | Not specified | Path or reference to stored SQL Server credentials to authenticate the request. | /configs/mssql.json |
| timeout | False | Not specified | Maximum time the operation is allowed to run before it is aborted. | 30 |
| sql_text | True | STRING | A SQL SELECT query to execute against SQL Server. Multiline is supported. | SELECT TOP 10 * FROM users |
Outputs¶
| Field | Type | Description | Example |
|---|---|---|---|
| result | Not specified | Query results returned by the service. Typically includes a human-readable text summary and a structured payload of rows. | Returned 10 rows from users |
Important Notes¶
- Read-only scope: This node is designed for SELECT queries. Use SaltMSSQLExecute for INSERT/UPDATE/DELETE.
- Credentials: Must use a valid SQL Server credential configuration (credential template 'mssql').
- Timeouts: Long-running queries may be terminated by the timeout setting.
- Result size: Very large result sets may be truncated or impact performance; consider adding WHERE, ORDER BY, or TOP.
- SQL safety: Do not include untrusted input directly in SQL to avoid injection risks.
Troubleshooting¶
- Authentication failed: Verify the credentials_path points to a valid SQL Server credential configuration and that permissions allow SELECT on the target tables.
- Connection/Network errors: Ensure the database host, port, and firewall/VPN settings allow connectivity from the runtime environment.
- SQL syntax error: Validate the query in a SQL client; ensure table/column names and schema (e.g., dbo) are correct.
- Timeouts: Increase the timeout input or optimize the query with indexes and filters.
- Empty results: Confirm the query conditions are correct and the target table contains data.