com.mongodb.client.model.changestream

Class ChangeStreamDocument<TDocument>

java.lang.Object

com.mongodb.client.model.changestream.ChangeStreamDocument<TDocument>

Type Parameters:

TDocument - The type that this collection will encode the fullDocument field into.

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

Represents the $changeStream aggregation output document.

Note: this class will not be applicable for all change stream outputs. If using custom pipelines that radically change the change stream result, then an alternative document format should be used.

Since:

3.6

Constructor Summary

Constructors

Constructor and Description
ChangeStreamDocument(BsonDocument resumeToken, BsonDocument namespaceDocument, TDocument fullDocument, BsonDocument documentKey, BsonTimestamp clusterTime, OperationType operationType, UpdateDescription updateDescription) Deprecated.
ChangeStreamDocument(BsonDocument resumeToken, MongoNamespace namespace, TDocument fullDocument, BsonDocument documentKey, BsonTimestamp clusterTime, OperationType operationType, UpdateDescription updateDescription) Deprecated. Prefer ChangeStreamDocument(OperationType, BsonDocument, BsonDocument, BsonDocument, Object, BsonDocument, BsonTimestamp, UpdateDescription)
ChangeStreamDocument(BsonDocument resumeToken, MongoNamespace namespace, TDocument fullDocument, BsonDocument documentKey, OperationType operationType, UpdateDescription updateDescription) Deprecated. Prefer ChangeStreamDocument(OperationType, BsonDocument, BsonDocument, BsonDocument, Object, BsonDocument, BsonTimestamp, UpdateDescription)
ChangeStreamDocument(OperationType operationType, BsonDocument resumeToken, BsonDocument namespaceDocument, BsonDocument destinationNamespaceDocument, TDocument fullDocument, BsonDocument documentKey, BsonTimestamp clusterTime, UpdateDescription updateDescription) Deprecated.
ChangeStreamDocument(OperationType operationType, BsonDocument resumeToken, BsonDocument namespaceDocument, BsonDocument destinationNamespaceDocument, TDocument fullDocument, BsonDocument documentKey, BsonTimestamp clusterTime, UpdateDescription updateDescription, BsonInt64 txnNumber, BsonDocument lsid) Creates a new instance

Method Summary

Modifier and Type	Method and Description
static <TFullDocument> Codec<ChangeStreamDocument<TFullDocument>>	createCodec(java.lang.Class<TFullDocument> fullDocumentClass, CodecRegistry codecRegistry) Creates the codec for the specific ChangeStreamOutput type
boolean	equals(java.lang.Object o)
BsonTimestamp	getClusterTime() Gets the cluster time at which the change occurred.
java.lang.String	getDatabaseName() Returns the database name
MongoNamespace	getDestinationNamespace() Returns the destination namespace, derived from the "to" field in a change stream document.
BsonDocument	getDestinationNamespaceDocument() Returns the destination namespace document, derived from the "to" field in a change stream document.
BsonDocument	getDocumentKey() Returns a document containing just the _id of the changed document.
TDocument	getFullDocument() Returns the fullDocument
BsonDocument	getLsid() Returns the identifier for the session associated with the transaction
MongoNamespace	getNamespace() Returns the namespace, derived from the "ns" field in a change stream document.
BsonDocument	getNamespaceDocument() Returns the namespace cocument, derived from the "ns" field in a change stream document.
OperationType	getOperationType() Returns the operationType
BsonDocument	getResumeToken() Returns the resumeToken
BsonInt64	getTxnNumber() Returns the transaction number
UpdateDescription	getUpdateDescription() Returns the updateDescription
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ChangeStreamDocument

@Deprecated
public ChangeStreamDocument(BsonDocument resumeToken,
                                        MongoNamespace namespace,
                                        TDocument fullDocument,
                                        BsonDocument documentKey,
                                        OperationType operationType,
                                        UpdateDescription updateDescription)

Deprecated. Prefer ChangeStreamDocument(OperationType, BsonDocument, BsonDocument, BsonDocument, Object, BsonDocument, BsonTimestamp, UpdateDescription)

Creates a new instance

Parameters:

resumeToken - the resume token

namespace - the namespace

documentKey - a document containing the _id of the changed document

fullDocument - the fullDocument

operationType - the operation type

updateDescription - the update description

ChangeStreamDocument

@Deprecated
public ChangeStreamDocument(BsonDocument resumeToken,
                                        MongoNamespace namespace,
                                        TDocument fullDocument,
                                        BsonDocument documentKey,
                                        @Nullable
                                        BsonTimestamp clusterTime,
                                        OperationType operationType,
                                        UpdateDescription updateDescription)

Deprecated. Prefer ChangeStreamDocument(OperationType, BsonDocument, BsonDocument, BsonDocument, Object, BsonDocument, BsonTimestamp, UpdateDescription)

Creates a new instance

Parameters:

resumeToken - the resume token

namespace - the namespace

documentKey - a document containing the _id of the changed document

clusterTime - the cluster time at which the change occurred

fullDocument - the fullDocument

operationType - the operation type

updateDescription - the update description

ChangeStreamDocument

