Packages

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

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FullDocument
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. val DEFAULT: com.mongodb.client.model.changestream.FullDocument

    Default

    Default

    Returns the servers default value in the fullDocument field.

  2. 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

  3. 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.

  4. 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

  5. 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