mongodb sink MongoDB Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Preview"

Send documents to MongoDB.

This Kamelet expects a JSON as body.

Properties you can as headers:

db-upsert / ce-dbupsert If the database should create the element if it does not exist. Boolean value.

Configuration Options

The following table summarizes the configuration options available for the mongodb-sink Kamelet:

Property Name Description Type Default Example

collection *

MongoDB Collection

Sets the name of the MongoDB collection to bind to this endpoint.

string

database *

MongoDB Database

Sets the name of the MongoDB database to target.

string

hosts *

MongoDB Hosts

Comma separated list of MongoDB Host Addresses in host:port format.

string

createCollection

Collection

Create collection during initialisation if it doesn’t exist.

boolean

false

password

MongoDB Password

User password for accessing MongoDB.

string

username

MongoDB Username

Username for accessing MongoDB.

string

writeConcern

Write Concern

Configure the level of acknowledgment requested from MongoDB for write operations, possible values are ACKNOWLEDGED, W1, W2, W3, UNACKNOWLEDGED, JOURNALED, MAJORITY.

string
Fields marked with (*) are mandatory.

Usage

This section summarizes how the mongodb-sink can be used in various contexts.

Knative Sink

The mongodb-sink Kamelet can be used as Knative sink by binding it to a Knative object.

mongodb-sink-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: mongodb-sink-binding
spec:
  source:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: mongodb-sink
    properties:
      collection: "The MongoDB Collection"
      database: "The MongoDB Database"
      hosts: "The MongoDB Hosts"

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

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

You can run the sink using the following command:

kubectl apply -f mongodb-sink-binding.yaml

Dependencies

The Kamelet needs the following dependencies:

  • camel:kamelet

  • camel:mongodb

  • camel:jackson

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 channel:mychannel mongodb-sink -p "sink.collection=The MongoDB Collection" -p "sink.database=The MongoDB Database" -p "sink.hosts=The MongoDB Hosts"

This will create the KameletBinding under the hood and apply it to the current namespace in the cluster.

Kafka Sink

The mongodb-sink Kamelet can be used as Kafka sink by binding it to a Kafka topic.

mongodb-sink-binding.yaml
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: mongodb-sink-binding
spec:
  source:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1alpha1
      name: mongodb-sink
    properties:
      collection: "The MongoDB Collection"
      database: "The MongoDB Database"
      hosts: "The MongoDB Hosts"

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 mongodb-sink-binding.yaml file into your hard drive, then configure it according to your needs.

You can run the sink using the following command:

kubectl apply -f mongodb-sink-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 kafka.strimzi.io/v1beta1:KafkaTopic:my-topic mongodb-sink -p "sink.collection=The MongoDB Collection" -p "sink.database=The MongoDB Database" -p "sink.hosts=The MongoDB Hosts"

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/mongodb-sink.kamelet.yaml

Back to top