Package org.apache.ignite.tx

Class TransactionOptions

java.lang.Object

org.apache.ignite.tx.TransactionOptions

public class TransactionOptions
extends Object

Ignite transaction options.

Constructor Summary

Constructors

Constructor	Description
TransactionOptions()

Method Summary

Modifier and Type	Method	Description
boolean	cacheOnly()	Returns a value indicating whether a cache-only transaction should be used.
TransactionOptions	cacheOnly(boolean cacheOnly)	Sets a value indicating whether a cache-only transaction should be used.
boolean	readOnly()	Returns a value indicating whether a read-only transaction should be used.
TransactionOptions	readOnly(boolean readOnly)	Sets a value indicating whether a read-only transaction should be used.
long	timeoutMillis()	Returns transaction timeout, in milliseconds.
TransactionOptions	timeoutMillis(long timeoutMillis)	Sets transaction timeout, in milliseconds.

Methods inherited from class java.lang.Object

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

Constructor Details

TransactionOptions

public TransactionOptions()

Method Details

timeoutMillis

public long timeoutMillis()

Returns transaction timeout, in milliseconds. 0 means 'use default timeout'.

Returns:

Transaction timeout, in milliseconds.

timeoutMillis

public TransactionOptions timeoutMillis(long timeoutMillis)

Sets transaction timeout, in milliseconds.

Parameters:

timeoutMillis - Transaction timeout, in milliseconds. Cannot be negative; 0 means 'use default timeout'.

• For RO transactions, the default timeout is configured via ignite.transaction.timeout configuration property.
• For RW transactions, timeouts are not supported yet.

Returns:

this for chaining.

readOnly

public boolean readOnly()

Returns a value indicating whether a read-only transaction should be used.

Read-only transactions provide a snapshot view of data at a certain point in time. They are lock-free and perform better than normal transactions, but do not permit data modifications.

Returns:

Whether a read-only transaction should be used.

readOnly

public TransactionOptions readOnly(boolean readOnly)

Sets a value indicating whether a read-only transaction should be used.

Read-only transactions provide a snapshot view of data at a certain point in time. They are lock-free and perform better than normal transactions, but do not permit data modifications.

Parameters:

readOnly - Whether a read-only transaction should be used.

Returns:

this for chaining.

cacheOnly

public boolean cacheOnly()

Returns a value indicating whether a cache-only transaction should be used.

Returns:

Whether a cache-only transaction should be used.

cacheOnly

public TransactionOptions cacheOnly(boolean cacheOnly)

Sets a value indicating whether a cache-only transaction should be used.

This type of transactions is only compatible with caches and do not support read-only mode (this flag is ignored).

Parameters:

cacheOnly - Whether a cache-only transaction should be used.

Returns:

this for chaining.

See Also:

• Cache
• IgniteCaches