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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val DEFAULT: com.mongodb.client.model.changestream.FullDocument

    Default

    Default

    Returns the servers default value in the fullDocument field.

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

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

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

  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. 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

  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped