Struct MongoDbConfig 

pub struct MongoDbConfig {

    pub url: String,
    pub collection: Option<String>,
    pub username: Option<String>,
    pub password: Option<String>,
    pub tls: TlsConfig,
    pub database: String,
    pub polling_interval_ms: Option<u64>,
    pub reply_polling_ms: Option<u64>,
    pub request_reply: bool,
    pub consume: Option<MongoConsume>,
    pub receive_query: Option<String>,
    pub change_stream: bool,
    pub checkpoint_store: Option<String>,
    pub request_timeout_ms: Option<u64>,
    pub ttl_seconds: Option<u64>,
    pub capped_size_bytes: Option<i64>,
    pub format: MongoDbFormat,
    pub id_field: Option<String>,
    pub report_outcome: bool,
    pub cursor_id: Option<String>,
    pub meta_collection: Option<String>,
    pub shared: Option<bool>,
}

General MongoDB connection configuration.

Fields

url: String

MongoDB connection string URI. Can contain a comma-separated list of hosts for a replica set. If it contains userinfo, it will be treated as a secret. Credentials provided via the separate username and password fields take precedence over any credentials embedded in the URL.

collection: Option<String>

The MongoDB collection name.

username: Option<String>

Optional username. Takes precedence over any credentials embedded in the url. Use embedded URL credentials for simple one-off connections but prefer explicit username/password fields (or environment-sourced secrets) for clarity and secret management in production.

password: Option<String>

Optional password. Takes precedence over any credentials embedded in the url. Use embedded URL credentials for simple one-off connections but prefer explicit username/password fields (or environment-sourced secrets) for clarity and secret management in production.

tls: TlsConfig

TLS configuration.

database: String

The database name.

polling_interval_ms: Option<u64>

(Consumer only) Polling interval in milliseconds for the consumer (when not using Change Streams). Defaults to 100ms.

reply_polling_ms: Option<u64>

(Publisher only) Polling interval in milliseconds for the publisher when waiting for a reply. Defaults to 50ms.

request_reply: bool

(Publisher only) If true, the publisher will wait for a response in a dedicated collection. Defaults to false.

consume: Option<MongoConsume>

(Consumer only) How to consume the collection: consumer (default, competing-consumers work queue — destructive and ~5x slower), subscriber (ephemeral queue), capture_new (watch an existing collection for changes), or capture_all (read existing documents first, then watch for changes — use this for single-reader bulk reads and ETL). The bridge selects the underlying mechanism automatically. If unset, the deprecated change_stream boolean is honored for backward compatibility.

receive_query: Option<String>

(Consumer only) Optional custom MongoDB query to filter messages. Provided as a JSON string (e.g., ‘{“type”: “notification”}’).

change_stream: bool

(Consumer only) Deprecated — use consume: subscriber. Kept for compatibility.

checkpoint_store: Option<String>

(Consumer only) Where to persist the resume cursor in capture_new/capture_all mode. A URL selects the backend; a bare name (or /name) reuses the source database with that name:

• absent → source database, collection mqb_cursors_<source_collection> (auto-unique)
• /my_cursors → source database, collection my_cursors
• file:///var/lib/mqb/cursors.json → local JSON file (read-only / write-restricted sources)
• mongodb://host/db/collection → external MongoDB collection (collection optional)
• postgres://user@host/db/table or mysql://host/db/table → external SQL table (table optional)
• s3://bucket/prefix (also gs://, az://, abfs://) → cloud object store; creds via env

When no collection/table is named, it defaults to mqb_cursors_<source_collection>. May embed connection credentials, so it is treated as a secret.

request_timeout_ms: Option<u64>

(Publisher only) Timeout for request-reply operations in milliseconds. Defaults to 30000ms.

ttl_seconds: Option<u64>

(Publisher only) TTL in seconds for documents created by the publisher. If set, a TTL index is created.

capped_size_bytes: Option<i64>

(Publisher only) If set, creates a capped collection with this size in bytes.

format: MongoDbFormat

Format for storing messages. Defaults to Normal.

id_field: Option<String>

(Publisher only) Top-level payload field whose value becomes the document _id, for idempotent inserts via the unique _id index. Sink collections only.

report_outcome: bool

(Publisher only) Return the message with metadata mongodb.outcome = inserted/existed (dup-key) so a request+switch can branch. Sink collections only; pair with id_field.

cursor_id: Option<String>

The ID used for the cursor in sequenced mode. If not provided, consumption starts from the current sequence (ephemeral).

meta_collection: Option<String>

(Optional) Collection to store sequence counters and cursor positions. Defaults to the message collection if not set.

shared: Option<bool>

Share one MongoDB client per connection (default: true); false forces a dedicated client.

Implementations

impl MongoDbConfig

pub fn new(url: impl Into<String>, database: impl Into<String>) -> Self

Creates a new MongoDB configuration with the specified URL and database name.

pub fn with_collection(self, collection: impl Into<String>) -> Self

pub fn with_credentials( self, username: impl Into<String>, password: impl Into<String>, ) -> Self

pub fn with_change_stream(self, change_stream: bool) -> Self

pub fn resolved_consume(&self) -> MongoConsume

The effective consume mode: the explicit consume field if set, otherwise derived from the deprecated change_stream boolean.

Trait Implementations

impl Clone for MongoDbConfig

fn clone(&self) -> MongoDbConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MongoDbConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MongoDbConfig

fn default() -> MongoDbConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MongoDbConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl SecretExtractor for MongoDbConfig

fn extract_secrets( &mut self, prefix: &str, secrets: &mut HashMap<String, String>, )

Extracts secrets into the provided map using the given prefix, and clears them from self.

impl Serialize for MongoDbConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.