blob: bd552e0c666766044c63059e77a87b58e464dde2 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_291) on Mon Jan 10 11:05:26 MSK 2022 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClientTransactions (Ignite 2.12.0)</title>
<meta name="date" content="2022-01-10">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<link rel='shortcut icon' href='https://ignite.apache.org/favicon.ico'/>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ClientTransactions (Ignite 2.12.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ClientTransactions.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/ignite/client/ClientTransaction.html" title="interface in org.apache.ignite.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/ignite/client/IgniteClient.html" title="interface in org.apache.ignite.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/ignite/client/ClientTransactions.html" target="_top">Frames</a></li>
<li><a href="ClientTransactions.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.ignite.client</div>
<h2 title="Interface ClientTransactions" class="title">Interface ClientTransactions</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">ClientTransactions</span></pre>
<div class="block">Thin client transactions facade.
<p>
Transactions are bound to the thread started the transaction. After that, each cache operation within this thread
will belong to the corresponding transaction until the transaction is committed, rolled back or closed.
<p>
Transactions are <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html?is-external=true" title="class or interface in java.lang"><code>AutoCloseable</code></a>, so they will automatically rollback unless explicitly committed.
<p>
Default values for transaction isolation level, concurrency and timeout can be configured via
<a href="../../../../org/apache/ignite/configuration/ClientConfiguration.html#setTransactionConfiguration-org.apache.ignite.configuration.ClientTransactionConfiguration-"><code>ClientConfiguration.setTransactionConfiguration(ClientTransactionConfiguration)</code></a> property.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/ignite/configuration/ClientTransactionConfiguration.html" title="class in org.apache.ignite.configuration"><code>ClientTransactionConfiguration</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/client/ClientTransaction.html" title="interface in org.apache.ignite.client">ClientTransaction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientTransactions.html#txStart--">txStart</a></span>()</code>
<div class="block">Starts a new transaction with the default isolation level, concurrency and timeout.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/client/ClientTransaction.html" title="interface in org.apache.ignite.client">ClientTransaction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientTransactions.html#txStart-org.apache.ignite.transactions.TransactionConcurrency-org.apache.ignite.transactions.TransactionIsolation-">txStart</a></span>(<a href="../../../../org/apache/ignite/transactions/TransactionConcurrency.html" title="enum in org.apache.ignite.transactions">TransactionConcurrency</a>&nbsp;concurrency,
<a href="../../../../org/apache/ignite/transactions/TransactionIsolation.html" title="enum in org.apache.ignite.transactions">TransactionIsolation</a>&nbsp;isolation)</code>
<div class="block">Starts a new transaction with the specified concurrency and isolation.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/client/ClientTransaction.html" title="interface in org.apache.ignite.client">ClientTransaction</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientTransactions.html#txStart-org.apache.ignite.transactions.TransactionConcurrency-org.apache.ignite.transactions.TransactionIsolation-long-">txStart</a></span>(<a href="../../../../org/apache/ignite/transactions/TransactionConcurrency.html" title="enum in org.apache.ignite.transactions">TransactionConcurrency</a>&nbsp;concurrency,
<a href="../../../../org/apache/ignite/transactions/TransactionIsolation.html" title="enum in org.apache.ignite.transactions">TransactionIsolation</a>&nbsp;isolation,
long&nbsp;timeout)</code>
<div class="block">Starts a new transaction with the specified isolation, concurrency and timeout.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/ignite/client/ClientTransactions.html" title="interface in org.apache.ignite.client">ClientTransactions</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/client/ClientTransactions.html#withLabel-java.lang.String-">withLabel</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;lb)</code>
<div class="block">Returns instance of <code>ClientTransactions</code> to mark each new transaction with a specified label.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="txStart--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>txStart</h4>
<pre><a href="../../../../org/apache/ignite/client/ClientTransaction.html" title="interface in org.apache.ignite.client">ClientTransaction</a>&nbsp;txStart()
throws org.apache.ignite.internal.client.thin.ClientServerError,
<a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></pre>
<div class="block">Starts a new transaction with the default isolation level, concurrency and timeout.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>New transaction.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code> - If some unfinished transaction has already started by this thread.</dd>
<dd><code>org.apache.ignite.internal.client.thin.ClientServerError</code></dd>
</dl>
</li>
</ul>
<a name="txStart-org.apache.ignite.transactions.TransactionConcurrency-org.apache.ignite.transactions.TransactionIsolation-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>txStart</h4>
<pre><a href="../../../../org/apache/ignite/client/ClientTransaction.html" title="interface in org.apache.ignite.client">ClientTransaction</a>&nbsp;txStart(<a href="../../../../org/apache/ignite/transactions/TransactionConcurrency.html" title="enum in org.apache.ignite.transactions">TransactionConcurrency</a>&nbsp;concurrency,
<a href="../../../../org/apache/ignite/transactions/TransactionIsolation.html" title="enum in org.apache.ignite.transactions">TransactionIsolation</a>&nbsp;isolation)
throws org.apache.ignite.internal.client.thin.ClientServerError,
<a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></pre>
<div class="block">Starts a new transaction with the specified concurrency and isolation.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>concurrency</code> - Concurrency.</dd>
<dd><code>isolation</code> - Isolation.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>New transaction.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code> - If some unfinished transaction has already started by this thread.</dd>
<dd><code>org.apache.ignite.internal.client.thin.ClientServerError</code></dd>
</dl>
</li>
</ul>
<a name="txStart-org.apache.ignite.transactions.TransactionConcurrency-org.apache.ignite.transactions.TransactionIsolation-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>txStart</h4>
<pre><a href="../../../../org/apache/ignite/client/ClientTransaction.html" title="interface in org.apache.ignite.client">ClientTransaction</a>&nbsp;txStart(<a href="../../../../org/apache/ignite/transactions/TransactionConcurrency.html" title="enum in org.apache.ignite.transactions">TransactionConcurrency</a>&nbsp;concurrency,
<a href="../../../../org/apache/ignite/transactions/TransactionIsolation.html" title="enum in org.apache.ignite.transactions">TransactionIsolation</a>&nbsp;isolation,
long&nbsp;timeout)
throws org.apache.ignite.internal.client.thin.ClientServerError,
<a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></pre>
<div class="block">Starts a new transaction with the specified isolation, concurrency and timeout.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>concurrency</code> - Concurrency.</dd>
<dd><code>isolation</code> - Isolation.</dd>
<dd><code>timeout</code> - Timeout.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>New transaction.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code> - If some unfinished transaction has already started by this thread.</dd>
<dd><code>org.apache.ignite.internal.client.thin.ClientServerError</code></dd>
</dl>
</li>
</ul>
<a name="withLabel-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>withLabel</h4>
<pre><a href="../../../../org/apache/ignite/client/ClientTransactions.html" title="interface in org.apache.ignite.client">ClientTransactions</a>&nbsp;withLabel(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;lb)
throws <a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></pre>
<div class="block">Returns instance of <code>ClientTransactions</code> to mark each new transaction with a specified label.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>lb</code> - Label.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><code>This</code> for chaining.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - If label is null.</dd>
<dd><code><a href="../../../../org/apache/ignite/client/ClientException.html" title="class in org.apache.ignite.client">ClientException</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ClientTransactions.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/ignite/client/ClientTransaction.html" title="interface in org.apache.ignite.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../org/apache/ignite/client/IgniteClient.html" title="interface in org.apache.ignite.client"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/ignite/client/ClientTransactions.html" target="_top">Frames</a></li>
<li><a href="ClientTransactions.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><table width="100%" border="0" cellspacing=0 cellpadding=0 style="padding: 5px"> <tr> <td> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <a target=_blank href="https://ignite.apache.org"><nobr>2022 Copyright &#169; Apache Software Foundation</nobr></a> </td> </tr> </tbody> </table> </td> <td width="100%" align="right" valign="center"> <a href="https://twitter.com/ApacheIgnite" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @ApacheIgnite</a> </td> </tr> <tr> <td colspan="2" valign="top" align="left"> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <b>Ignite Database and Caching Platform</b> </td> <td>:&nbsp;&nbsp; ver. <strong>2.12.0</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>:&nbsp;&nbsp; January 10 2022 </td> </tr> </tbody> </table> </td> </tr> </table></small></p>
</body>
</html>