sqlserver source 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

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.11.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:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

Camel K Environment Usage

This section describes how you can use the sqlserver-source.

Knative source

You can use the sqlserver-source Kamelet as a Knative source by binding it to a Knative object.

sqlserver-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: sqlserver-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: sqlserver-source
    properties:
      databaseName: The Database Name
      password: The Password
      query: INSERT INTO accounts (username,city) VALUES (:#username,:#city)
      serverName: localhost
      username: The Username
  sink:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the sqlserver-source-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f sqlserver-source-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind channel:mychannel -p "source.databaseName=The Database Name" -p "source.password=The Password" -p "source.query=INSERT INTO accounts (username,city) VALUES (:#username,:#city)" -p "source.serverName=localhost" -p "source.username=The Username" sqlserver-source

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kafka source

You can use the sqlserver-source Kamelet as a Kafka source by binding it to a Kafka topic.

sqlserver-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: sqlserver-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: sqlserver-source
    properties:
      databaseName: The Database Name
      password: The Password
      query: INSERT INTO accounts (username,city) VALUES (:#username,:#city)
      serverName: localhost
      username: The Username
  sink:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic

Prerequisites

  • You’ve installed Strimzi.

  • You’ve created a topic named my-topic in the current namespace.

  • You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the sqlserver-source-pipe.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the source by using the following command:

    kubectl apply -f sqlserver-source-pipe.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic -p "source.databaseName=The Database Name" -p "source.password=The Password" -p "source.query=INSERT INTO accounts (username,city) VALUES (:#username,:#city)" -p "source.serverName=localhost" -p "source.username=The Username" sqlserver-source

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kamelet source file

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

Back to top