object FullDocument
Change Stream fullDocument configuration.
Determines what to return for update operations when using a Change Stream. Defaults to FullDocument.DEFAULT. When set to FullDocument.UPDATE_LOOKUP, the change stream for partial updates will include both a delta describing the changes to the document as well as a copy of the entire document that was changed from *some time<*> after the change occurred.
- Since
2.4
- Note
Requires MongoDB 3.6 or greater
- Alphabetic
- By Inheritance
- FullDocument
- 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 DEFAULT: com.mongodb.client.model.changestream.FullDocument
Default
Default
Returns the servers default value in the
fullDocumentfield. - val REQUIRED: com.mongodb.client.model.changestream.FullDocument
The same behavior as WHEN_AVAILABLE except that an error is raised if the post-image is not available.
The same behavior as WHEN_AVAILABLE except that an error is raised if the post-image is not available.
- Since
4.7
- Note
Requires MongoDB 6.0 or greater
- val UPDATE_LOOKUP: com.mongodb.client.model.changestream.FullDocument
Lookup
Lookup
The change stream for partial updates will include both a delta describing the changes to the document as well as a copy of the entire document that was changed from *some time* after the change occurred.
- val WHEN_AVAILABLE: com.mongodb.client.model.changestream.FullDocument
Configures the change stream to return the post-image of the modified document for replace and update change events, if it is available.
Configures the change stream to return the post-image of the modified document for replace and update change events, if it is available.
- Since
4.7
- Note
Requires MongoDB 6.0 or greater
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def fromString(fullDocument: String): Try[FullDocument]
Returns the FullDocument from the string value.
Returns the FullDocument from the string value.
- fullDocument
the string value.
- returns
the read concern
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- 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() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- 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
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: