mongo - Mongo (mongo)

Configuration for a Mongo instance.

NameTypeDefaultDescription
idstringA unique configuration ID.
libraryRefA reference to top level library element (string).Specifies a library that contains the MongoDB Java Driver.
onError
  • IGNORE
  • FAIL
  • WARN
WARNDetermines the action to take in response to configuration errors.
IGNORE
Server will not issue any warning and error messages when it incurs a configuration error.
FAIL
Server will issue a warning or error message on the first error occurrence and then stop the server.
WARN
Server will issue warning and error messages when it incurs a configuration error.
passwordReversably encoded password (string)Password for database user.
userstringDatabase user name.
autoConnectRetrybooleanRetry connections to a server, for an interval up to the maxAutoConnectRetryTime, if the socket cannot be opened.
connectionsPerHostint
Min: 0
Limits the number of open connections to each host. Connections are pooled when not in use.
connectTimeoutA period of time with millisecond precisionConnection 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.
cursorFinalizerEnabledbooleanAttempts to clean up DBCursors that are not closed.
descriptionstringDescription of a Mongo instance.
maxAutoConnectRetryTimeA period of time with millisecond precisionInterval 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.
maxWaitTimeA period of time with millisecond precisionMaximum 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.
socketKeepAlivebooleanConfigures whether or not to keep sockets alive.
socketTimeoutA period of time with millisecond precisionThe 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.
threadsAllowedToBlockForConnectionMultiplierint
Min: 0
This value, multiplied by connectionsPerHost, establishes an upper limit on threads that are allowed to wait for an available connection.
readPreference
  • primary
  • secondaryPreferred
  • secondary
  • primaryPreferred
  • nearest
Configures the read preference.
primary
primary
secondaryPreferred
secondaryPreferred
secondary
secondary
primaryPreferred
primaryPreferred
nearest
nearest
writeConcern
  • ERRORS_IGNORED
  • ACKNOWLEDGED
  • SAFE
  • JOURNALED
  • NORMAL
  • REPLICA_ACKNOWLEDGED
  • FSYNC_SAFE
  • MAJORITY
  • FSYNCED
  • JOURNAL_SAFE
  • REPLICAS_SAFE
  • NONE
  • UNACKNOWLEDGED
The reliability of a write operation to the mongo server.
ERRORS_IGNORED
ERRORS_IGNORED
ACKNOWLEDGED
ACKNOWLEDGED
SAFE
SAFE
JOURNALED
JOURNALED
NORMAL
NORMAL
REPLICA_ACKNOWLEDGED
REPLICA_ACKNOWLEDGED
FSYNC_SAFE
FSYNC_SAFE
MAJORITY
MAJORITY
FSYNCED
FSYNCED
JOURNAL_SAFE
JOURNAL_SAFE
REPLICAS_SAFE
REPLICAS_SAFE
NONE
NONE
UNACKNOWLEDGED
UNACKNOWLEDGED

hostNames

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.

library

Specifies a library that contains the MongoDB Java Driver.

NameTypeDefaultDescription
namestringName of shared library for administrators
descriptionstringDescription of shared library for administrators
filesetRefList of references to top level fileset elements (comma-separated string).Id of referenced Fileset
apiTypeVisibilitystringspec,ibm-api,apiThe 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.

library > fileset

Id of referenced Fileset

NameTypeDefaultDescription
idstringA unique configuration ID.
dirPath to a directory${server.config.dir}The base directory to search for files.
caseSensitivebooleantrueBoolean to indicate whether or not the search should be case sensitive (default: true).
includesstring*The comma or space separated list of file name patterns to include in the search results (default: *).
excludesstringThe comma or space separated list of file name patterns to exclude from the search results, by default no files are excluded.
scanIntervalA period of time with millisecond precision0Scanning 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.

library > folder

Id of referenced folder

NameTypeDefaultDescription
idstringA unique configuration ID.
dirPath to a directoryDirectory or folder to be included in the library classpath for locating resource files

library > file

Id of referenced File

NameTypeDefaultDescription
idstringA unique configuration ID.
namePath to a fileFully qualified filename

ports

List of port numbers. The ordering of this list must be consistent with the list of host names, such that the first element in the list of host names corresponds to the first element in the list of ports, and so forth.