mongodb source MongoDB Source

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Consume data from MongoDB.

If you enable the persistentTailTracking property, the consumer keeps track of the last consumed message and, on the next restart, the consumption restarts from that message. If you enable persistentTailTracking, you must provide a value for the tailTrackIncreasingField property (by default it is optional).

If you disable the persistentTailTracking property, the consumer consumes the whole collection and waits in idle for new data to consume.

The collection that provides the data must be a capped collection.

Configuration Options

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

Property Name Description Type Default Example

collection

MongoDB Collection

Required The name of the MongoDB collection to bind to this endpoint.

string

database

MongoDB Database

Required The name of the MongoDB database.

string

hosts

MongoDB Hosts

Required A comma-separated list of MongoDB host addresses in host:port format.

string

password

MongoDB Password

The user password for accessing MongoDB.

string

persistentTailTracking

MongoDB Persistent Tail Tracking

Specifies to enable persistent tail tracking, which is a mechanism to keep track of the last consumed data across system restarts. The next time the system is up, the endpoint recovers the cursor from the point where it last stopped consuimg data. This option will only work on capped collections.

boolean

false

ssl

Enable Ssl for Mongodb Connection

whether to enable ssl connection to mongodb.

boolean

true

sslValidationEnabled

Enables Ssl Certificates Validation and Host name checks.

IMPORTANT this should be disabled only in test environment since can pose security issues.

boolean

true

tailTrackIncreasingField

MongoDB Tail Track Increasing Field

The correlation field in the incoming data which is of increasing nature and is used to position the tailing cursor every time it is generated.

string

username

MongoDB Username

The 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-source Kamelet relies upon the presence of the following dependencies:

  • camel:kamelet

  • camel:mongodb

  • camel:jackson

  • mvn:org.apache.camel.kamelets:camel-kamelets-utils:4.4.4-SNAPSHOT

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 mongodb-source.

Knative source

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

mongodb-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: mongodb-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: mongodb-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

  1. Save the mongodb-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 mongodb-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.collection=The MongoDB Collection" -p "source.database=The MongoDB Database" -p "source.hosts=The MongoDB Hosts" mongodb-source

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

Kafka source

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

mongodb-source-pipe.yaml
apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: mongodb-source-pipe
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: mongodb-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

  1. Save the mongodb-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 mongodb-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.collection=The MongoDB Collection" -p "source.database=The MongoDB Database" -p "source.hosts=The MongoDB Hosts" mongodb-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/mongodb-source.kamelet.yaml

Back to top