MSSQL Query

Runs SQL queries against Microsoft SQL Server. Returns results as Arrow RecordBatch.

Configuration

- mssql_query:
    name: get_orders
    credentials_path: /etc/mssql/credentials.json
    query: "SELECT * FROM orders WHERE date = @p1"
    parameters:
      - "{{event.data.date}}"
    batch_size: 5000

Fields

FieldTypeDefaultDescription
namestringrequiredTask name.
credentials_pathstringrequiredPath to SQL Server credentials file.
querystring/resourcerequiredSQL query. Supports templating and resource files.
parameterslistQuery parameters (@p1, @p2, etc.).
batch_sizeint10000Rows per Arrow RecordBatch.
max_connectionsint10Connection pool size.
connection_timeoutduration30sConnection timeout.
query_timeoutduration2mQuery execution timeout.
depends_onlistUpstream task names.
retryobjectRetry configuration.

Credentials file

{
  "host": "sql-server.example.com",
  "port": 1433,
  "database": "mydb",
  "username": "user",
  "password": "pass",
  "trust_server_certificate": false,
  "encrypt": true
}