MongoDB DB (mongoDB)

Configuration for a MongoDB DB instance.

NameTypeDefaultDescription

databaseName

string
Required

Name of the database.

id

string

A unique configuration ID.

jndiName

string

JNDI name for a MongoDB DB instance

mongoRef

A reference to top level mongo element (string).

Specifies the Mongo instance that this DB instance belongs to.

mongoDB > mongo

Specifies the Mongo instance that this DB instance belongs to.

NameTypeDefaultDescription

hostNames

string

localhost

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.

libraryRef

A reference to top level library element (string).

Specifies a library that contains the MongoDB Java Driver.

onError

  • FAIL

  • IGNORE

  • WARN

WARN

Determines the action to take in response to configuration errors.
FAIL
Server will issue a warning or error message on the first error occurrence and then stop the server.
IGNORE
Server will not issue any warning and error messages when it incurs a configuration error.
WARN
Server will issue warning and error messages when it incurs a configuration error.

password

Reversably encoded password (string)

Password for database user.

ports

int
Min: 0

27017

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.

useCertificateAuthentication

boolean

Use provided certificate from key store to authenticate user to MongoDB.

user

string

Database user name.

MongoClientOptions

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
Min: 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.

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.

readPreference

  • nearest

  • primary

  • primaryPreferred

  • secondary

  • secondaryPreferred

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.

sslEnabled

boolean

Configures whether or not to enable SSL.

sslRef

A reference to top level ssl element (string).

ID of the SSL configuration to be used to connect to the SSL-enabled server.

threadsAllowedToBlockForConnectionMultiplier

int
Min: 0

This value, multiplied by connectionsPerHost, establishes an upper limit on threads that are allowed to wait for an available connection.

writeConcern

  • ACKNOWLEDGED

  • ERRORS_IGNORED

  • FSYNCED

  • FSYNC_SAFE

  • JOURNALED

  • JOURNAL_SAFE

  • MAJORITY

  • NONE

  • NORMAL

  • REPLICAS_SAFE

  • REPLICA_ACKNOWLEDGED

  • SAFE

  • UNACKNOWLEDGED

The reliability of a write operation to the mongo server.

Expand
mongoDB > mongo > library

Specifies a library that contains the MongoDB Java Driver.

Expand
mongoDB > mongo > library > file

Expand
mongoDB > mongo > library > fileset

Expand
mongoDB > mongo > library > folder

Expand
mongoDB > mongo > ssl

ID of the SSL configuration to be used to connect to the SSL-enabled server.

Expand
mongoDB > mongo > ssl > keyStore

Expand
mongoDB > mongo > ssl > keyStore > keyEntry

Expand
mongoDB > mongo > ssl > outboundConnection

Expand
mongoDB > mongo > ssl > trustStore

Expand
mongoDB > mongo > ssl > trustStore > keyEntry