@Deprecated
public ChangeStreamDocument(@BsonProperty(value="resumeToken")
                                        BsonDocument resumeToken,
                                        @BsonProperty(value="ns")
                                        BsonDocument namespaceDocument,
                                        @BsonProperty(value="fullDocument")
                                        TDocument fullDocument,
                                        @BsonProperty(value="documentKey")
                                        BsonDocument documentKey,
                                        @Nullable @BsonProperty(value="clusterTime")
                                        BsonTimestamp clusterTime,
                                        @BsonProperty(value="operationType")
                                        OperationType operationType,
                                        @BsonProperty(value="updateDescription")
                                        UpdateDescription updateDescription)

Deprecated.

Creates a new instance

Parameters:

resumeToken - the resume token

namespaceDocument - the BsonDocument representing the namespace

fullDocument - the full document

documentKey - a document containing the _id of the changed document

clusterTime - the cluster time at which the change occured

operationType - the operation type

updateDescription - the update description

Since:

3.8

ChangeStreamDocument

@Deprecated
public ChangeStreamDocument(@BsonProperty(value="operationType")
                                        OperationType operationType,
                                        @BsonProperty(value="resumeToken")
                                        BsonDocument resumeToken,
                                        @Nullable @BsonProperty(value="ns")
                                        BsonDocument namespaceDocument,
                                        @Nullable @BsonProperty(value="to")
                                        BsonDocument destinationNamespaceDocument,
                                        @Nullable @BsonProperty(value="fullDocument")
                                        TDocument fullDocument,
                                        @Nullable @BsonProperty(value="documentKey")
                                        BsonDocument documentKey,
                                        @Nullable @BsonProperty(value="clusterTime")
                                        BsonTimestamp clusterTime,
                                        @Nullable @BsonProperty(value="updateDescription")
                                        UpdateDescription updateDescription)

Deprecated.

Creates a new instance

Parameters:

operationType - the operation type

resumeToken - the resume token

namespaceDocument - the BsonDocument representing the namespace

destinationNamespaceDocument - the BsonDocument representing the destinatation namespace

fullDocument - the full document

documentKey - a document containing the _id of the changed document

clusterTime - the cluster time at which the change occured

updateDescription - the update description

Since:

3.11

ChangeStreamDocument

public ChangeStreamDocument(@BsonProperty(value="operationType")
                            OperationType operationType,
                            @BsonProperty(value="resumeToken")
                            BsonDocument resumeToken,
                            @Nullable @BsonProperty(value="ns")
                            BsonDocument namespaceDocument,
                            @Nullable @BsonProperty(value="to")
                            BsonDocument destinationNamespaceDocument,
                            @Nullable @BsonProperty(value="fullDocument")
                            TDocument fullDocument,
                            @Nullable @BsonProperty(value="documentKey")
                            BsonDocument documentKey,
                            @Nullable @BsonProperty(value="clusterTime")
                            BsonTimestamp clusterTime,
                            @Nullable @BsonProperty(value="updateDescription")
                            UpdateDescription updateDescription,
                            @Nullable @BsonProperty(value="txnNumber")
                            BsonInt64 txnNumber,
                            @Nullable @BsonProperty(value="lsid")
                            BsonDocument lsid)

Creates a new instance

Parameters:

operationType - the operation type

resumeToken - the resume token

namespaceDocument - the BsonDocument representing the namespace

destinationNamespaceDocument - the BsonDocument representing the destinatation namespace

fullDocument - the full document

documentKey - a document containing the _id of the changed document

clusterTime - the cluster time at which the change occured

updateDescription - the update description

txnNumber - the transaction number

lsid - the identifier for the session associated with the transaction

Since:

3.11

Method Detail

getResumeToken

public BsonDocument getResumeToken()

Returns the resumeToken

Returns:

the resumeToken

getNamespace

@BsonIgnore
 @Nullable
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

@BsonProperty(value="ns")
 @Nullable
public BsonDocument 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

@BsonIgnore
 @Nullable
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

@BsonProperty(value="to")
 @Nullable
public BsonDocument 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

@BsonIgnore
 @Nullable
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

@Nullable
public TDocument getFullDocument()

Returns the fullDocument

Returns:

the fullDocument

getDocumentKey

@Nullable
public BsonDocument 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

@Nullable
public BsonTimestamp getClusterTime()

Gets the cluster time at which the change occurred.

Returns:

the cluster time at which the change occurred

Since:

3.8

getOperationType

public OperationType getOperationType()

Returns the operationType

Returns:

the operationType

getUpdateDescription

@Nullable
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

@Nullable
public BsonInt64 getTxnNumber()

Returns the transaction number

Returns:

the transaction number, or null if not part of a multi-document transaction

Since:

3.11

getLsid

@Nullable
public BsonDocument 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

createCodec

public static <TFullDocument> Codec<ChangeStreamDocument<TFullDocument>> createCodec(java.lang.Class<TFullDocument> fullDocumentClass,
                                                                                     CodecRegistry codecRegistry)

Creates the codec for the specific ChangeStreamOutput type

Type Parameters:

TFullDocument - the fullDocument type

Parameters:

fullDocumentClass - the class to use to represent the fullDocument

codecRegistry - the codec registry

Returns:

the codec

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object