sqlserver source Microsoft SQL Server Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

Query data from a Microsoft SQL Server Database.

In your KameletBinding file you’ll need to 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

The Database Name we are pointing

string

password *

Password

The password to use for accessing a secured SQL Server Database

string

query *

Query

The Query to execute against the SQL Server Database

string

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

serverName *

Server Name

Server Name for the data source

string

"localhost"

username *

Username

The username to use for accessing 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"

serverPort

Server Port

Server Port for the data source

string

1433

Fields marked with an asterisk (*) are mandatory.

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.8.0

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-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: sqlserver-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      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-binding.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-binding.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind sqlserver-source -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" channel:mychannel

This command creates the KameletBinding 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-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: sqlserver-source-binding
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      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-binding.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-binding.yaml

Procedure for using the Kamel CLI

Configure and run the source by using the following command:

kamel bind sqlserver-source -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" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic

This command creates the KameletBinding in the current namespace on the cluster.