Class MongoDBTransaction

java.lang.Object

com.kingsrook.qqq.backend.core.actions.QBackendTransaction

com.kingsrook.qqq.backend.module.mongodb.actions.MongoDBTransaction

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

MongoDBConsistentReadTransaction

public class MongoDBTransaction
extends QBackendTransaction

MongoDB implementation of backend transaction. Stores a mongoClient and clientSession. Also keeps track of if the specific mongo backend being used supports transactions, as, it appears that single-node instances do not, and they throw errors if you try to do transaction operations in them... This is configured by the corresponding field in the backend metaData.

Constructor Summary

Constructors

Modifier	Constructor	Description
	MongoDBTransaction(MongoDBBackendMetaData backend, com.mongodb.client.MongoClient mongoClient)
	MongoDBTransaction(MongoDBBackendMetaData backend, com.mongodb.client.MongoClient mongoClient, com.mongodb.client.ClientSession clientSession)	Adopt the client and its already-open session as one transaction owner.
protected	MongoDBTransaction(MongoDBBackendMetaData backend, com.mongodb.client.MongoClient mongoClient, com.mongodb.client.ClientSession clientSession, boolean allowTransactions)	As above - but with allowTransactions false, no mongo transaction is started (e.g., for a snapshot-read-concern session, which can't have one), whatever the backend's transactionsSupported says.

Method Summary

Modifier and Type	Method	Description
void	close()	Close any resources associated with the transaction.
void	commit()	Commit the transaction.
com.mongodb.client.ClientSession	getClientSession()	Getter for clientSession
com.mongodb.client.MongoClient	getMongoClient()	Getter for mongoClient
void	rollback()	Rollback the transaction.

Methods inherited from class com.kingsrook.qqq.backend.core.actions.QBackendTransaction

addAfterCommitCallback, discardAfterCommitCallbacks, getConsistencyGuarantee, getExportedSnapshotId, openConsistentReadFor, openFor, runAfterCommitCallbacks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MongoDBTransaction

public MongoDBTransaction(MongoDBBackendMetaData backend,
 com.mongodb.client.MongoClient mongoClient)

MongoDBTransaction

public MongoDBTransaction(MongoDBBackendMetaData backend,
 com.mongodb.client.MongoClient mongoClient,
 com.mongodb.client.ClientSession clientSession)

Adopt the client and its already-open session as one transaction owner.

MongoDBTransaction

protected MongoDBTransaction(MongoDBBackendMetaData backend,
 com.mongodb.client.MongoClient mongoClient,
 com.mongodb.client.ClientSession clientSession,
 boolean allowTransactions)

As above - but with allowTransactions false, no mongo transaction is started (e.g., for a snapshot-read-concern session, which can't have one), whatever the backend's transactionsSupported says.

Method Details

commit

public void commit()
            throws QException

Description copied from class: QBackendTransaction

Commit the transaction.

Overrides:

commit in class QBackendTransaction

Throws:

QException

rollback

public void rollback()
              throws QException

Description copied from class: QBackendTransaction

Rollback the transaction.

Overrides:

rollback in class QBackendTransaction

Throws:

QException

close

public void close()

Description copied from class: QBackendTransaction

Close any resources associated with the transaction. In theory, should only be called after a commit or rollback was done.

Specified by:

close in interface AutoCloseable

Overrides:

close in class QBackendTransaction

getMongoClient

public com.mongodb.client.MongoClient getMongoClient()

Getter for mongoClient

getClientSession

public com.mongodb.client.ClientSession getClientSession()

Getter for clientSession