Skip to main content

Striim Cloud 4.1.0 documentation

MongoDBReader properties

The MongoDB driver is bundled with Striim, so no installation is necessary.

The adapter properties are:

property	type	default value	notes
authDB	String	admin	Specify the authentication database for the specified username. If not specified, uses the `admin` database.
authType	enum	Default	Specify the authentication mechanism used by your MongoDB instance. The default setting uses MongoDB's default authentication mechanism, SCRAM. Other supported choices are GSSAPI, MONGODBCR, MONGODBX509, and SCRAMSHA1. Set to NoAuth if authentication is not enabled. Set to GSSAPI if you are using Kerberos.
Collections	String		The fully-qualified name(s) of the MongoDB 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		When Mode is InitialLoad and you are connecting to MongoDB with DNS SRV, specify `mongodb+srv://<host name>/<authentication database>`, for example, `mongodb+srv://abcdev3.gcp.mongodb.net/mydb`. If you do not specify a database, the connection will use `admin`. and you are connecting to a sharded MongoDB instance with mongos, specify `<IP address or host name>:<port>` of the `mongos` instance. and you are connecting to a sharded instance of MongoDB without mongos, specify `<IP address or host name>:<port>` for all instances of the replica set, separated by commas. For example: `192.168.1.1:27107, 192.168.1.2:27107, 192.168.1.3:27017`.. When Mode is Incremental and you are connecting to an unsharded instance of MongoDB, specify `<IP address or host name>:<port>` for all instances of the replica set, separated by commas. For example: `192.168.1.1:27107, 192.168.1.2:27107, 192.168.1.3:27017`.. and you are connecting to a sharded instance of MongoDB, create a separate source for each shard. For each reader, specify all the instances of the replica set, separated by commas. For example: `192.168.1.1:27107, 192.168.1.2:27107, 192.168.1.3:27017`..
Exclude Collections	String		Any collections to be excluded from the set specified in the Collections property. Specify as for the Collections property.
Mode	String	InitialLoad	With the default setting, will load all existing data using `db.collection.find()`and stop. In this mode, MongoDBReader is not a CDC reader. Set to `Incremental` to read CDC data continuously from the oplog.
Password	encrypted password		The password for the specified Username.
Quiesce on IL Completion	Boolean	False	With the default value of False, you must stop the application manually after all data has been read. Set to True to automatically quiesce the application after all data has been read (see discussion of QUIESCE in Console commands). When you see on the Apps page that the application is in the Quiescing state, it means that all the data that existed when the query was submitted has been read and that the target(s) are writing it. When you see that the application is in the Quiesced state, you know that all the data has been written to the target(s). At that point, you can undeploy the initial load application and then start another application for continuous replication of new data.Console commands Note Set to True only if all targets in the application support auto-quiesce (see Writers overview).Writers overview
Read Preference	String	primaryPreferred	See Read Preference Modes. Supported values are primary, primaryPreferred, secondary, secondaryPreferred, and nearest.
Security Config	String		See Using SSL and Kerberos authentication with MongoDB.
SSL Enabled	Boolean	False	If MongoDB requires SSL or individual MongoDB nodes are specified in the Connection URL, set to True (see Configure mongod and mongos for TLS/SSL)
Start Timestamp	String		Leave blank to read only new data. Specify a UTC DateTime value (for example, 2018-07-18T04:56:10) to read all data from that time forward or to wait to start reading until a time in the future. If the MongoDB and Striim servers are in different time zones, adjust the value to match the Striim time zone. If the oplog no longer contains data back to the specified time, reading will start from the beginning of the oplog. If milliseconds are specified (for example, 2017-07-18T04:56:10.999), they will be interpreted as the incrementing ordinal for the MongoDB timestamp (see Timestamps).
Username	String		A MongoDB user with access as described in MongoDB setup.

In this section:

Would you like to provide feedback? Just click here to suggest edits.