Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

IDIEP-34
Author
Sponsor
Created

 

Status

Status
colour

Grey

Green
title

DRAFT

COMPLETED


Table of Contents

Motivation

Currently transactions are not supported by thin client protocol. 

Description

There are changes needed for protocol, server side, and client side to support transactions.

Protocol changes

Add new operations to the thin client protocol:

NameCodeDescription
OP_TX_START4000Start a new transaction
OP_TX_END4001End the transaction

OP_TX_START message format

Request
byte

Concurrency control:

0 - OPTIMISTIC

1 - PESSIMISTIC

-1 - use server's default value

byte

Isolation level:

0 - READ_COMMITTED

1 - REPEATABLE_READ

2 - SERIALIZABLE

-1 - use server's default value

longTimeout (-1 - use server's default value)
stringlabel


Response

intUnique per client connection transaction id. This id should be returned as parameter with OP_TX_END message and all messages of cache operations within the transaction.

OP_TX_END message format

Request
int

Transaction id.

bool

Commit flag.


Empty response.

Cache operations

We need to add a new field to requests header of all cache data manipulation operations (opcodes 1000-1020, 2000, 2002, 2004) to bind these operations with the transaction.

We also can remove deprecated "flag" field in this protocol version. "Flag" field is only used by OP_QUERY_SCAN operation. So, we need to add a new field "keepBinary" to OP_QUERY_SCAN request.

Proposed changes to cache operations request header format:

TypeDescription
intLength of payload
shortOperation code
longRequest id
intCache id
byteflags (new "under transaction" flag with bitmask 0x02 introduced, to indicate that operation performed under transaction)modifiedremoved
intTransaction id (0 if there is no explicitly started transaction)added

Proposed changes to OP_QUERY_SCAN request format:

present only if "under transaction" flag is set, i.e. if flags & 0x02 != 0)added
TypeDescriptionHeaderCache operation request header
boolKeep binaryadded
Data ObjectFilter object. Can be null if you are not going to filter data on the cluster. The filter class has to be added to the classpath of the server nodesbyteFilter platform:
JAVA = 1
DOTNET = 2
CPP = 3
intCursor page sizeintNumber of partitions to query (negative to query entire cache)boolLocal flag - whether this query should be executed on local node only


Server-side changes

On the server side, we need to have the ability to decouple transactions from threads. We can do this by using transaction suspend/resume methods. Suspend/resume methods are only implemented for optimistic transactions now, so we need to implement this mechanism for pessimistic transactions first.

...

When the client sends OP_TX_END request, thread served this request resumes the transaction and commit or rollback it.

Client-side changes

The client must bind transaction and all cache operations which was made within this explicitly started transaction. We can implement transaction per thread approach on the thin client side as implemented now for the thick client. In this case, each transaction on the thin client side will be bound to a thread started this transaction. And each cache operation performed by this thread will be bound to the same transaction until the transaction is completed.

...

Code Block
languagejava
titleClientTransactions
public interface ClientTransactions {
    public ClientTransaction txStart(); // Start tx with client default values of concurrency, isolation and timeout properties.
    public ClientTransaction txStart(TransactionConcurrency concurrency, TransactionIsolation isolation); // Start tx with default timeout.
    public ClientTransaction txStart(TransactionConcurrency concurrency, TransactionIsolation isolation, long timeout);
    public ClientTransactions withLabel(String lb);
}

...

Code Block
languagejava
titleClientTransaction
public interface ClientTransaction extends AutoCloseable {
    public void commit();
    public void rollback();
    public void close();
}

To configure client default concurrency, isolation and timeout values for connection it is proposed to create new configuration class:

Code Block
languagejava
titleClientTransactionConfiguration
public class ClientTransactionConfiguration {
    public static final TransactionConcurrency DFLT_TX_CONCURRENCY = TransactionConcurrency.PESSIMISTIC;
    public static final TransactionIsolation DFLT_TX_ISOLATION = TransactionIsolation.REPEATABLE_READ;
    public static final long DFLT_TRANSACTION_TIMEOUT = 0;

    public TransactionConcurrency getDefaultTxConcurrency();
	public ClientTransactionConfiguration setDefaultTxConcurrency(TransactionConcurrency dfltConcurrency)

    public TransactionIsolation getDefaultTxIsolation();
    public ClientTransactionConfiguration setDefaultTxIsolation(TransactionIsolation dfltIsolation);

    public long getDefaultTxTimeout();
	public ClientTransactionConfiguration setDefaultTxTimeout(long dfltTxTimeout);
}

This transaction configuration can be used when the client connection is created (as a property of ClientConfiguration class).

Risks and Assumptions

//

Discussion Links

http://apache-ignite-developers.2346864.n4.nabble.com/Thin-client-transactions-support-td27761.html

Reference Links

// Links to various reference documents, if applicable.

Tickets

Jira
serverASF JIRA
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
maximumIssues20
jqlQueryproject = Ignite AND labels IN (iep-34) ORDER BY status
serverId5aa69414-a9e9-3523-82ec-879b028fb15b