MongoDB Changes Stream Source
Provided by: "Apache Software Foundation"
Support Level for this Kamelet is: "Stable"
Consume Changes from MongoDB Collection in streaming mode.
Configuration Options
The following table summarizes the configuration options available for the mongodb-changes-stream-source
Kamelet:
Property | Name | Description | Type | Default | Example |
---|---|---|---|---|---|
MongoDB Collection |
Required Sets the name of the MongoDB collection to bind to this endpoint. |
string |
|||
MongoDB Database |
Required Sets the name of the MongoDB database to target. |
string |
|||
MongoDB Hosts |
Required Comma separated list of MongoDB Host Addresses in host:port format. |
string |
|||
MongoDB Password |
User password for accessing MongoDB. |
string |
|||
Stream Filter |
Filter condition for change streams consumer. |
string |
{ '$match':{'$or':[{'fullDocument.stringValue': 'specificValue'}]} } |
||
MongoDB Username |
Username for accessing MongoDB. The username must be present in the MongoDB’s authentication database (authenticationDatabase). By default, the MongoDB authenticationDatabase is 'admin'. |
string |
Dependencies
At runtime, the mongodb-changes-stream-source
Kamelet relies upon the presence of the following dependencies:
-
camel:kamelet
-
camel:mongodb
-
camel:jackson
Usage
This section describes how you can use the mongodb-changes-stream-source
.
Knative source
You can use the mongodb-changes-stream-source
Kamelet as a Knative source by binding it to a Knative object.
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: mongodb-changes-stream-source-binding
spec:
source:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: mongodb-changes-stream-source
properties:
collection: The MongoDB Collection
database: The MongoDB Database
hosts: The MongoDB Hosts
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
-
Save the
mongodb-changes-stream-source-binding.yaml
file to your local drive, and then edit it as needed for your configuration. -
Run the source by using the following command:
kubectl apply -f mongodb-changes-stream-source-binding.yaml
Procedure for using the Kamel CLI
Configure and run the source by using the following command:
kamel bind mongodb-changes-stream-source -p "source.collection=The MongoDB Collection" -p "source.database=The MongoDB Database" -p "source.hosts=The MongoDB Hosts" channel:mychannel
This command creates the KameletBinding in the current namespace on the cluster.
Kafka source
You can use the mongodb-changes-stream-source
Kamelet as a Kafka source by binding it to a Kafka topic.
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
name: mongodb-changes-stream-source-binding
spec:
source:
ref:
kind: Kamelet
apiVersion: camel.apache.org/v1alpha1
name: mongodb-changes-stream-source
properties:
collection: The MongoDB Collection
database: The MongoDB Database
hosts: The MongoDB Hosts
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
-
Save the
mongodb-changes-stream-source-binding.yaml
file to your local drive, and then edit it as needed for your configuration. -
Run the source by using the following command:
kubectl apply -f mongodb-changes-stream-source-binding.yaml
Procedure for using the Kamel CLI
Configure and run the source by using the following command:
kamel bind mongodb-changes-stream-source -p "source.collection=The MongoDB Collection" -p "source.database=The MongoDB Database" -p "source.hosts=The MongoDB Hosts" kafka.strimzi.io/v1beta1:KafkaTopic:my-topic
This command creates the KameletBinding in the current namespace on the cluster.