postgresql source PostgreSQL Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

Query data from a PostgreSQL Database.

Configuration Options

The following table summarizes the configuration options available for the postgresql-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 PostgreSQL Database

string

query *

Query

The Query to execute against the PostgreSQL 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 PostgreSQL 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

5432
Fields marked with (*) are mandatory.

Usage

This section summarizes how the postgresql-source can be used in various contexts.

Knative Source

The postgresql-source Kamelet can be used as Knative source by binding it to a Knative object.

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

Make sure you have Camel K installed into the Kubernetes cluster you’re connected to.

Save the postgresql-source-binding.yaml file into your hard drive, then configure it according to your needs.

You can run the source using the following command:

kubectl apply -f postgresql-source-binding.yaml

Dependencies

The Kamelet needs the following dependencies:

  • camel:jackson

  • camel:kamelet

  • camel:sql

  • mvn:org.postgresql:postgresql:42.2.14

  • mvn:org.apache.commons:commons-dbcp2:2.8.0

Binding to Knative using the Kamel CLI:

The procedure described above can be simplified into a single execution of the kamel bind command:

kamel bind postgresql-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 will create the KameletBinding under the hood and apply it to the current namespace in the cluster.

Kafka Source

The postgresql-source Kamelet can be used as Kafka source by binding it to a Kafka topic.

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

Ensure that you’ve installed Strimzi and created a topic named my-topic in the current namespace. Make also sure you have Camel K installed into the Kubernetes cluster you’re connected to.

Save the postgresql-source-binding.yaml file into your hard drive, then configure it according to your needs.

You can run the source using the following command:

kubectl apply -f postgresql-source-binding.yaml

Binding to Kafka using the Kamel CLI:

The procedure described above can be simplified into a single execution of the kamel bind command:

kamel bind postgresql-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 will create the KameletBinding under the hood and apply it to the current namespace in the cluster.

Kamelet source file

Have a look at the following link:

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

Back to top