Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MongoDB Source Kamelet Improvements #399

Merged
merged 3 commits into from
Jun 25, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/modules/ROOT/pages/mongodb-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,11 @@

*Support Level for this Kamelet is: "Preview"*

Consume documents from MongoDB
Consume documents from MongoDB.

If the persistentTailTracking option will be enabled, the consumer will keep track of the last consumed message and on the next restart, the consumption will restart from that message. In case of persistentTailTracking enabled, the tailTrackIncreasingField must be provided (by default it is optional).

If the persistentTailTracking option won't be enabled, the consumer will consume the whole collection and wait in idle for new documents to consume.

== Configuration Options

Expand All @@ -18,6 +22,8 @@ The following table summarizes the configuration options available for the `mong
| *hosts {empty}* *| MongoDB Hosts| Comma separated list of MongoDB Host Addresses in host:port format.| string| |
| *password {empty}* *| MongoDB Password| User password for accessing MongoDB.| string| |
| *username {empty}* *| MongoDB Username| Username for accessing MongoDB.| string| |
| persistentTailTracking| MongoDB Persistent Tail Tracking| Enable persistent tail tracking, which is a mechanism to keep track of the last consumed message across system restarts. The next time the system is up, the endpoint will recover the cursor from the point where it last stopped slurping records.| boolean| `false`|
| tailTrackIncreasingField| MongoDB Tail Track Increasing Field| Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated.| string| |
|===

NOTE: Fields marked with ({empty}*) are mandatory.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@ spec:
definition:
title: "MongoDB Source"
description: |-
Consume documents from MongoDB
Consume documents from MongoDB.

If the persistentTailTracking option will be enabled, the consumer will keep track of the last consumed message and on the next restart, the consumption will restart from that message. In case of persistentTailTracking enabled, the tailTrackIncreasingField must be provided (by default it is optional).

If the persistentTailTracking option won't be enabled, the consumer will consume the whole collection and wait in idle for new documents to consume.
required:
- hosts
- collection
Expand Down Expand Up @@ -46,6 +50,17 @@ spec:
title: MongoDB Database
description: Sets the name of the MongoDB database to target.
type: string
persistentTailTracking:
title: MongoDB Persistent Tail Tracking
description: Enable persistent tail tracking, which is a mechanism to keep track of the last consumed message across system restarts. The next time the system is up, the endpoint will recover the cursor from the point where it last stopped slurping records.
type: boolean
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:checkbox'
default: false
tailTrackIncreasingField:
title: MongoDB Tail Track Increasing Field
description: Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated.
type: string
dependencies:
- "camel:kamelet"
- "camel:mongodb"
Expand All @@ -62,6 +77,8 @@ spec:
password: "{{password}}"
username: "{{username}}"
database: "{{database}}"
persistentTailTracking: "{{persistentTailTracking}}"
tailTrackIncreasingField: "{{?tailTrackIncreasingField}}"
steps:
- marshal:
json: {}
Expand Down
19 changes: 18 additions & 1 deletion mongodb-source.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@ spec:
definition:
title: "MongoDB Source"
description: |-
Consume documents from MongoDB
Consume documents from MongoDB.

If the persistentTailTracking option will be enabled, the consumer will keep track of the last consumed message and on the next restart, the consumption will restart from that message. In case of persistentTailTracking enabled, the tailTrackIncreasingField must be provided (by default it is optional).

If the persistentTailTracking option won't be enabled, the consumer will consume the whole collection and wait in idle for new documents to consume.
required:
- hosts
- collection
Expand Down Expand Up @@ -46,6 +50,17 @@ spec:
title: MongoDB Database
description: Sets the name of the MongoDB database to target.
type: string
persistentTailTracking:
title: MongoDB Persistent Tail Tracking
description: Enable persistent tail tracking, which is a mechanism to keep track of the last consumed message across system restarts. The next time the system is up, the endpoint will recover the cursor from the point where it last stopped slurping records.
type: boolean
x-descriptors:
- 'urn:alm:descriptor:com.tectonic.ui:checkbox'
default: false
tailTrackIncreasingField:
title: MongoDB Tail Track Increasing Field
description: Correlation field in the incoming record which is of increasing nature and will be used to position the tailing cursor every time it is generated.
type: string
dependencies:
- "camel:kamelet"
- "camel:mongodb"
Expand All @@ -62,6 +77,8 @@ spec:
password: "{{password}}"
username: "{{username}}"
database: "{{database}}"
persistentTailTracking: "{{persistentTailTracking}}"
tailTrackIncreasingField: "{{?tailTrackIncreasingField}}"
steps:
- marshal:
json: {}
Expand Down