blob: 17fd22c276846244b45d70886fce5fda9f489296 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: CacheConfiguration</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: CacheConfiguration</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>CacheConfiguration<span class="signature">()</span><span class="type-signature"></span></h2>
<div class="class-description"><p>Class representing Ignite cache configuration on a server.</p>
<p>All configuration settings are optional and have defaults which are defined on a server side.</p>
<p>See Apache Ignite documentation for details of every configuration setting.</p></div>
</header>
<article>
<div class="container-overview">
<h2>Constructor</h2>
<h4 class="name" id="CacheConfiguration"><span class="type-signature"></span>new CacheConfiguration<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Public constructor.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line947">line 947</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id=".CACHE_ATOMICITY_MODE"><span class="type-signature">(static, readonly) </span>CACHE_ATOMICITY_MODE<span class="type-signature"></span></h4>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>TRANSACTIONAL</code></td>
<td class="type">
</td>
<td class="description last"><p>0</p></td>
</tr>
<tr>
<td class="name"><code>ATOMIC</code></td>
<td class="type">
</td>
<td class="description last"><p>1</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line863">line 863</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".CACHE_MODE"><span class="type-signature">(static, readonly) </span>CACHE_MODE<span class="type-signature"></span></h4>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>LOCAL</code></td>
<td class="type">
</td>
<td class="description last"><p>0</p></td>
</tr>
<tr>
<td class="name"><code>REPLICATED</code></td>
<td class="type">
</td>
<td class="description last"><p>1</p></td>
</tr>
<tr>
<td class="name"><code>PARTITIONED</code></td>
<td class="type">
</td>
<td class="description last"><p>2</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line876">line 876</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".PARTITION_LOSS_POLICY"><span class="type-signature">(static, readonly) </span>PARTITION_LOSS_POLICY<span class="type-signature"></span></h4>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>READ_ONLY_SAFE</code></td>
<td class="type">
</td>
<td class="description last"><p>0</p></td>
</tr>
<tr>
<td class="name"><code>READ_ONLY_ALL</code></td>
<td class="type">
</td>
<td class="description last"><p>1</p></td>
</tr>
<tr>
<td class="name"><code>READ_WRITE_SAFE</code></td>
<td class="type">
</td>
<td class="description last"><p>2</p></td>
</tr>
<tr>
<td class="name"><code>READ_WRITE_ALL</code></td>
<td class="type">
</td>
<td class="description last"><p>3</p></td>
</tr>
<tr>
<td class="name"><code>IGNORE</code></td>
<td class="type">
</td>
<td class="description last"><p>4</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line891">line 891</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".REABALANCE_MODE"><span class="type-signature">(static, readonly) </span>REABALANCE_MODE<span class="type-signature"></span></h4>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>SYNC</code></td>
<td class="type">
</td>
<td class="description last"><p>0</p></td>
</tr>
<tr>
<td class="name"><code>ASYNC</code></td>
<td class="type">
</td>
<td class="description last"><p>1</p></td>
</tr>
<tr>
<td class="name"><code>NONE</code></td>
<td class="type">
</td>
<td class="description last"><p>2</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line910">line 910</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".WRITE_SYNCHRONIZATION_MODE"><span class="type-signature">(static, readonly) </span>WRITE_SYNCHRONIZATION_MODE<span class="type-signature"></span></h4>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>FULL_SYNC</code></td>
<td class="type">
</td>
<td class="description last"><p>0</p></td>
</tr>
<tr>
<td class="name"><code>FULL_ASYNC</code></td>
<td class="type">
</td>
<td class="description last"><p>1</p></td>
</tr>
<tr>
<td class="name"><code>PRIMARY_SYNC</code></td>
<td class="type">
</td>
<td class="description last"><p>2</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line925">line 925</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="getAtomicityMode"><span class="type-signature"></span>getAtomicityMode<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html#.CACHE_ATOMICITY_MODE">CacheConfiguration.CACHE_ATOMICITY_MODE</a>}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line998">line 998</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html#.CACHE_ATOMICITY_MODE">CacheConfiguration.CACHE_ATOMICITY_MODE</a></span>
</dd>
</dl>
<h4 class="name" id="getBackups"><span class="type-signature"></span>getBackups<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1019">line 1019</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="getCacheMode"><span class="type-signature"></span>getCacheMode<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html#.CACHE_MODE">CacheConfiguration.CACHE_MODE</a>}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1043">line 1043</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html#.CACHE_MODE">CacheConfiguration.CACHE_MODE</a></span>
</dd>
</dl>
<h4 class="name" id="getCopyOnRead"><span class="type-signature"></span>getCopyOnRead<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1064">line 1064</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="getDataRegionName"><span class="type-signature"></span>getDataRegionName<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1085">line 1085</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="getDefaultLockTimeout"><span class="type-signature"></span>getDefaultLockTimeout<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1169">line 1169</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="getEagerTtl"><span class="type-signature"></span>getEagerTtl<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1106">line 1106</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="getGroupName"><span class="type-signature"></span>getGroupName<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1148">line 1148</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="getIsOnheapCacheEnabled"><span class="type-signature"></span>getIsOnheapCacheEnabled<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1232">line 1232</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="getKeyConfigurations"><span class="type-signature"></span>getKeyConfigurations<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="CacheKeyConfiguration.html">CacheKeyConfiguration</a>>}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1580">line 1580</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="CacheKeyConfiguration.html">CacheKeyConfiguration</a>></span>
</dd>
</dl>
<h4 class="name" id="getMaxConcurrentAsyncOperations"><span class="type-signature"></span>getMaxConcurrentAsyncOperations<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1190">line 1190</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="getMaxQueryIterators"><span class="type-signature"></span>getMaxQueryIterators<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1211">line 1211</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="getPartitionLossPolicy"><span class="type-signature"></span>getPartitionLossPolicy<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html#.PARTITION_LOSS_POLICY">CacheConfiguration.PARTITION_LOSS_POLICY</a>}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1256">line 1256</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html#.PARTITION_LOSS_POLICY">CacheConfiguration.PARTITION_LOSS_POLICY</a></span>
</dd>
</dl>
<h4 class="name" id="getQueryDetailMetricsSize"><span class="type-signature"></span>getQueryDetailMetricsSize<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1277">line 1277</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="getQueryEntities"><span class="type-signature"></span>getQueryEntities<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;<a href="QueryEntity.html">QueryEntity</a>>}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1604">line 1604</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Array.&lt;<a href="QueryEntity.html">QueryEntity</a>></span>
</dd>
</dl>
<h4 class="name" id="getQueryParallelism"><span class="type-signature"></span>getQueryParallelism<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1298">line 1298</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="getReadFromBackup"><span class="type-signature"></span>getReadFromBackup<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1319">line 1319</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="getRebalanceBatchesPrefetchCount"><span class="type-signature"></span>getRebalanceBatchesPrefetchCount<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1361">line 1361</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="getRebalanceBatchSize"><span class="type-signature"></span>getRebalanceBatchSize<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1340">line 1340</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="getRebalanceDelay"><span class="type-signature"></span>getRebalanceDelay<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1382">line 1382</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="getRebalanceMode"><span class="type-signature"></span>getRebalanceMode<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html#.REABALANCE_MODE">CacheConfiguration.REABALANCE_MODE</a>}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1406">line 1406</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html#.REABALANCE_MODE">CacheConfiguration.REABALANCE_MODE</a></span>
</dd>
</dl>
<h4 class="name" id="getRebalanceOrder"><span class="type-signature"></span>getRebalanceOrder<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1427">line 1427</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="getRebalanceThrottle"><span class="type-signature"></span>getRebalanceThrottle<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1448">line 1448</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="getRebalanceTimeout"><span class="type-signature"></span>getRebalanceTimeout<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1469">line 1469</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="getSqlEscapeAll"><span class="type-signature"></span>getSqlEscapeAll<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1490">line 1490</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="getSqlIndexInlineMaxSize"><span class="type-signature"></span>getSqlIndexInlineMaxSize<span class="signature">()</span><span class="type-signature"> &rarr; {number}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1511">line 1511</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">number</span>
</dd>
</dl>
<h4 class="name" id="getSqlSchema"><span class="type-signature"></span>getSqlSchema<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1532">line 1532</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">string</span>
</dd>
</dl>
<h4 class="name" id="getStatisticsEnabled"><span class="type-signature"></span>getStatisticsEnabled<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1127">line 1127</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="getWriteSynchronizationMode"><span class="type-signature"></span>getWriteSynchronizationMode<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html#.WRITE_SYNCHRONIZATION_MODE">CacheConfiguration.WRITE_SYNCHRONIZATION_MODE</a>}</span></h4>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1556">line 1556</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html#.WRITE_SYNCHRONIZATION_MODE">CacheConfiguration.WRITE_SYNCHRONIZATION_MODE</a></span>
</dd>
</dl>
<h4 class="name" id="setAtomicityMode"><span class="type-signature"></span>setAtomicityMode<span class="signature">(atomicityMode)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>atomicityMode</code></td>
<td class="type">
<span class="param-type"><a href="CacheConfiguration.html#.CACHE_ATOMICITY_MODE">CacheConfiguration.CACHE_ATOMICITY_MODE</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line987">line 987</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
<p>if error.</p>
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="IgniteClientError.html">IgniteClientError</a></span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setBackups"><span class="type-signature"></span>setBackups<span class="signature">(backups)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>backups</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1009">line 1009</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setCacheMode"><span class="type-signature"></span>setCacheMode<span class="signature">(cacheMode)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>cacheMode</code></td>
<td class="type">
<span class="param-type"><a href="CacheConfiguration.html#.CACHE_MODE">CacheConfiguration.CACHE_MODE</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1032">line 1032</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
<p>if error.</p>
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="IgniteClientError.html">IgniteClientError</a></span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setCopyOnRead"><span class="type-signature"></span>setCopyOnRead<span class="signature">(copyOnRead)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>copyOnRead</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1054">line 1054</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setDataRegionName"><span class="type-signature"></span>setDataRegionName<span class="signature">(dataRegionName)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>dataRegionName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1075">line 1075</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setDefaultLockTimeout"><span class="type-signature"></span>setDefaultLockTimeout<span class="signature">(lockTimeout)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>lockTimeout</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1159">line 1159</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setEagerTtl"><span class="type-signature"></span>setEagerTtl<span class="signature">(eagerTtl)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>eagerTtl</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1096">line 1096</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setGroupName"><span class="type-signature"></span>setGroupName<span class="signature">(groupName)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>groupName</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1138">line 1138</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setIsOnheapCacheEnabled"><span class="type-signature"></span>setIsOnheapCacheEnabled<span class="signature">(isOnheapCacheEnabled)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>isOnheapCacheEnabled</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1222">line 1222</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setKeyConfigurations"><span class="type-signature"></span>setKeyConfigurations<span class="signature">(&hellip;keyConfigurations)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>keyConfigurations</code></td>
<td class="type">
<span class="param-type"><a href="CacheKeyConfiguration.html">CacheKeyConfiguration</a></span>
</td>
<td class="attributes">
&lt;repeatable><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1569">line 1569</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
<p>if error.</p>
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="IgniteClientError.html">IgniteClientError</a></span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setMaxConcurrentAsyncOperations"><span class="type-signature"></span>setMaxConcurrentAsyncOperations<span class="signature">(maxConcurrentAsyncOperations)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>maxConcurrentAsyncOperations</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1180">line 1180</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setMaxQueryIterators"><span class="type-signature"></span>setMaxQueryIterators<span class="signature">(maxQueryIterators)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>maxQueryIterators</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1201">line 1201</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setPartitionLossPolicy"><span class="type-signature"></span>setPartitionLossPolicy<span class="signature">(partitionLossPolicy)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>partitionLossPolicy</code></td>
<td class="type">
<span class="param-type"><a href="CacheConfiguration.html#.PARTITION_LOSS_POLICY">CacheConfiguration.PARTITION_LOSS_POLICY</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1245">line 1245</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
<p>if error.</p>
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="IgniteClientError.html">IgniteClientError</a></span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setQueryDetailMetricsSize"><span class="type-signature"></span>setQueryDetailMetricsSize<span class="signature">(queryDetailMetricsSize)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>queryDetailMetricsSize</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1267">line 1267</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setQueryEntities"><span class="type-signature"></span>setQueryEntities<span class="signature">(&hellip;queryEntities)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>queryEntities</code></td>
<td class="type">
<span class="param-type"><a href="QueryEntity.html">QueryEntity</a></span>
</td>
<td class="attributes">
&lt;repeatable><br>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1593">line 1593</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
<p>if error.</p>
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="IgniteClientError.html">IgniteClientError</a></span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setQueryParallelism"><span class="type-signature"></span>setQueryParallelism<span class="signature">(queryParallelism)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>queryParallelism</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1288">line 1288</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setReadFromBackup"><span class="type-signature"></span>setReadFromBackup<span class="signature">(readFromBackup)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>readFromBackup</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1309">line 1309</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setRebalanceBatchesPrefetchCount"><span class="type-signature"></span>setRebalanceBatchesPrefetchCount<span class="signature">(rebalanceBatchesPrefetchCount)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>rebalanceBatchesPrefetchCount</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1351">line 1351</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setRebalanceBatchSize"><span class="type-signature"></span>setRebalanceBatchSize<span class="signature">(rebalanceBatchSize)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>rebalanceBatchSize</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1330">line 1330</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setRebalanceDelay"><span class="type-signature"></span>setRebalanceDelay<span class="signature">(rebalanceDelay)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>rebalanceDelay</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1372">line 1372</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setRebalanceMode"><span class="type-signature"></span>setRebalanceMode<span class="signature">(rebalanceMode)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>rebalanceMode</code></td>
<td class="type">
<span class="param-type"><a href="CacheConfiguration.html#.REABALANCE_MODE">CacheConfiguration.REABALANCE_MODE</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1395">line 1395</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
<p>if error.</p>
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="IgniteClientError.html">IgniteClientError</a></span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setRebalanceOrder"><span class="type-signature"></span>setRebalanceOrder<span class="signature">(rebalanceOrder)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>rebalanceOrder</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1417">line 1417</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setRebalanceThrottle"><span class="type-signature"></span>setRebalanceThrottle<span class="signature">(rebalanceThrottle)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>rebalanceThrottle</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1438">line 1438</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setRebalanceTimeout"><span class="type-signature"></span>setRebalanceTimeout<span class="signature">(rebalanceTimeout)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>rebalanceTimeout</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1459">line 1459</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setSqlEscapeAll"><span class="type-signature"></span>setSqlEscapeAll<span class="signature">(sqlEscapeAll)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>sqlEscapeAll</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1480">line 1480</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setSqlIndexInlineMaxSize"><span class="type-signature"></span>setSqlIndexInlineMaxSize<span class="signature">(sqlIndexInlineMaxSize)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>sqlIndexInlineMaxSize</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1501">line 1501</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setSqlSchema"><span class="type-signature"></span>setSqlSchema<span class="signature">(sqlSchema)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>sqlSchema</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1522">line 1522</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setStatisticsEnabled"><span class="type-signature"></span>setStatisticsEnabled<span class="signature">(statisticsEnabled)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>statisticsEnabled</code></td>
<td class="type">
<span class="param-type">boolean</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1117">line 1117</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
<h4 class="name" id="setWriteSynchronizationMode"><span class="type-signature"></span>setWriteSynchronizationMode<span class="signature">(writeSynchronizationMode)</span><span class="type-signature"> &rarr; {<a href="CacheConfiguration.html">CacheConfiguration</a>}</span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>writeSynchronizationMode</code></td>
<td class="type">
<span class="param-type"><a href="CacheConfiguration.html#.WRITE_SYNCHRONIZATION_MODE">CacheConfiguration.WRITE_SYNCHRONIZATION_MODE</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1545">line 1545</a>
</li></ul></dd>
</dl>
<h5>Throws:</h5>
<dl>
<dt>
<div class="param-desc">
<p>if error.</p>
</div>
</dt>
<dd></dd>
<dt>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="IgniteClientError.html">IgniteClientError</a></span>
</dd>
</dl>
</dt>
<dd></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<ul>
<li>the same instance of the CacheConfiguration.</li>
</ul>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type"><a href="CacheConfiguration.html">CacheConfiguration</a></span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BinaryObject.html">BinaryObject</a></li><li><a href="CacheClient.html">CacheClient</a></li><li><a href="CacheConfiguration.html">CacheConfiguration</a></li><li><a href="CacheEntry.html">CacheEntry</a></li><li><a href="CacheKeyConfiguration.html">CacheKeyConfiguration</a></li><li><a href="CollectionObjectType.html">CollectionObjectType</a></li><li><a href="ComplexObjectType.html">ComplexObjectType</a></li><li><a href="CompositeType.html">CompositeType</a></li><li><a href="Cursor.html">Cursor</a></li><li><a href="EnumItem.html">EnumItem</a></li><li><a href="IgniteClient.html">IgniteClient</a></li><li><a href="IgniteClientConfiguration.html">IgniteClientConfiguration</a></li><li><a href="IgniteClientError.html">IgniteClientError</a></li><li><a href="IllegalStateError.html">IllegalStateError</a></li><li><a href="LostConnectionError.html">LostConnectionError</a></li><li><a href="MapObjectType.html">MapObjectType</a></li><li><a href="ObjectArrayType.html">ObjectArrayType</a></li><li><a href="ObjectType.html">ObjectType</a></li><li><a href="OperationError.html">OperationError</a></li><li><a href="Query.html">Query</a></li><li><a href="QueryEntity.html">QueryEntity</a></li><li><a href="QueryField.html">QueryField</a></li><li><a href="QueryIndex.html">QueryIndex</a></li><li><a href="ScanQuery.html">ScanQuery</a></li><li><a href="SqlFieldsCursor.html">SqlFieldsCursor</a></li><li><a href="SqlFieldsQuery.html">SqlFieldsQuery</a></li><li><a href="SqlQuery.html">SqlQuery</a></li><li><a href="Timestamp.html">Timestamp</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue May 22 2018 12:08:49 GMT+0300 (Russia TZ 2 Standard Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>