ODBC SQL

ODBC SQL (sql-odbc)

Execute parameterised statements against relational databases over ODBC.

Database json

Minimal example

output:
  sql-odbc:
    connection:
      url:
        url: ""

JSON

{
  "output": {
    "sql-odbc": {
      "connection": {
        "url": {
          "url": ""
        }
      }
    }
  }
}

Contents

• Minimal example

• Connection

• Processing

• Reliability

• Result

• Statement

• Transaction

• Schema

Connection

Connection

Field	Type	Required	Description
connection	Connection	✅	Connection details for the target database. Allowed values: url, parts

Processing

Processing

Field	Type	Required	Description
batch	Batch		Logical batching hints shared with other outputs.

Reliability

Reliability

Field	Type	Required	Description
retry	Retry		Retry policy for failed executions.

Result

Result

Field	Type	Required	Description
result-field	field (string)		Event field updated with statement scalar results. Examples: data_field
affected-rows-field	field (string)		Event field populated with affected row counts. Examples: data_field

Statement

Statement

Field	Type	Required	Description
statement	multiline-text (string)		Inline SQL statement executed when statement-file is not provided.
statement-file	path (string)		Path to a SQL file executed when statement is not provided. Examples: /path/to/file, c:\users\joe\data\file.txt
parameters	Parameters[]		Bindings that map event fields into parameter placeholders.

Transaction

Transaction

Field	Type	Required	Description
transaction	Transaction		Optional transaction scope applied per execution.

Schema

• Connection Options
• Connection - Url Fields
• Connection - Parts - Tuning Fields
• Connection - Parts Fields
• Batch Fields
• Retry Fields
• Parameters Fields
• Transaction Fields
• Batch - Mode Options
• Transaction - Mode Options

Connection Options

Option	Name	Type	Description
url	Url	object
parts	Parts	object

Connection - Url Fields

Field	Type	Required	Description
url	url (string)	✅	Database connection URL (sqlx/ODBC compatible). Examples: https://example.com/path
max-connections	number (integer)		Maximum size of the async connection pool. Examples: 42, 1.2e-10
min-connections	number (integer)		Minimum number of connections retained in the pool. Examples: 42, 1.2e-10
connect-timeout	string		Optional connection timeout (humantime duration string).
idle-timeout	string		Optional idle timeout (humantime duration string).
schema	string		Optional schema override applied after connect.
options	string[]		Statements executed after connect (e.g. SET search_path TO …).
disable-tls-verification ✓	boolean (bool)		Skip TLS verification (development only). Default: false

Connection - Parts - Tuning Fields

Field	Type	Required	Description
max-connections	number (integer)		Maximum size of the async connection pool. Examples: 42, 1.2e-10
min-connections	number (integer)		Minimum number of connections retained in the pool. Examples: 42, 1.2e-10
connect-timeout	string		Optional connection timeout (humantime duration string).
idle-timeout	string		Optional idle timeout (humantime duration string).
schema	string		Optional schema override applied after connect.
options	string[]		Statements executed after connect (e.g. SET search_path TO …).
disable-tls-verification ✓	boolean (bool)		Skip TLS verification (development only). Default: false

Connection - Parts Fields

Field	Type	Required	Description
tuning	Tuning	✅
connection-string	string	✅	ODBC connection string (translated to odbc:<connection-string>).

Batch Fields

Field	Type	Required	Description
fixed-size ✓	number (integer)		maximum number of events in an output batch. Examples: 42, 1.2e-10
mode	Mode	✅	If ‘document’ send on end of document generated by input. If ‘fixed’, use fixed_size. Allowed values: fixed, document
timeout	time-interval (string)	✅	interval after which the batch is sent, to keep throughput going (default 100ms). Default: 100ms Examples: 500ms, 2h
header	multiline-text (string)		put a header line before the batch.
footer	multiline-text (string)		put a header line after the last line of the batch.
use-document-marker ✓	boolean (bool)		Enrich the job metadata with a document marker (for document handling in batch mode). Default: false
wrap-as-json ✓	boolean (bool)		Format the output batch as a JSON array. Default: false

Retry Fields

Field	Type	Required	Description
timeout	time-interval (string)	✅	timeout (e.g. 500ms, 2s etc. - default is 30). Examples: 500ms, 2h
retries	number (integer)		number of retries. Examples: 42, 1.2e-10

Parameters Fields

Field	Type	Required	Description
name	string	✅
field	string	✅
default	multiline-text (string)

Transaction Fields

Field	Type	Required	Description
mode	Mode		Allowed values: none, per-event, per-batch, document
isolation-level	string
access-mode	string
deferrable	boolean (bool)

Batch - Mode Options

Value	Name	Description
fixed	fixed	Fixed
document	document	Document

Transaction - Mode Options

Value	Name	Description
none	none	None
per-event	per-event	Per Event
per-batch	per-batch	Per Batch
document	document	Document