Attribute | Description | Allowed Values / Examples |
---|
Name | Specify a name for the alias. | any string |
Standard
|
---|
protocol
| Specifies the protocol to be used with this connection. | mongodb | Use the standard MongoDB connection protocol (default). |
mongodb+srv | Use DNS seed list. |
hosts | Specifies a list of MongoDB host with optional ports (one list entry per line). | scheer-acme.com db.scheer-acme.com:2701 |
replicaSet | Specifies a replica set name. |
|
database | Specifies the default database to be used. |
|
collection | Specifies the default collection to be used. |
|
xUMLRuntimeUseTransactions | Specifies whether to use automatic transactions with replica sets. If enabled, the xUML Runtime will apply the transaction concepts as documented on xUML Runtime Transaction Concepts. Note |
---|
| Transactions can only be enabled when using replica sets. Also, some options like read/write concerns make it impossible to use transactions. If a conflict can be detected, the Runtime refuses to start. Use with caution, and refer to the MongoDB manual for more information. |
| true | Use automatic transactions on replica sets. |
false | Do not use automatic transactions on replica sets (default). |
Authentication |
user | Specifies the database user (if the database requires authentication). If the user contains characters that MongoDB has defined as to be illegal, they will be converted correctly to percent encoding. |
|
password | Specifies the password of user (if the database requires authentication). If the password contains characters that MongoDB has defined as to be illegal, they will be converted correctly to percent encoding. |
|
defaultauthdb | Specifies the defaultauthdb option, the authentication database to be used if user and password are provided. |
|
authSource | Specifies the authSource option, the database name that is associated with the provided credentials. |
|
authMechanism | Specifies the authMechanism option, the authentication mechanism to be used to authenticate the connection. |
|
authMechanismProperties | Specifies the authMechanismProperties option, the properties of the specified authMechanism as a comma-separated list of colon-separated key-value pairs. | CANNONICALIZE_HOST_NAME:true,AWS_SESSION_TOKEN:FQoGZXIvYXdzEN... |
Compression |
compressors | Specifies the compressors option, the compressor to be used for network communication. | zlib | Use zlib compression. |
none | No compression. |
zlibCompressionLevel | Specifies the zlibCompressionLevel option, compression level if zlib compression is used. | -1 | zlib default |
0 | no compression |
1-9 | compression level |
Misc |
retryReads | Specifies the retryReads option. This option enables retryable reads. | true | Retry reads (default). |
false | Do not retry reads. |
retryWrites | Specifies the retryWrites option. This option enables retryable writes. | true | Retry writes (default) |
false | Do not retry writes. |
Pooling |
maxPoolSize | Specifies the maxPoolSize option, the maximum number of connections in the connection pool. | any positive integer |
100 | default |
waitQueueTimeoutMS | Specifies the waitQueueTimeoutMS option, the maximum wait time for a client connection to become available from the pool. | any positive integer |
30000 | default |
Read/write |
w | Specifies the w option. This option requests acknowlegdement that a write operation has been propagated to the specified number of MongoDB instances or MongoDB instances with specific tags. | a positive integer (default 1) | Acknowledge propagation to the given number of databases. |
majority | Acknowledge propagation to the majority of databases. |
a tag set | Acknowledge propagation to the databases with the specified tags. |
wtimeoutMS | Specifies the wtimeoutMS option, the time limit for the write concern in milliseconds. | any positive integer |
30000 | default |
journal | Specifies the journal option. This option requests acknowlegdement from the database that the write operation has been written to the journal. | true | Request acknowlegdement for write operations. |
false | No acknowlegdement of write operations (default). |
readConcernLevel | Specifies the readConcernLevel option. Refer to the MongoDB manual for more details. | One of: local (default), majority, linearizable, available, snapshot |
readPreference | Specifies the readPreference option. Refer to the MongoDB manual for more details. | One of: primary (default), primaryPreferred, secondary, secondaryPreferred, nearest |
maxStalenessSeconds | Specifies the maxStalenessSeconds option, how stale a secondary can be before the client stops using it for read operations. | any positive integer >= 90 |
-1 | default |
readPreferenceTags | Specifies the readPreferenceTags option. |
|
Server selection & discovery |
localThresholdMS | Specifies the localThresholdMS option. | any positive integer |
15 | default |
serverSelectionTimeoutMS | Specifies the serverSelectionTimeoutMS option. | any positive integer |
30000 | default |
heartbeatFrequencyMS | Specifies the heartbeatFrequencyMS option. | any positive integer |
10000 | default |
Timeout |
connectTimeoutMS | Specifies the connectTimeoutMS option, the time in milliseconds a connection is attempted before it times out. | any positive integer |
30000 | default |
socketTimeoutMS | Specifies the socketTimeoutMS option, the time in milliseconds a send or receive is attempted on a socket before it times out. | any positive integer |
30000 | default |
TLS |
tls | Specifies the tls option, used to enable/disable TLS. | true | Enable TLS. |
false | Disable TLS (default). |
tlsCertificateKeyFile | Specifies the tlsCertificateKeyFile option, the path to a .pem file that contains either the TLS/SSL X.509 certificate of the client, or the client's TLS/SSL certificate and key. |
|
tlsCertificateKeyFilePassword | Specifies the tlsCertificateKeyFilePassword option, the password to decrypt the certificate file. |
|
tlsCAFile | Specifies the tlsCAFile option, the path to a .pem file that contains the root certificate chain of the certificate authority. This file is used to validate the certificate presented by the database instance. |
|
tlsAllowInvalidCertificates | Specifies the tlsAllowInvalidCertificates option, used to allow invalid certificates. | true | Bypass certifiate validation. |
false | Validate the certificate presented by the database instance (default). |
tlsAllowInvalidHostnames | Specifies the tlsAllowInvalidHostnames option, used to disable hostname validation. | true | Do not validate the hostname of the certificate presented by the database instance. |
false | Validate the hostname of the certificate presented by the database instance (default). |
tlsInsecure | Specifies the tlsInsecure option. | true | Disable TLS various certificate validations. Refer to the MongoDB manual for details. |
false | Validate TLS certificates (default). |