object WriteConcern
Controls the acknowledgment of write operations with various options.
w
- 0: Don't wait for acknowledgement from the server - 1: Wait for acknowledgement, but don't wait for secondaries to replicate - >=2: Wait for one or more secondaries to also acknowledge - "majority": Wait for a majority of secondaries to also acknowledge - "<tag set name>": Wait for one or more secondaries to also acknowledge based on a tag set name
wTimeout
- how long to wait for slaves before failing
- 0: indefinite - >0: time to wait in milliseconds
Other options:
- journal
: If true block until write operations have been committed to the journal. Cannot be used in combination with fsync
.
Prior to MongoDB 2.6 this option was ignored if the server was running without journaling. Starting with MongoDB 2.6
write operations will fail with an exception if this option is used when the server is running without journaling.
Implicit helper
The ScalaWriteConcern implicit allows for chainable building of the WriteConcern eg:
val myWriteConcern = WriteConcern.ACKNOWLEDGED.withJournal(true)).withWTimeout(Duration(10, TimeUnit.MILLISECONDS))
- Since
1.0
- Alphabetic
- By Inheritance
- WriteConcern
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val ACKNOWLEDGED: com.mongodb.WriteConcern
Write operations that use this write concern will wait for acknowledgement from the primary server before returning.
Write operations that use this write concern will wait for acknowledgement from the primary server before returning. Exceptions are raised for network issues, and server errors.
- val JOURNALED: com.mongodb.WriteConcern
Exceptions are raised for network issues, and server errors; the write operation waits for the server to group commit to the journal file on disk.
- val MAJORITY: com.mongodb.WriteConcern
Exceptions are raised for network issues, and server errors; waits on a majority of servers for the write operation.
- val UNACKNOWLEDGED: com.mongodb.WriteConcern
Write operations that use this write concern will return as soon as the message is written to the socket.
Write operations that use this write concern will return as soon as the message is written to the socket. Exceptions are raised for network issues, but not server errors.
- val W1: com.mongodb.WriteConcern
Write operations that use this write concern will wait for acknowledgement from a single member.
- val W2: com.mongodb.WriteConcern
Write operations that use this write concern will wait for acknowledgement from two members.
- val W3: com.mongodb.WriteConcern
Write operations that use this write concern will wait for acknowledgement from three members.
- def apply(w: String): com.mongodb.WriteConcern
Tag set named write concern or a "majority" write concern.
Tag set named write concern or a "majority" write concern.
- w
Write Concern tag set name or "majority", representing the servers to ensure write propagation to before acknowledgment. Do not use string representation of integer values for w.
- def apply(w: Int): com.mongodb.WriteConcern
Create a WriteConcern with the set number of acknowledged writes before returning
Create a WriteConcern with the set number of acknowledged writes before returning
- w
number of writes
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
- Deprecated
(Since version ) see corresponding Javadoc for more information.
This is the documentation for the MongoDB Scala driver.
Driver structure
The mongodb scala driver.
To get started you need a MongoClient instance, either from a connection string or via a org.mongodb.scala.MongoClientSettings.
Notable packages include: