Overview
Execute any SQL query against a Microsoft SQL Server database, without returning any of the resulting data. This Template should primarily be used for queries that perform functionality other than SELECT, like multi-step SQL jobs, or DML statements.
Variables
|
Name |
Reference |
Type |
Required |
Default |
Options |
Description |
|---|---|---|---|---|---|---|
|
Host |
MSSQL_HOST |
Alphanumeric |
✅ |
None |
- |
The domain or the IP address of the database you want to connect to. |
|
Port |
MSSQL_PORT |
Integer |
✅ |
1433 |
- |
Number for the database port to connect to. Defaults to 1433. |
|
Username |
MSSQL_USERNAME |
Alphanumeric |
✅ |
None |
- |
Name of the user to connect to the database with. |
|
Password |
MSSQL_PASSWORD |
Password |
➖ |
None |
- |
Password associated to the provided username. |
|
Database |
MSSQL_DATABASE |
Alphanumeric |
✅ |
None |
- |
Name of the database in the Microsoft SQL Server to connect to. |
|
Extra URL Parameters |
MSSQL_URL_PARAMETERS |
Alphanumeric |
➖ |
None |
- |
Extra parameters that will be placed at the end of the connection string, after the "?". Must be separated by "&" |
|
Query |
MSSQL_QUERY |
Alphanumeric |
✅ |
None |
- |
Any SQL query that runs a job against the database (CREATE, DROP, INSERT, etc.). Formatting is ignored. |
YAML
Below is the YAML template
source:
template: Microsoft SQL Server - Execute Query
inputs:
MSSQL_HOST:
MSSQL_PORT: '1433'
MSSQL_USERNAME:
MSSQL_PASSWORD:
MSSQL_DATABASE:
MSSQL_URL_PARAMETERS:
MSSQL_QUERY:
type: TEMPLATE
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- 101
- 102
- 103
- 103
- 105
- 10
- 11
- 14