Class DittoTransaction

java.lang.Object

com.ditto.java.DittoTransaction

All Implemented Interfaces:

DittoQueryExecuting

public final class DittoTransaction
extends Object
implements DittoQueryExecuting

Represents a database transaction for executing multiple DQL queries atomically.

A transaction allows you to group multiple database operations together so they either all succeed (commit) or all fail (rollback), ensuring data consistency. Transactions are created by calling DittoStore.transaction(DittoTransactionFunction).

This class implements DittoQueryExecuting, allowing you to execute DQL queries within the transaction context.

See Also:

• DittoStore.transaction(DittoTransactionFunction)
• DittoTransactionInfo
• DittoTransaction.Result

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DittoTransaction.Result<T>	Represents the result of a transaction, indicating whether to commit or rollback.

Method Summary

Modifier and Type	Method	Description
@NonNull CompletionStage<DittoQueryResult>	execute(@NonNull String query)	Executes a DQL query and returns items as a query result.
@NonNull CompletionStage<DittoQueryResult>	execute(@NonNull String query, @NonNull DittoCborSerializable.Dictionary arguments)	Executes a DQL query and returns items as a query result.
@NonNull DittoTransactionInfo	getInfo()	Returns information about the current transaction.

Methods inherited from class java.lang.Object

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

Method Details

getInfo

public @NonNull DittoTransactionInfo getInfo()

Returns information about the current transaction.

Returns:

a DittoTransactionInfo instance containing transaction metadata.

execute

public @NonNull CompletionStage<DittoQueryResult> execute(@NonNull String query)

Executes a DQL query and returns items as a query result. This method only returns results from the local store without waiting for any DittoSyncSubscriptions to have caught up with the latest changes. Only use this method if your program must proceed with immediate results. Use a DittoStoreObserver to receive updates to query results as soon as they have been synced to this peer.

Specified by:

execute in interface DittoQueryExecuting

Parameters:

query - A string containing a valid query expressed in DQL.

Returns:

A CompletionStage containing a DittoQueryResultItem for each match, or a DittoException if there is a problem with the query or the store.

execute

public @NonNull CompletionStage<DittoQueryResult> execute(@NonNull String query,
 @NonNull DittoCborSerializable.Dictionary arguments)

Executes a DQL query and returns items as a query result. This method only returns results from the local store without waiting for any DittoSyncSubscriptions to have caught up with the latest changes. Only use this method if your program must proceed with immediate results. Use a DittoStoreObserver to receive updates to query results as soon as they have been synced to this peer.

Specified by:

execute in interface DittoQueryExecuting

Parameters:

query - A string containing a valid query expressed in DQL.

arguments - A map of values keyed by the placeholder name without the leading :. Example: ["mileage": 123].

Returns:

A CompletionStage containing a DittoQueryResultItem for each match, or a DittoException if there is a problem with the query or the store.