object FullDocumentBeforeChange
Change Stream fullDocumentBeforeChange configuration.
Determines what to return for update operations when using a Change Stream. Defaults to FullDocumentBeforeChange#DEFAULT.
- Since
4.7
- Note
Requires MongoDB 6.0 or greater
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- FullDocumentBeforeChange
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Value Members
- val DEFAULT: com.mongodb.client.model.changestream.FullDocumentBeforeChange
The default value
- val OFF: com.mongodb.client.model.changestream.FullDocumentBeforeChange
Configures the change stream to not include the pre-image of the modified document.
- val REQUIRED: com.mongodb.client.model.changestream.FullDocumentBeforeChange
The same behavior as WHEN_AVAILABLE except that an error is raised if the pre-image is not available.
- val WHEN_AVAILABLE: com.mongodb.client.model.changestream.FullDocumentBeforeChange
Configures the change stream to return the pre-image of the modified document for replace, update, and delete change events if it is available.
- def fromString(fullDocumentBeforeChange: String): Try[com.mongodb.client.model.changestream.FullDocumentBeforeChange]
Returns the FullDocumentBeforeChange from the string value.
Returns the FullDocumentBeforeChange from the string value.
- fullDocumentBeforeChange
the string value.
- returns
the FullDocumentBeforeChange value
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: