Mongo (mongo)
Configuration for a Mongo instance.
Attribute name | Data type | Default value | Description |
---|---|---|---|
autoConnectRetry | boolean | Retry connections to a server, for an interval up to the maxAutoConnectRetryTime, if the socket cannot be opened. | |
connectTimeout | A period of time with millisecond precision | Connection timeout for new connections. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds. | |
connectionsPerHost | int
Minimum: 0 |
Limits the number of open connections to each host. Connections are pooled when not in use. | |
cursorFinalizerEnabled | boolean | Attempts to clean up DBCursors that are not closed. | |
description | string | Description of a Mongo instance. | |
id | string | A unique configuration ID. | |
libraryRef | A reference to top level library element (string). | Specifies a library that contains the MongoDB Java Driver. | |
maxAutoConnectRetryTime | A period of time with millisecond precision | Interval during which to retry attempts to open a connection to a server. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds. | |
maxWaitTime | A period of time with millisecond precision | Maximum amount of time to wait for an available connection. If negative, the connection request never times out. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds. | |
onError |
|
WARN | Determines the action to take in response to configuration errors.
|
password | Reversably encoded password (string) | Password for database user. | |
readPreference |
|
Configures the read preference.
|
|
socketKeepAlive | boolean | Configures whether or not to keep sockets alive. | |
socketTimeout | A period of time with millisecond precision | The socket timeout. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds. | |
threadsAllowedToBlockForConnectionMultiplier | int
Minimum: 0 |
This value, multiplied by connectionsPerHost, establishes an upper limit on threads that are allowed to wait for an available connection. | |
user | string | Database user name. | |
writeConcern |
|
The reliability of a write operation to the mongo server.
|
- hostNames
Description: List of host names. The ordering of this list must be consistent with the list of ports, such that the first element in the list of host names corresponds to the first element in the list of ports, and so forth.Required: falseData type: string
- library
Description: Specifies a library that contains the MongoDB Java Driver.Required: falseData type: Attribute name Data type Default value Description apiTypeVisibility string spec,ibm-api,api The types of API package this library's class loader will be able to see, as a comma-separated list of any combination of the following: spec, ibm-api, api, third-party. description string Description of shared library for administrators filesetRef List of references to top level fileset elements (comma-separated string). Id of referenced Fileset name string Name of shared library for administrators - library > file
Description: Id of referenced FileRequired: falseData type: Attribute name Data type Default value Description id string A unique configuration ID. name Path to a file Fully qualified filename
- library > fileset
Description: Id of referenced FilesetRequired: falseData type: Attribute name Data type Default value Description caseSensitive boolean true Boolean to indicate whether or not the search should be case sensitive (default: true). dir Path to a directory ${server.config.dir} The base directory to search for files. excludes string The comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded. id string A unique configuration ID. includes string * The comma or space separated list of file name patterns to include in the search results (default: *). scanInterval A period of time with millisecond precision 0 Scanning interval to check the fileset for changes as a long with a time unit suffix h-hour, m-minute, s-second, ms-millisecond (e.g. 2ms or 5s). Disabled (scanInterval=0) by default. Specify a positive integer followed by a unit of time, which can be hours (h), minutes (m), seconds (s), or milliseconds (ms). For example, specify 500 milliseconds as 500ms. You can include multiple values in a single entry. For example, 1s500ms is equivalent to 1.5 seconds.