Skip to main content

Striim Cloud 4.1.0 documentation

Mongo Cosmos DB Reader properties

The Mongo Java driver used by this reader is bundled with Striim.

For best performance and lower Azure ingress and egress charges, Mongo CosmosDB Reader should be run in Striim in Azure.

property

type

default value

notes

Collections

String

The fully-qualified name(s) of the collection(s) to read from, for example, mydb.mycollection. Separate multiple collections by commas.

You may use the $ wildcard, for example, mydb.$ or mydb.a$. Note that data will be read only from collections that exist when the Striim application starts, additional collections added later will be ignored until the application is restarted.

Connection Retry Policy

String

retryInterval=60, maxRetries=3

With the default setting, if a connection attempt is unsuccessful, the adapter will try again in 30 seconds (retryInterval. If the second attempt is unsuccessful, in 30 seconds it will try a third time (maxRetries). If that is unsuccessful, the adapter will fail and log an exception. Negative values are not supported.

Connection URL

String

Enter the Host and Port from the Connection String read-only tab of your Azure Cosmos DB API for MongoDB account, separated by a colon, for example, mydb.mongo.cosmos.azure.com:10255.

Cosmos DB Config

String

Optionally, specify a JSON-format string with additional Cosmos DB options. For an example, see "Capturing deletes" in Cosmos DB setup for Mongo Cosmos DB Reader.

Exclude Collections

String

Any collections to be excluded from the set specified in the Collections property. Specify as for the Collections property.

Fetch Size

Integer

1000

The number of documents the adapter will fetch in a single read operation.

Mode

String

InitialLoad

With the default setting, will load all existing data using mongo-driver-sync and stop. In this mode, Mongo Cosmos DB Reader is not a CDC reader. In this mode, recovery will restart from the beginning.

Set to Incremental to read CDC data continuously using the change streams API (see Change streams in Azure Cosmos DB’s API for MongoDB). In this mode, insert, update, and replace operations are all sent to the target as inserts, since the change stream does not include the operation type. See Mongo Cosmos DB Reader limitations for discussion of recovery in this mode.

Overload Retry Policy

String

retryInterval=30, maxRetries=10

With the default setting, if reading is interrupted because the number of request units (RUs) per second exceeded the provisioned limit, the adapter will try again in 30 seconds (retryInterval). If this attempt is unsuccessful, every 30 seconds it will try again. If the tenth attempt (maxRetries) is unsuccessful, the adapter will fail and log an exception. Negative values are not supported.

Password

encrypted password

The Primary Password or Secondary Password from the Connection String read-only tab of your Azure Cosmos DB API for MongoDB account.

Quiesce on IL Completion

Boolean

False

ThreadPool Size

Integer

10

The number of threads Striim will use for reading collections. If this number is lower than the number of collections being read, threads will read in round-robin fashion. If this number equals the number of collections, each thread will read from one collection. If this number exceeds the number of collections, only this number of threads will be active.

Username

String

The Username from the Connection String read-only tab of your Azure Cosmos DB API for MongoDB account.