Microsoft SQL Server Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Query data from a Microsoft SQL Server Database.

In your Pipe file, you must explicitly declare the SQL Server driver dependency in spec→integration→dependencies

"mvn:com.microsoft.sqlserver:mssql-jdbc:<version>"

Configuration Options

The following table summarizes the configuration options available for the sqlserver-source Kamelet:

Property	Name	Description	Type	Default	Example
databaseName	Database Name	Required The name of the Database.	string
password	Password	Required The password to access a secured SQL Server Database.	string
query	Query	Required The query to execute against the SQL Server Database.	string		INSERT INTO accounts (username,city) VALUES (:#username,:#city)
serverName	Server Name	Required The server name for the data source.	string		localhost
username	Username	Required The username to access a secured SQL Server Database.	string
consumedQuery	Consumed Query	A query to run on a tuple consumed.	string		DELETE FROM accounts where user_id = :#user_id
delay	Delay	The number of milliseconds before the next poll.	integer	500
encrypt	Encrypt Connection	Encrypt the connection to SQL Server.	boolean	false
serverPort	Server Port	The server port for the data source.	string	1433
trustServerCertificate	Trust Server Certificate	Trust Server Certificate.	boolean	true

Property

Name

Description

Type

Default

Example

databaseName

Database Name

Required The name of the Database.

string

password

Password

Required The password to access a secured SQL Server Database.

string

query

Query

Required The query to execute against the SQL Server Database.

string

INSERT INTO accounts (username,city) VALUES (:#username,:#city)

serverName

Server Name

Required The server name for the data source.

string

localhost

username

Username

Required The username to access a secured SQL Server Database.

string

consumedQuery

Consumed Query

A query to run on a tuple consumed.

string

DELETE FROM accounts where user_id = :#user_id

delay

Delay

The number of milliseconds before the next poll.

integer

500

encrypt

Encrypt Connection

Encrypt the connection to SQL Server.

boolean

false

serverPort

Server Port

The server port for the data source.

string

1433

trustServerCertificate

Trust Server Certificate

Trust Server Certificate.

boolean

true

Dependencies

At runtime, the sqlserver-source Kamelet relies upon the presence of the following dependencies:

camel:jackson
camel:kamelet
camel:sql
mvn:org.apache.commons:commons-dbcp2:2.12.0

Camel JBang usage

Prerequisites

You’ve installed JBang.
You have executed the following command:

jbang app install camel@apache/camel

Supposing you have a file named route.yaml with this content:

- route:
    from:
      uri: "kamelet:sqlserver-source"
      parameters:
        .
        .
        .
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/sqlserver-source.kamelet.yaml