final class MongoConnectionOptions extends AnyRef
Options for MongoConnection (see more documentation).
- Annotations
- @SuppressWarnings()
- Alphabetic
- By Inheritance
- MongoConnectionOptions
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from MongoConnectionOptions toany2stringadd[MongoConnectionOptions] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (MongoConnectionOptions, B)
- Implicit
- This member is added by an implicit conversion from MongoConnectionOptions toArrowAssoc[MongoConnectionOptions] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def appName: Option[String]
An optional application name
An optional application name
- Annotations
- @inline()
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def authenticationDatabase: Option[String]
The name of the database used for authentication
The name of the database used for authentication
- Annotations
- @inline()
- def authenticationMechanism: AuthenticationMode
Either ScramSha1Authentication or X509Authentication
Either ScramSha1Authentication or X509Authentication
- Annotations
- @inline()
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def compressors: ListSet[Compressor]
The list of allowed compressors (e.g.
The list of allowed compressors (e.g.
snappy
)- Annotations
- @inline()
- def connectTimeoutMS: Int
The number of milliseconds to wait for a connection to be established before giving up.
The number of milliseconds to wait for a connection to be established before giving up.
- Annotations
- @inline()
- def copy(connectTimeoutMS: Int = _connectTimeoutMS, authenticationDatabase: Option[String] = _authenticationDatabase, sslEnabled: Boolean = _sslEnabled, sslAllowsInvalidCert: Boolean = _sslAllowsInvalidCert, authenticationMechanism: AuthenticationMode = _authenticationMechanism, tcpNoDelay: Boolean = _tcpNoDelay, keepAlive: Boolean = _keepAlive, nbChannelsPerNode: Int = _nbChannelsPerNode, maxInFlightRequestsPerChannel: Option[Int] = _maxInFlightRequestsPerChannel, minIdleChannelsPerNode: Int = _minIdleChannelsPerNode, nettyEventLoopThreads: Int = _nettyEventLoopThreads, writeConcern: WriteConcern = _writeConcern, readPreference: ReadPreference = _readPreference, failoverStrategy: FailoverStrategy = _failoverStrategy, heartbeatFrequencyMS: Int = _heartbeatFrequencyMS, maxIdleTimeMS: Int = _maxIdleTimeMS, maxHistorySize: Int = _maxHistorySize, credentials: Map[String, Credential] = _credentials, keyStore: Option[KeyStore] = _keyStore, readConcern: ReadConcern = _readConcern, appName: Option[String] = _appName): MongoConnectionOptions
- Annotations
- @SuppressWarnings()
- def credentials: Map[String, Credential]
The credentials per authentication database names
The credentials per authentication database names
- Annotations
- @inline()
- def ensuring(cond: (MongoConnectionOptions) => Boolean, msg: => Any): MongoConnectionOptions
- Implicit
- This member is added by an implicit conversion from MongoConnectionOptions toEnsuring[MongoConnectionOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (MongoConnectionOptions) => Boolean): MongoConnectionOptions
- Implicit
- This member is added by an implicit conversion from MongoConnectionOptions toEnsuring[MongoConnectionOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): MongoConnectionOptions
- Implicit
- This member is added by an implicit conversion from MongoConnectionOptions toEnsuring[MongoConnectionOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): MongoConnectionOptions
- Implicit
- This member is added by an implicit conversion from MongoConnectionOptions toEnsuring[MongoConnectionOptions] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(that: Any): Boolean
- Definition Classes
- MongoConnectionOptions → AnyRef → Any
- def failoverStrategy: FailoverStrategy
The default failover strategy
The default failover strategy
- Annotations
- @inline()
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- MongoConnectionOptions → AnyRef → Any
- def heartbeatFrequencyMS: Int
The interval in milliseconds used by monitor to refresh the node set (default: 10000 aka 10s)
The interval in milliseconds used by monitor to refresh the node set (default: 10000 aka 10s)
- Annotations
- @inline()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def keepAlive: Boolean
TCP KeepAlive flag (ReactiveMongo-specific option).
TCP KeepAlive flag (ReactiveMongo-specific option). The default value is false (see SO_KEEPALIVE).
- Annotations
- @inline()
- def keyStore: Option[KeyStore]
An optional key store
An optional key store
- Annotations
- @inline()
- def maxHistorySize: Int
The maximum size of the pool history (default: 25)
The maximum size of the pool history (default: 25)
- Annotations
- @inline()
- def maxIdleTimeMS: Int
The maximum number of milliseconds that a channel can remain idle in the connection pool before being removed and closed (default: 0 to disable, as implemented using Netty IdleStateHandler); If not 0, must be greater or equal to heartbeatFrequencyMS.
The maximum number of milliseconds that a channel can remain idle in the connection pool before being removed and closed (default: 0 to disable, as implemented using Netty IdleStateHandler); If not 0, must be greater or equal to heartbeatFrequencyMS.
- Annotations
- @inline()
- def maxInFlightRequestsPerChannel: Option[Int]
The maximum number of requests processed per channel
The maximum number of requests processed per channel
- Annotations
- @inline()
- def maxNonQueryableHeartbeats: Int
EXPERIMENTAL:
- def minIdleChannelsPerNode: Int
The minimum number of idle channels per node
The minimum number of idle channels per node
- Annotations
- @inline()
- def nbChannelsPerNode: Int
The number of channels (connections) per node (ReactiveMongo-specific option)
The number of channels (connections) per node (ReactiveMongo-specific option)
- Annotations
- @inline()
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def nettyEventLoopThreads: Int
The number of threads in the netty event loop.
The number of threads in the netty event loop. 0 lets Netty decide, which by default will select 2 times the number of available processors.
- Annotations
- @inline()
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def readConcern: ReadConcern
The default read concern
The default read concern
- Annotations
- @inline()
- def readPreference: ReadPreference
The default read preference
The default read preference
- Annotations
- @inline()
- def sslAllowsInvalidCert: Boolean
If
sslEnabled
is true, this one indicates whether to accept invalid certificates (e.g.If
sslEnabled
is true, this one indicates whether to accept invalid certificates (e.g. self-signed).- Annotations
- @inline()
- def sslEnabled: Boolean
Enable SSL connection (required to be accepted on server-side)
Enable SSL connection (required to be accepted on server-side)
- Annotations
- @inline()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def tcpNoDelay: Boolean
TCP NoDelay flag (ReactiveMongo-specific option).
TCP NoDelay flag (ReactiveMongo-specific option). The default value is false (see TCP_NODELAY).
- Annotations
- @inline()
- def toString(): String
- Definition Classes
- MongoConnectionOptions → AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withCompressors(compressors: ListSet[Compressor]): MongoConnectionOptions
EXPERIMENTAL:
- def writeConcern: WriteConcern
The default write concern
The default write concern
- Annotations
- @inline()
Deprecated Value Members
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from MongoConnectionOptions toStringFormat[MongoConnectionOptions] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (MongoConnectionOptions, B)
- Implicit
- This member is added by an implicit conversion from MongoConnectionOptions toArrowAssoc[MongoConnectionOptions] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.