Package io.vertx.mongo.client.model.changestream

Class ChangeStreamDocument<TDocument>

  • public class ChangeStreamDocument<TDocument>
extends java.lang.Object

    • Method Detail

      • getResumeToken

        public JsonObject getResumeToken()
        Returns the resumeToken
        Returns:
        the resumeToken

      • getNamespace

        public MongoNamespace getNamespace()
        Returns the namespace, derived from the "ns" field in a change stream document. The invalidate operation type does include a MongoNamespace in the ChangeStreamDocument response. The dropDatabase operation type includes a MongoNamespace, but does not include a collection name as part of the namespace.
        Returns:
        the namespace. If the namespaceDocument is null or if it is missing either the 'db' or 'coll' keys, then this will return null.

      • getNamespaceDocument

        public JsonObject getNamespaceDocument()
        Returns the namespace cocument, derived from the "ns" field in a change stream document. The namespace document is a BsonDocument containing the values associated with a MongoNamespace. The 'db' key refers to the database name and the 'coll' key refers to the collection name.
        Returns:
        the namespaceDocument
        Since:
        3.8

      • getDestinationNamespace

        public MongoNamespace getDestinationNamespace()
        Returns the destination namespace, derived from the "to" field in a change stream document.

        The destination namespace is used to indicate the destination of a collection rename event.

        Returns:
        the namespace. If the "to" document is null or absent, then this will return null.
        Since:
        3.11
        See Also:
        OperationType.RENAME

      • getDestinationNamespaceDocument

        public JsonObject getDestinationNamespaceDocument()
        Returns the destination namespace document, derived from the "to" field in a change stream document.

        The destination namespace document is a BsonDocument containing the values associated with a MongoNamespace. The 'db' key refers to the database name and the 'coll' key refers to the collection name.

        Returns:
        the destinationNamespaceDocument
        Since:
        3.11

      • getDatabaseName

        public java.lang.String getDatabaseName()
        Returns the database name
        Returns:
        the databaseName. If the namespaceDocument is null or if it is missing the 'db' key, then this will return null.
        Since:
        3.8

      • getFullDocument

        public TDocument getFullDocument()
        Returns the fullDocument
        Returns:
        the fullDocument

      • getDocumentKey

        public JsonObject getDocumentKey()
        Returns a document containing just the _id of the changed document.

        For unsharded collections this contains a single field, _id, with the value of the _id of the document updated. For sharded collections, this will contain all the components of the shard key in order, followed by the _id if the _id isn’t part of the shard key.

        Returns:
        the document key, or null if the event is not associated with a single document (e.g. a collection rename event)

      • getClusterTime

        public java.lang.Long getClusterTime()
        Gets the cluster time at which the change occurred.
        Returns:
        the cluster time at which the change occurred
        Since:
        3.8
        Since server release
        4.0

      • getOperationType

        public OperationType getOperationType()
        Returns the operationType
        Returns:
        the operationType

      • getUpdateDescription

        public UpdateDescription getUpdateDescription()
        Returns the updateDescription
        Returns:
        the updateDescription, or null if the event is not associated with a single document (e.g. a collection rename event)

      • getTxnNumber

        public java.lang.Long getTxnNumber()
        Returns the transaction number
        Returns:
        the transaction number, or null if not part of a multi-document transaction
        Since:
        3.11
        Since server release
        4.0

      • getLsid

        public JsonObject getLsid()
        Returns the identifier for the session associated with the transaction
        Returns:
        the lsid, or null if not part of a multi-document transaction
        Since:
        3.11
        Since server release
        4.0