You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ignite.apache.org by is...@apache.org on 2019/04/16 14:34:48 UTC
[ignite] branch master updated: IGNITE-11748: Removed autogenerated
Node.js docs
This is an automated email from the ASF dual-hosted git repository.
isapego pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/ignite.git
The following commit(s) were added to refs/heads/master by this push:
new 42c01da IGNITE-11748: Removed autogenerated Node.js docs
42c01da is described below
commit 42c01da5c94240e47558bcc7d9f0b6d7177604c8
Author: Igor Sapego <is...@apache.org>
AuthorDate: Tue Apr 16 17:32:58 2019 +0300
IGNITE-11748: Removed autogenerated Node.js docs
This closes #6459
---
.../platforms/nodejs/api_spec/BinaryObject.html | 1847 -----
.../platforms/nodejs/api_spec/BinaryObject.js.html | 549 --
modules/platforms/nodejs/api_spec/CacheClient.html | 4867 -----------
.../platforms/nodejs/api_spec/CacheClient.js.html | 812 --
.../nodejs/api_spec/CacheConfiguration.html | 8527 --------------------
.../nodejs/api_spec/CacheConfiguration.js.html | 1784 ----
modules/platforms/nodejs/api_spec/CacheEntry.html | 468 --
.../nodejs/api_spec/CacheKeyConfiguration.html | 796 --
.../nodejs/api_spec/CollectionObjectType.html | 524 --
.../nodejs/api_spec/ComplexObjectType.html | 526 --
.../platforms/nodejs/api_spec/CompositeType.html | 170 -
modules/platforms/nodejs/api_spec/Cursor.html | 588 --
modules/platforms/nodejs/api_spec/Cursor.js.html | 360 -
modules/platforms/nodejs/api_spec/EnumItem.html | 1431 ----
modules/platforms/nodejs/api_spec/EnumItem.js.html | 255 -
modules/platforms/nodejs/api_spec/Errors.js.html | 172 -
.../platforms/nodejs/api_spec/IgniteClient.html | 2368 ------
.../platforms/nodejs/api_spec/IgniteClient.js.html | 343 -
.../nodejs/api_spec/IgniteClientConfiguration.html | 846 --
.../api_spec/IgniteClientConfiguration.js.html | 163 -
.../nodejs/api_spec/IgniteClientError.html | 168 -
.../nodejs/api_spec/IllegalStateError.html | 179 -
.../nodejs/api_spec/LostConnectionError.html | 179 -
.../platforms/nodejs/api_spec/MapObjectType.html | 485 --
.../platforms/nodejs/api_spec/ObjectArrayType.html | 265 -
modules/platforms/nodejs/api_spec/ObjectType.html | 1126 ---
.../platforms/nodejs/api_spec/ObjectType.js.html | 651 --
.../platforms/nodejs/api_spec/OperationError.html | 179 -
modules/platforms/nodejs/api_spec/Query.html | 481 --
modules/platforms/nodejs/api_spec/Query.js.html | 559 --
modules/platforms/nodejs/api_spec/QueryEntity.html | 2218 -----
modules/platforms/nodejs/api_spec/QueryField.html | 2211 -----
modules/platforms/nodejs/api_spec/QueryIndex.html | 1480 ----
modules/platforms/nodejs/api_spec/ScanQuery.html | 686 --
.../platforms/nodejs/api_spec/SqlFieldsCursor.html | 915 ---
.../platforms/nodejs/api_spec/SqlFieldsQuery.html | 3036 -------
modules/platforms/nodejs/api_spec/SqlQuery.html | 1755 ----
modules/platforms/nodejs/api_spec/Timestamp.html | 566 --
.../platforms/nodejs/api_spec/Timestamp.js.html | 127 -
.../api_spec/fonts/OpenSans-Bold-webfont.eot | Bin 19544 -> 0 bytes
.../api_spec/fonts/OpenSans-Bold-webfont.svg | 1830 -----
.../api_spec/fonts/OpenSans-Bold-webfont.woff | Bin 22432 -> 0 bytes
.../api_spec/fonts/OpenSans-BoldItalic-webfont.eot | Bin 20133 -> 0 bytes
.../api_spec/fonts/OpenSans-BoldItalic-webfont.svg | 1830 -----
.../fonts/OpenSans-BoldItalic-webfont.woff | Bin 23048 -> 0 bytes
.../api_spec/fonts/OpenSans-Italic-webfont.eot | Bin 20265 -> 0 bytes
.../api_spec/fonts/OpenSans-Italic-webfont.svg | 1830 -----
.../api_spec/fonts/OpenSans-Italic-webfont.woff | Bin 23188 -> 0 bytes
.../api_spec/fonts/OpenSans-Light-webfont.eot | Bin 19514 -> 0 bytes
.../api_spec/fonts/OpenSans-Light-webfont.svg | 1831 -----
.../api_spec/fonts/OpenSans-Light-webfont.woff | Bin 22248 -> 0 bytes
.../fonts/OpenSans-LightItalic-webfont.eot | Bin 20535 -> 0 bytes
.../fonts/OpenSans-LightItalic-webfont.svg | 1835 -----
.../fonts/OpenSans-LightItalic-webfont.woff | Bin 23400 -> 0 bytes
.../api_spec/fonts/OpenSans-Regular-webfont.eot | Bin 19836 -> 0 bytes
.../api_spec/fonts/OpenSans-Regular-webfont.svg | 1831 -----
.../api_spec/fonts/OpenSans-Regular-webfont.woff | Bin 22660 -> 0 bytes
modules/platforms/nodejs/api_spec/index.html | 65 -
.../nodejs/api_spec/scripts/linenumber.js | 25 -
.../scripts/prettify/Apache-License-2.0.txt | 202 -
.../nodejs/api_spec/scripts/prettify/lang-css.js | 2 -
.../nodejs/api_spec/scripts/prettify/prettify.js | 28 -
.../nodejs/api_spec/styles/jsdoc-default.css | 358 -
.../nodejs/api_spec/styles/prettify-jsdoc.css | 111 -
.../nodejs/api_spec/styles/prettify-tomorrow.css | 132 -
65 files changed, 56572 deletions(-)
diff --git a/modules/platforms/nodejs/api_spec/BinaryObject.html b/modules/platforms/nodejs/api_spec/BinaryObject.html
deleted file mode 100644
index a387c1e..0000000
--- a/modules/platforms/nodejs/api_spec/BinaryObject.html
+++ /dev/null
@@ -1,1847 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
- <meta charset="utf-8">
- <title>JSDoc: Class: BinaryObject</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: BinaryObject</h1>
-
-
-
-
-
-
-<section>
-
-<header>
-
- <h2><span class="attribs"><span class="type-signature"></span></span>BinaryObject<span class="signature">(typeName)</span><span class="type-signature"></span></h2>
-
- <div class="class-description"><p>Class representing a complex Ignite object in the binary form.</p>
-<p>It corresponds to COMPOSITE_TYPE.COMPLEX_OBJECT <a href="ObjectType.html#.COMPOSITE_TYPE">ObjectType.COMPOSITE_TYPE</a>,
-has mandatory type Id, which corresponds to a name of the complex type,
-and includes optional fields.</p>
-<p>An instance of the BinaryObject can be obtained/created by the following ways:</p>
-<ul>
-<li>returned by the client when a complex object is received from Ignite cache
-and is not deserialized to another JavaScript object.</li>
-<li>created using the public constructor. Fields may be added to such an instance using setField() method.</li>
-<li>created from a JavaScript object using static fromObject() method.</li>
-</ul></div>
-
-
-</header>
-
-<article>
- <div class="container-overview">
-
-
-
-
- <h2>Constructor</h2>
-
-
-
- <h4 class="name" id="BinaryObject"><span class="type-signature"></span>new BinaryObject<span class="signature">(typeName)</span><span class="type-signature"></span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Creates an instance of the BinaryObject without any fields.</p>
-<p>Fields may be added later using setField() method.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>typeName</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">string</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>name of the complex type to generate the type Id.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="BinaryObject.js.html">BinaryObject.js</a>, <a href="BinaryObject.js.html#line61">line 61</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h3 class="subsection-title">Methods</h3>
-
-
-
-
-
-
-
- <h4 class="name" id=".fromObject"><span class="type-signature">(async, static) </span>fromObject<span class="signature">(jsObject, complexObjectType<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="BinaryObject.html">BinaryObject</a>}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Creates an instance of the BinaryObject from the specified instance of JavaScript Object.</p>
-<p>All fields of the JavaScript Object instance with their values are added to the BinaryObject.
-Fields may be added or removed later using setField() and removeField() methods.</p>
-<p>If complexObjectType parameter is specified, then the type Id is taken from it.
-Otherwise, the type Id is generated from the name of the JavaScript Object.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <h5>Parameters:</h5>
-
-
-<table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
- <th>Attributes</th>
-
-
-
- <th>Default</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
- <tr>
-
- <td class="name"><code>jsObject</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">object</span>
-
-
-
- </td>
-
-
- <td class="attributes">
-
-
-
-
-
- </td>
-
-
-
- <td class="default">
-
- </td>
-
-
- <td class="description last"><p>instance of JavaScript Object
- which adds and initializes the fields of the BinaryObject instance.</p></td>
- </tr>
-
-
-
- <tr>
-
- <td class="name"><code>complexObjectType</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type"><a href="ComplexObjectType.html">ComplexObjectType</a></span>
-
-
-
- </td>
-
-
- <td class="attributes">
-
- <optional><br>
-
-
-
-
-
- </td>
-
-
-
- <td class="default">
-
- null
-
- </td>
-
-
- <td class="description last"><p>instance of complex type definition
- which specifies non-standard mapping of the fields of the BinaryObject instance
- to/from the Ignite types.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="BinaryObject.js.html">BinaryObject.js</a>, <a href="BinaryObject.js.html#line105">line 105</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>new BinaryObject instance.</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type"><a href="BinaryObject.html">BinaryObject</a></span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="getField"><span class="type-signature">(async) </span>getField<span class="signature">(fieldName, fieldType<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {*}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Returns a value of the specified field.</p>
-<p>Optionally, specifies a type of the field.
-If the type is not specified then the Ignite client
-will try to make automatic mapping between JavaScript types and Ignite object types -
-according to the mapping table defined in the description of the <a href="ObjectType.html">ObjectType</a> class.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <h5>Parameters:</h5>
-
-
-<table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
- <th>Attributes</th>
-
-
-
- <th>Default</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
- <tr>
-
- <td class="name"><code>fieldName</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">string</span>
-
-
-
- </td>
-
-
- <td class="attributes">
-
-
-
-
-
- </td>
-
-
-
- <td class="default">
-
- </td>
-
-
- <td class="description last"><p>name of the field.</p></td>
- </tr>
-
-
-
- <tr>
-
- <td class="name"><code>fieldType</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type"><a href="ObjectType.html#.PRIMITIVE_TYPE">ObjectType.PRIMITIVE_TYPE</a></span>
-|
-
-<span class="param-type"><a href="CompositeType.html">CompositeType</a></span>
-
-
-
- </td>
-
-
- <td class="attributes">
-
- <optional><br>
-
-
-
-
-
- </td>
-
-
-
- <td class="default">
-
- null
-
- </td>
-
-
- <td class="description last"><p>type of the field:</p>
-<ul>
-<li>either a type code of primitive (simple) type</li>
-<li>or an instance of class representing non-primitive (composite) type</li>
-<li>or null (or not specified) that means the type is not specified.</li>
-</ul></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="BinaryObject.js.html">BinaryObject.js</a>, <a href="BinaryObject.js.html#line209">line 209</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>value of the field or JavaScript undefined if the field does not exist.</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type">*</span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="getFieldNames"><span class="type-signature"></span>getFieldNames<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Returns names of all fields of this BinaryObject instance.</p>
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="BinaryObject.js.html">BinaryObject.js</a>, <a href="BinaryObject.js.html#line261">line 261</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>names of all fields.</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type">Array.<string></span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="getTypeName"><span class="type-signature"></span>getTypeName<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Returns type name of this BinaryObject instance.</p>
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="BinaryObject.js.html">BinaryObject.js</a>, <a href="BinaryObject.js.html#line250">line 250</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-<h5>Returns:</h5>
-
-
-<div class="param-desc">
- <ul>
-<li>type name.</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type">string</span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="hasField"><span class="type-signature"></span>hasField<span class="signature">(fieldName)</span><span class="type-signature"> → {boolean}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Checks if the specified field exists in this BinaryObject instance.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>fieldName</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">string</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>name of the field.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="BinaryObject.js.html">BinaryObject.js</a>, <a href="BinaryObject.js.html#line184">line 184</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>true if exists, false otherwise.</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type">boolean</span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="removeField"><span class="type-signature"></span>removeField<span class="signature">(fieldName)</span><span class="type-signature"> → {<a href="BinaryObject.html">BinaryObject</a>}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Removes the specified field.
-Does nothing if the field does not exist.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>fieldName</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">string</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>name of the field.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="BinaryObject.js.html">BinaryObject.js</a>, <a href="BinaryObject.js.html#line167">line 167</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 BinaryObject</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type"><a href="BinaryObject.html">BinaryObject</a></span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="setField"><span class="type-signature"></span>setField<span class="signature">(fieldName, fieldValue, fieldType<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="BinaryObject.html">BinaryObject</a>}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Sets the new value of the specified field.
-Adds the specified field, if it did not exist before.</p>
-<p>Optionally, specifies a type of the field.
-If the type is not specified then during operations the Ignite client
-will try to make automatic mapping between JavaScript types and Ignite object types -
-according to the mapping table defined in the description of the <a href="ObjectType.html">ObjectType</a> class.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <h5>Parameters:</h5>
-
-
-<table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
-
- <th>Type</th>
-
-
- <th>Attributes</th>
-
-
-
- <th>Default</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
-
- <tbody>
-
-
- <tr>
-
- <td class="name"><code>fieldName</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">string</span>
-
-
-
- </td>
-
-
- <td class="attributes">
-
-
-
-
-
- </td>
-
-
-
- <td class="default">
-
- </td>
-
-
- <td class="description last"><p>name of the field.</p></td>
- </tr>
-
-
-
- <tr>
-
- <td class="name"><code>fieldValue</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
- <td class="attributes">
-
-
-
-
-
- </td>
-
-
-
- <td class="default">
-
- </td>
-
-
- <td class="description last"><p>new value of the field.</p></td>
- </tr>
-
-
-
- <tr>
-
- <td class="name"><code>fieldType</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type"><a href="ObjectType.html#.PRIMITIVE_TYPE">ObjectType.PRIMITIVE_TYPE</a></span>
-|
-
-<span class="param-type"><a href="CompositeType.html">CompositeType</a></span>
-
-
-
- </td>
-
-
- <td class="attributes">
-
- <optional><br>
-
-
-
-
-
- </td>
-
-
-
- <td class="default">
-
- null
-
- </td>
-
-
- <td class="description last"><p>type of the field:</p>
-<ul>
-<li>either a type code of primitive (simple) type</li>
-<li>or an instance of class representing non-primitive (composite) type</li>
-<li>or null (or not specified) that means the type is not specified.</li>
-</ul></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="BinaryObject.js.html">BinaryObject.js</a>, <a href="BinaryObject.js.html#line148">line 148</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 BinaryObject</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type"><a href="BinaryObject.html">BinaryObject</a></span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="toObject"><span class="type-signature">(async) </span>toObject<span class="signature">(complexObjectType)</span><span class="type-signature"> → {object}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Deserializes this BinaryObject instance into an instance of the specified complex object type.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>complexObjectType</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type"><a href="ComplexObjectType.html">ComplexObjectType</a></span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>instance of class representing complex object type.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="BinaryObject.js.html">BinaryObject.js</a>, <a href="BinaryObject.js.html#line227">line 227</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>instance of the JavaScript object
-which corresponds to the specified complex object type.</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type">object</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 hr [...]
-</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:48 GMT+0300 (Russia TZ 2 Standard Time)
-</footer>
-
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>
\ No newline at end of file
diff --git a/modules/platforms/nodejs/api_spec/BinaryObject.js.html b/modules/platforms/nodejs/api_spec/BinaryObject.js.html
deleted file mode 100644
index 4479a26..0000000
--- a/modules/platforms/nodejs/api_spec/BinaryObject.js.html
+++ /dev/null
@@ -1,549 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
- <meta charset="utf-8">
- <title>JSDoc: Source: BinaryObject.js</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">Source: BinaryObject.js</h1>
-
-
-
-
-
-
- <section>
- <article>
- <pre class="prettyprint source linenums"><code>/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-'use strict';
-
-const Util = require('util');
-const ObjectType = require('./ObjectType').ObjectType;
-const ComplexObjectType = require('./ObjectType').ComplexObjectType;
-const Errors = require('./Errors');
-const BinaryUtils = require('./internal/BinaryUtils');
-const BinaryType = require('./internal/BinaryType');
-const BinaryField = require('./internal/BinaryType').BinaryField;
-const BinaryTypeBuilder = require('./internal/BinaryType').BinaryTypeBuilder;
-const BinaryWriter = require('./internal/BinaryWriter');
-const ArgumentChecker = require('./internal/ArgumentChecker');
-const Logger = require('./internal/Logger');
-
-const HEADER_LENGTH = 24;
-const VERSION = 1;
-
-// user type
-const FLAG_USER_TYPE = 0x0001;
-// schema exists
-const FLAG_HAS_SCHEMA = 0x0002;
-// object contains raw data
-const FLAG_HAS_RAW_DATA = 0x0004;
-// offsets take 1 byte
-const FLAG_OFFSET_ONE_BYTE = 0x0008;
-// offsets take 2 bytes
-const FLAG_OFFSET_TWO_BYTES = 0x0010;
-// compact footer, no field IDs
-const FLAG_COMPACT_FOOTER = 0x0020;
-
-/**
- * Class representing a complex Ignite object in the binary form.
- *
- * It corresponds to COMPOSITE_TYPE.COMPLEX_OBJECT {@link ObjectType.COMPOSITE_TYPE},
- * has mandatory type Id, which corresponds to a name of the complex type,
- * and includes optional fields.
- *
- * An instance of the BinaryObject can be obtained/created by the following ways:
- * - returned by the client when a complex object is received from Ignite cache
- * and is not deserialized to another JavaScript object.
- * - created using the public constructor. Fields may be added to such an instance using setField() method.
- * - created from a JavaScript object using static fromObject() method.
- */
-class BinaryObject {
-
- /**
- * Creates an instance of the BinaryObject without any fields.
- *
- * Fields may be added later using setField() method.
- *
- * @param {string} typeName - name of the complex type to generate the type Id.
- *
- * @return {BinaryObject} - new BinaryObject instance.
- *
- * @throws {IgniteClientError} if error.
- */
- constructor(typeName) {
- ArgumentChecker.notEmpty(typeName, 'typeName');
- this._buffer = null;
- this._fields = new Map();
- this._typeBuilder = BinaryTypeBuilder.fromTypeName(typeName);
- this._modified = false;
- this._schemaOffset = null;
- this._compactFooter = false;
- }
-
- /**
- * Creates an instance of the BinaryObject from the specified instance of JavaScript Object.
- *
- * All fields of the JavaScript Object instance with their values are added to the BinaryObject.
- * Fields may be added or removed later using setField() and removeField() methods.
- *
- * If complexObjectType parameter is specified, then the type Id is taken from it.
- * Otherwise, the type Id is generated from the name of the JavaScript Object.
- *
- * @async
- *
- * @param {object} jsObject - instance of JavaScript Object
- * which adds and initializes the fields of the BinaryObject instance.
- * @param {ComplexObjectType} [complexObjectType] - instance of complex type definition
- * which specifies non-standard mapping of the fields of the BinaryObject instance
- * to/from the Ignite types.
- *
- * @return {BinaryObject} - new BinaryObject instance.
- *
- * @throws {IgniteClientError} if error.
- */
- static async fromObject(jsObject, complexObjectType = null) {
- ArgumentChecker.notEmpty(jsObject, 'jsObject');
- ArgumentChecker.hasType(complexObjectType, 'complexObjectType', false, ComplexObjectType);
- const typeBuilder = BinaryTypeBuilder.fromObject(jsObject, complexObjectType);
- const result = new BinaryObject(typeBuilder.getTypeName());
- result._typeBuilder = typeBuilder;
- let fieldName;
- for (let field of result._typeBuilder.getFields()) {
- fieldName = field.name;
- if (jsObject && jsObject[fieldName] !== undefined) {
- result.setField(
- fieldName,
- jsObject[fieldName],
- complexObjectType ? complexObjectType._getFieldType(fieldName) : null);
- }
- else {
- throw Errors.IgniteClientError.serializationError(
- true, Util.format('field "%s" is undefined', fieldName));
- }
- }
- return result;
- }
-
- /**
- * Sets the new value of the specified field.
- * Adds the specified field, if it did not exist before.
- *
- * Optionally, specifies a type of the field.
- * If the type is not specified then during operations the Ignite client
- * will try to make automatic mapping between JavaScript types and Ignite object types -
- * according to the mapping table defined in the description of the {@link ObjectType} class.
- *
- * @param {string} fieldName - name of the field.
- * @param {*} fieldValue - new value of the field.
- * @param {ObjectType.PRIMITIVE_TYPE | CompositeType} [fieldType] - type of the field:
- * - either a type code of primitive (simple) type
- * - or an instance of class representing non-primitive (composite) type
- * - or null (or not specified) that means the type is not specified.
- *
- * @return {BinaryObject} - the same instance of BinaryObject
- *
- * @throws {IgniteClientError} if error.
- */
- setField(fieldName, fieldValue, fieldType = null) {
- ArgumentChecker.notEmpty(fieldName, 'fieldName');
- this._modified = true;
- const field = new BinaryObjectField(fieldName, fieldValue, fieldType);
- this._fields.set(field.id, field);
- this._typeBuilder.setField(fieldName, field.typeCode);
- return this;
- }
-
- /**
- * Removes the specified field.
- * Does nothing if the field does not exist.
- *
- * @param {string} fieldName - name of the field.
- *
- * @return {BinaryObject} - the same instance of BinaryObject
- *
- * @throws {IgniteClientError} if error.
- */
- removeField(fieldName) {
- ArgumentChecker.notEmpty(fieldName, 'fieldName');
- this._modified = true;
- this._fields.delete(BinaryField._calculateId(fieldName));
- this._typeBuilder.removeField(fieldName);
- return this;
- }
-
- /**
- * Checks if the specified field exists in this BinaryObject instance.
- *
- * @param {string} fieldName - name of the field.
- *
- * @return {boolean} - true if exists, false otherwise.
- *
- * @throws {IgniteClientError} if error.
- */
- hasField(fieldName) {
- ArgumentChecker.notEmpty(fieldName, 'fieldName');
- return this._fields.has(BinaryField._calculateId(fieldName));
- }
-
- /**
- * Returns a value of the specified field.
- *
- * Optionally, specifies a type of the field.
- * If the type is not specified then the Ignite client
- * will try to make automatic mapping between JavaScript types and Ignite object types -
- * according to the mapping table defined in the description of the {@link ObjectType} class.
- *
- * @async
- *
- * @param {string} fieldName - name of the field.
- * @param {ObjectType.PRIMITIVE_TYPE | CompositeType} [fieldType] - type of the field:
- * - either a type code of primitive (simple) type
- * - or an instance of class representing non-primitive (composite) type
- * - or null (or not specified) that means the type is not specified.
- *
- * @return {*} - value of the field or JavaScript undefined if the field does not exist.
- *
- * @throws {IgniteClientError} if error.
- */
- async getField(fieldName, fieldType = null) {
- ArgumentChecker.notEmpty(fieldName, 'fieldName');
- const field = this._fields.get(BinaryField._calculateId(fieldName));
- return field ? await field.getValue(fieldType) : undefined;
- }
-
- /**
- * Deserializes this BinaryObject instance into an instance of the specified complex object type.
- *
- * @async
- *
- * @param {ComplexObjectType} complexObjectType - instance of class representing complex object type.
- *
- * @return {object} - instance of the JavaScript object
- * which corresponds to the specified complex object type.
- *
- * @throws {IgniteClientError} if error.
- */
- async toObject(complexObjectType) {
- ArgumentChecker.notNull(complexObjectType, 'complexObjectType');
- ArgumentChecker.hasType(complexObjectType, 'complexObjectType', false, ComplexObjectType);
- const result = new (complexObjectType._objectConstructor);
- let binaryField;
- let fieldName;
- for (let field of this._fields.values()) {
- binaryField = this._typeBuilder.getField(field.id);
- if (!binaryField) {
- throw Errors.IgniteClientError.serializationError(
- false, Util.format('field with id "%s" can not be deserialized', field.id));
- }
- fieldName = binaryField.name;
- result[fieldName] = await field.getValue(complexObjectType._getFieldType(fieldName));
- }
- return result;
- }
-
- /**
- * Returns type name of this BinaryObject instance.
- *
- * @return {string} - type name.
- */
- getTypeName() {
- return this._typeBuilder.getTypeName();
- }
-
- /**
- * Returns names of all fields of this BinaryObject instance.
- *
- * @return {Array<string>} - names of all fields.
- *
- * @throws {IgniteClientError} if error.
- */
- getFieldNames() {
- return this._typeBuilder._schema.fieldIds.map(fieldId => {
- const field = this._typeBuilder.getField(fieldId);
- if (field) {
- return field.name;
- }
- else {
- throw Errors.IgniteClientError.internalError(
- Util.format('Field "%s" is absent in binary type fields', fieldId));
- }
- });
- }
-
- /** Private methods */
-
- /**
- * @ignore
- */
- static _isFlagSet(flags, flag) {
- return (flags & flag) === flag;
- }
-
- /**
- * @ignore
- */
- static async _fromBuffer(buffer) {
- const result = new BinaryObject(new ComplexObjectType({})._typeName);
- result._buffer = buffer;
- result._startPos = buffer.position;
- await result._read();
- return result;
- }
-
- /**
- * @ignore
- */
- async _write(buffer) {
- if (this._buffer && !this._modified) {
- buffer.writeBuffer(this._buffer.buffer, this._startPos, this._startPos + this._length);
- }
- else {
- await this._typeBuilder.finalize();
- this._startPos = buffer.position;
- buffer.position = this._startPos + HEADER_LENGTH;
- // write fields
- for (let field of this._fields.values()) {
- await field._writeValue(buffer, this._typeBuilder.getField(field.id).typeCode);
- }
- this._schemaOffset = buffer.position - this._startPos;
- // write schema
- for (let field of this._fields.values()) {
- field._writeOffset(buffer, this._startPos);
- }
- this._length = buffer.position - this._startPos;
- this._buffer = buffer;
- // write header
- this._writeHeader();
- this._buffer.position = this._startPos + this._length;
- this._modified = false;
- }
-
- if (Logger.debug) {
- Logger.logDebug('BinaryObject._write [' + [...this._buffer.getSlice(this._startPos, this._startPos + this._length)] + ']');
- }
- }
-
- /**
- * @ignore
- */
- _writeHeader() {
- this._buffer.position = this._startPos;
- // type code
- this._buffer.writeByte(BinaryUtils.TYPE_CODE.COMPLEX_OBJECT);
- // version
- this._buffer.writeByte(VERSION);
- // flags
- this._buffer.writeShort(FLAG_USER_TYPE | FLAG_HAS_SCHEMA | FLAG_COMPACT_FOOTER);
- // type id
- this._buffer.writeInteger(this._typeBuilder.getTypeId());
- // hash code
- this._buffer.writeInteger(BinaryUtils.contentHashCode(
- this._buffer, this._startPos + HEADER_LENGTH, this._schemaOffset - 1));
- // length
- this._buffer.writeInteger(this._length);
- // schema id
- this._buffer.writeInteger(this._typeBuilder.getSchemaId());
- // schema offset
- this._buffer.writeInteger(this._schemaOffset);
- }
-
- /**
- * @ignore
- */
- async _read() {
- await this._readHeader();
- this._buffer.position = this._startPos + this._schemaOffset;
- const fieldOffsets = new Array();
- const fieldIds = this._typeBuilder._schema.fieldIds;
- let index = 0;
- let fieldId;
- while (this._buffer.position < this._startPos + this._length) {
- if (!this._compactFooter) {
- fieldId = this._buffer.readInteger();
- this._typeBuilder._schema.addField(fieldId);
- }
- else {
- if (index >= fieldIds.length) {
- throw Errors.IgniteClientError.serializationError(
- false, 'wrong number of fields in schema');
- }
- fieldId = fieldIds[index];
- index++;
- }
- fieldOffsets.push([fieldId, this._buffer.readNumber(this._offsetType)]);
- }
- fieldOffsets.sort((val1, val2) => val1[1] - val2[1]);
- let offset;
- let nextOffset;
- let field;
- for (let i = 0; i < fieldOffsets.length; i++) {
- fieldId = fieldOffsets[i][0];
- offset = fieldOffsets[i][1];
- nextOffset = i + 1 < fieldOffsets.length ? fieldOffsets[i + 1][1] : this._schemaOffset;
- field = BinaryObjectField._fromBuffer(
- this._buffer, this._startPos + offset, nextOffset - offset, fieldId);
- this._fields.set(field.id, field);
- }
- this._buffer.position = this._startPos + this._length;
- }
-
- /**
- * @ignore
- */
- async _readHeader() {
- // type code
- this._buffer.readByte();
- // version
- const version = this._buffer.readByte();
- if (version !== VERSION) {
- throw Errors.IgniteClientError.internalError();
- }
- // flags
- const flags = this._buffer.readShort();
- // type id
- const typeId = this._buffer.readInteger();
- // hash code
- this._buffer.readInteger();
- // length
- this._length = this._buffer.readInteger();
- // schema id
- const schemaId = this._buffer.readInteger();
- // schema offset
- this._schemaOffset = this._buffer.readInteger();
- const hasSchema = BinaryObject._isFlagSet(flags, FLAG_HAS_SCHEMA);
- this._compactFooter = BinaryObject._isFlagSet(flags, FLAG_COMPACT_FOOTER);
- this._offsetType = BinaryObject._isFlagSet(flags, FLAG_OFFSET_ONE_BYTE) ?
- BinaryUtils.TYPE_CODE.BYTE :
- BinaryObject._isFlagSet(flags, FLAG_OFFSET_TWO_BYTES) ?
- BinaryUtils.TYPE_CODE.SHORT :
- BinaryUtils.TYPE_CODE.INTEGER;
-
- if (BinaryObject._isFlagSet(FLAG_HAS_RAW_DATA)) {
- throw Errors.IgniteClientError.serializationError(
- false, 'complex objects with raw data are not supported');
- }
- if (this._compactFooter && !hasSchema) {
- throw Errors.IgniteClientError.serializationError(
- false, 'schema is absent for object with compact footer');
- }
- this._typeBuilder = await BinaryTypeBuilder.fromTypeId(typeId, schemaId, hasSchema);
- }
-}
-
-/**
- * @ignore
- */
-class BinaryObjectField {
- constructor(name, value = undefined, type = null) {
- this._name = name;
- this._id = BinaryField._calculateId(name);
- this._value = value;
- this._type = type;
- if (!type && value !== undefined && value !== null) {
- this._type = BinaryUtils.calcObjectType(value);
- }
- this._typeCode = null;
- if (this._type) {
- this._typeCode = BinaryUtils.getTypeCode(this._type);
- }
- }
-
- get id() {
- return this._id;
- }
-
- get typeCode() {
- return this._typeCode;
- }
-
- async getValue(type = null) {
- if (this._value === undefined || this._buffer && this._type !== type) {
- this._buffer.position = this._offset;
- const BinaryReader = require('./internal/BinaryReader');
- this._value = await BinaryReader.readObject(this._buffer, type);
- this._type = type;
- }
- return this._value;
- }
-
- static _fromBuffer(buffer, offset, length, id) {
- const result = new BinaryObjectField(null);
- result._id = id;
- result._buffer = buffer;
- result._offset = offset;
- result._length = length;
- return result;
- }
-
- async _writeValue(buffer, expectedTypeCode) {
- const offset = buffer.position;
- if (this._buffer) {
- buffer.writeBuffer(this._buffer.buffer, this._offset, this._offset + this._length);
- }
- else {
- BinaryUtils.checkCompatibility(this._value, expectedTypeCode);
- await BinaryWriter.writeObject(buffer, this._value, this._type);
- }
- this._buffer = buffer;
- this._length = buffer.position - offset;
- this._offset = offset;
- }
-
- _writeOffset(buffer, headerStartPos) {
- buffer.writeInteger(this._offset - headerStartPos);
- }
-}
-
-module.exports = BinaryObject;
-</code></pre>
- </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 hr [...]
-</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:48 GMT+0300 (Russia TZ 2 Standard Time)
-</footer>
-
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>
diff --git a/modules/platforms/nodejs/api_spec/CacheClient.html b/modules/platforms/nodejs/api_spec/CacheClient.html
deleted file mode 100644
index 9525878..0000000
--- a/modules/platforms/nodejs/api_spec/CacheClient.html
+++ /dev/null
@@ -1,4867 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
- <meta charset="utf-8">
- <title>JSDoc: Class: CacheClient</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: CacheClient</h1>
-
-
-
-
-
-
-<section>
-
-<header>
-
- <h2><span class="attribs"><span class="type-signature"></span></span>CacheClient</h2>
-
- <div class="class-description"><p>Class representing and providing access to Ignite cache.</p>
-<p>The class has no public constructor. An instance of this class should be obtained
-via the methods of <a href="IgniteClient.html">IgniteClient</a> objects.
-One instance of this class provides access to one Ignite cache which is specified
-during the instance obtaining and cannot be changed after that.</p>
-<p>There are three groups of methods in the cache client:</p>
-<ul>
-<li>methods to configure the cache client</li>
-<li>methods to operate with the cache using Key-Value Queries</li>
-<li>methods to operate with the cache using SQL and Scan Queries</li>
-</ul></div>
-
-
-</header>
-
-<article>
- <div class="container-overview">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line60">line 60</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h3 class="subsection-title">Members</h3>
-
-
-
-<h4 class="name" id=".PEEK_MODE"><span class="type-signature">(static, readonly) </span>PEEK_MODE<span class="type-signature"></span></h4>
-
-
-
-
-<div class="description">
- <p>Peek modes</p>
-</div>
-
-
-
-
-
-
-
- <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>ALL</code></td>
-
-
- <td class="type">
-
- </td>
-
-
-
-
-
- <td class="description last"><p>0</p></td>
- </tr>
-
-
-
- <tr>
-
- <td class="name"><code>NEAR</code></td>
-
-
- <td class="type">
-
- </td>
-
-
-
-
-
- <td class="description last"><p>1</p></td>
- </tr>
-
-
-
- <tr>
-
- <td class="name"><code>PRIMARY</code></td>
-
-
- <td class="type">
-
- </td>
-
-
-
-
-
- <td class="description last"><p>2</p></td>
- </tr>
-
-
-
- <tr>
-
- <td class="name"><code>BACKUP</code></td>
-
-
- <td class="type">
-
- </td>
-
-
-
-
-
- <td class="description last"><p>3</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line28">line 28</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-</dl>
-
-
-
-
-
-
-
-
-
-
- <h3 class="subsection-title">Methods</h3>
-
-
-
-
-
-
-
- <h4 class="name" id="clear"><span class="type-signature">(async) </span>clear<span class="signature">()</span><span class="type-signature"></span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Removes all entries from the cache, without notifying listeners and cache writers.</p>
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line397">line 397</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>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="clearKey"><span class="type-signature">(async) </span>clearKey<span class="signature">(key)</span><span class="type-signature"></span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Removes entry with the specified key from the cache, without notifying listeners and cache writers.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>key</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>key to be removed.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line414">line 414</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>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="clearKeys"><span class="type-signature">(async) </span>clearKeys<span class="signature">(keys)</span><span class="type-signature"></span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Removes entries with the specified keys from the cache, without notifying listeners and cache writers.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>keys</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">Array.<*></span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>keys to be removed.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line427">line 427</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>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="containsKey"><span class="type-signature">(async) </span>containsKey<span class="signature">(key)</span><span class="type-signature"> → {Promise.<boolean>}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Checks if the specified key exists in the cache.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>key</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>key to check.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line231">line 231</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>true if the key exists, false otherwise.</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type">Promise.<boolean></span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="containsKeys"><span class="type-signature">(async) </span>containsKeys<span class="signature">(keys)</span><span class="type-signature"> → {Promise.<boolean>}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Checks if all the specified keys exist in the cache.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>keys</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">Array.<*></span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>keys to check.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line247">line 247</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>true if all the keys exist,
-false if at least one of the keys does not exist in the cache.</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type">Promise.<boolean></span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="get"><span class="type-signature">(async) </span>get<span class="signature">(key)</span><span class="type-signature"> → {Promise.<*>}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Retrieves a value associated with the specified key from the cache.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>key</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>key.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line139">line 139</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>value associated with the specified key, or null if it does not exist.</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type">Promise.<*></span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="getAll"><span class="type-signature">(async) </span>getAll<span class="signature">(keys)</span><span class="type-signature"> → {Promise.<Array.<<a href="CacheEntry.html">CacheEntry</a>>>}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Retrieves entries associated with the specified keys from the cache.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>keys</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">Array.<*></span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>keys.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line155">line 155</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 retrieved entries (key-value pairs).
-Entries with the keys which do not exist in the cache are not included into the array.</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type">Promise.<Array.<<a href="CacheEntry.html">CacheEntry</a>>></span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="getAndPut"><span class="type-signature">(async) </span>getAndPut<span class="signature">(key, value)</span><span class="type-signature"> → {Promise.<*>}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Associates the specified value with the specified key in the cache
-and returns the previous associated value, if any.</p>
-<p>Overwrites the previous value if the key exists in the cache,
-otherwise creates new entry (key-value pair).</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>key</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>key.</p></td>
- </tr>
-
-
-
- <tr>
-
- <td class="name"><code>value</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>value to be associated with the specified key.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line267">line 267</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 previous value associated with the specified key, or null if it did not exist.</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type">Promise.<*></span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="getAndPutIfAbsent"><span class="type-signature">(async) </span>getAndPutIfAbsent<span class="signature">(key, value)</span><span class="type-signature"> → {Promise.<*>}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Creates new entry (key-value pair) if the specified key does not exist in the cache.
-Otherwise returns the current value associated with the existing key.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>key</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>key.</p></td>
- </tr>
-
-
-
- <tr>
-
- <td class="name"><code>value</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>value to be associated with the specified key.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line336">line 336</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 current value associated with the key if it already exists in the cache,
-null if the new entry is created.</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type">Promise.<*></span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="getAndRemove"><span class="type-signature">(async) </span>getAndRemove<span class="signature">(key)</span><span class="type-signature"> → {Promise.<*>}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Removes the cache entry with the specified key
-and returns the last associated value, if any.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>key</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>key of the entry to be removed.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line301">line 301</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 last value associated with the specified key, or null if it did not exist.</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type">Promise.<*></span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="getAndReplace"><span class="type-signature">(async) </span>getAndReplace<span class="signature">(key, value)</span><span class="type-signature"> → {Promise.<*>}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Associates the specified value with the specified key in the cache
-and returns the previous associated value, if the key exists in the cache.
-Otherwise does nothing and returns null.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>key</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>key.</p></td>
- </tr>
-
-
-
- <tr>
-
- <td class="name"><code>value</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>value to be associated with the specified key.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line285">line 285</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 previous value associated with the specified key, or null if it did not exist.</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type">Promise.<*></span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="getSize"><span class="type-signature">(async) </span>getSize<span class="signature">(…peekModes<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<number>}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Returns the number of the entries in the cache.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>peekModes</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type"><a href="CacheClient.html#.PEEK_MODE">CacheClient.PEEK_MODE</a></span>
-
-
-
- </td>
-
-
- <td class="attributes">
-
- <optional><br>
-
-
-
-
-
- <repeatable><br>
-
- </td>
-
-
-
-
- <td class="description last"><p>peek modes.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line502">line 502</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 number of the entries in the cache.</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type">Promise.<number></span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="put"><span class="type-signature">(async) </span>put<span class="signature">(key, value)</span><span class="type-signature"></span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Associates the specified value with the specified key in the cache.</p>
-<p>Overwrites the previous value if the key exists in the cache,
-otherwise creates new entry (key-value pair).</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>key</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>key.</p></td>
- </tr>
-
-
-
- <tr>
-
- <td class="name"><code>value</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>value to be associated with the specified key.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line190">line 190</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>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="putAll"><span class="type-signature">(async) </span>putAll<span class="signature">(entries)</span><span class="type-signature"></span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Associates the specified values with the specified keys in the cache.</p>
-<p>Overwrites the previous value if a key exists in the cache,
-otherwise creates new entry (key-value pair).</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>entries</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">Array.<<a href="CacheEntry.html">CacheEntry</a>></span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>entries (key-value pairs) to be put into the cache.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line206">line 206</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>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="putIfAbsent"><span class="type-signature">(async) </span>putIfAbsent<span class="signature">(key, value)</span><span class="type-signature"> → {Promise.<boolean>}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Creates new entry (key-value pair) if the specified key does not exist in the cache.
-Otherwise does nothing.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>key</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>key.</p></td>
- </tr>
-
-
-
- <tr>
-
- <td class="name"><code>value</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>value to be associated with the specified key.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line318">line 318</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>true if the operation has been done, false otherwise.</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type">Promise.<boolean></span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="query"><span class="type-signature">(async) </span>query<span class="signature">(query)</span><span class="type-signature"> → {Promise.<<a href="Cursor.html">Cursor</a>>}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Starts an SQL or Scan query operation.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>query</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type"><a href="SqlQuery.html">SqlQuery</a></span>
-|
-
-<span class="param-type"><a href="SqlFieldsQuery.html">SqlFieldsQuery</a></span>
-|
-
-<span class="param-type"><a href="ScanQuery.html">ScanQuery</a></span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>query to be executed.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line535">line 535</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>cursor to obtain the results of the query operation:<ul>
-<li><a href="SqlFieldsCursor.html">SqlFieldsCursor</a> in case of <a href="SqlFieldsQuery.html">SqlFieldsQuery</a> query</li>
-<li><a href="Cursor.html">Cursor</a> in case of other types of query</li>
-</ul>
-</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type">Promise.<<a href="Cursor.html">Cursor</a>></span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="removeAll"><span class="type-signature">(async) </span>removeAll<span class="signature">()</span><span class="type-signature"></span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Removes all entries from the cache, notifying listeners and cache writers.</p>
-</div>
-
-
-
-
-
-
-
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line483">line 483</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>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="removeIfEquals"><span class="type-signature">(async) </span>removeIfEquals<span class="signature">(key, value)</span><span class="type-signature"> → {Promise.<boolean>}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Removes entry with the specified key from the cache, if the current value equals to the provided one.
-Notifies listeners and cache writers.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>key</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>key to be removed.</p></td>
- </tr>
-
-
-
- <tr>
-
- <td class="name"><code>value</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>value to be compared with the current value associated with the specified key.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line459">line 459</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>true if the operation has been done, false otherwise.</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type">Promise.<boolean></span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="removeKey"><span class="type-signature">(async) </span>removeKey<span class="signature">(key)</span><span class="type-signature"> → {Promise.<boolean>}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Removes entry with the specified key from the cache, notifying listeners and cache writers.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>key</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>key to be removed.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line442">line 442</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>true if the operation has been done, false otherwise.</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type">Promise.<boolean></span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="removeKeys"><span class="type-signature">(async) </span>removeKeys<span class="signature">(keys)</span><span class="type-signature"></span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Removes entries with the specified keys from the cache, notifying listeners and cache writers.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>keys</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">Array.<*></span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>keys to be removed.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line472">line 472</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>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="replace"><span class="type-signature">(async) </span>replace<span class="signature">(key, value)</span><span class="type-signature"> → {Promise.<boolean>}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Associates the specified value with the specified key, if the key exists in the cache.
-Otherwise does nothing.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>key</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>key.</p></td>
- </tr>
-
-
-
- <tr>
-
- <td class="name"><code>value</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>value to be associated with the specified key.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line353">line 353</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>true if the operation has been done, false otherwise.</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type">Promise.<boolean></span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="replaceIfEquals"><span class="type-signature">(async) </span>replaceIfEquals<span class="signature">(key, value, newValue)</span><span class="type-signature"> → {Promise.<boolean>}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Associates the new value with the specified key, if the key exists in the cache
-and the current value equals to the provided one.
-Otherwise does nothing.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>key</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>key.</p></td>
- </tr>
-
-
-
- <tr>
-
- <td class="name"><code>value</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>value to be compared with the current value associated with the specified key.</p></td>
- </tr>
-
-
-
- <tr>
-
- <td class="name"><code>newValue</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type">*</span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>new value to be associated with the specified key.</p></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line372">line 372</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>true if the operation has been done, false otherwise.</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type">Promise.<boolean></span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="setKeyType"><span class="type-signature"></span>setKeyType<span class="signature">(type)</span><span class="type-signature"> → {<a href="CacheClient.html">CacheClient</a>}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Specifies a type of the cache key.</p>
-<p>The cache client assumes that keys in all further operations with the cache
-will have the specified type.
-Eg. the cache client will convert keys provided as input parameters of the methods
-to the specified object type before sending them to a server.</p>
-<p>After the cache client creation a type of the cache key is not specified (null).</p>
-<p>If the type is not specified then during operations the cache client
-will do automatic mapping between some of the JavaScript types and object types -
-according to the mapping table defined in the description of the <a href="ObjectType.html">ObjectType</a> class.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>type</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type"><a href="ObjectType.html#.PRIMITIVE_TYPE">ObjectType.PRIMITIVE_TYPE</a></span>
-|
-
-<span class="param-type"><a href="CompositeType.html">CompositeType</a></span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>type of the keys in the cache:</p>
-<ul>
-<li>either a type code of primitive (simple) type</li>
-<li>or an instance of class representing non-primitive (composite) type</li>
-<li>or null (means the type is not specified).</li>
-</ul></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line91">line 91</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 cache client.</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type"><a href="CacheClient.html">CacheClient</a></span>
-
-
- </dd>
-</dl>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <h4 class="name" id="setValueType"><span class="type-signature"></span>setValueType<span class="signature">(type)</span><span class="type-signature"> → {<a href="CacheClient.html">CacheClient</a>}</span></h4>
-
-
-
-
-
-
-<div class="description">
- <p>Specifies a type of the cache value.</p>
-<p>The cache client assumes that values in all further operations with the cache
-will have the specified type.
-Eg. the cache client will convert values provided as input parameters of the methods
-to the specified object type before sending them to a server.</p>
-<p>After the cache client creation a type of the cache value is not specified (null).</p>
-<p>If the type is not specified then during operations the cache client
-will do automatic mapping between some of the JavaScript types and object types -
-according to the mapping table defined in the description of the <a href="ObjectType.html">ObjectType</a> class.</p>
-</div>
-
-
-
-
-
-
-
-
-
- <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>type</code></td>
-
-
- <td class="type">
-
-
-<span class="param-type"><a href="ObjectType.html#.PRIMITIVE_TYPE">ObjectType.PRIMITIVE_TYPE</a></span>
-|
-
-<span class="param-type"><a href="CompositeType.html">CompositeType</a></span>
-
-
-
- </td>
-
-
-
-
-
- <td class="description last"><p>type of the values in the cache:</p>
-<ul>
-<li>either a type code of primitive (simple) type</li>
-<li>or an instance of class representing non-primitive (composite) type</li>
-<li>or null (means the type is not specified).</li>
-</ul></td>
- </tr>
-
-
- </tbody>
-</table>
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="CacheClient.js.html">CacheClient.js</a>, <a href="CacheClient.js.html#line120">line 120</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 cache client.</li>
-</ul>
-</div>
-
-
-
-<dl>
- <dt>
- Type
- </dt>
- <dd>
-
-<span class="param-type"><a href="CacheClient.html">CacheClient</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 hr [...]
-</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>
\ No newline at end of file
diff --git a/modules/platforms/nodejs/api_spec/CacheClient.js.html b/modules/platforms/nodejs/api_spec/CacheClient.js.html
deleted file mode 100644
index 879ad39..0000000
--- a/modules/platforms/nodejs/api_spec/CacheClient.js.html
+++ /dev/null
@@ -1,812 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
- <meta charset="utf-8">
- <title>JSDoc: Source: CacheClient.js</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">Source: CacheClient.js</h1>
-
-
-
-
-
-
- <section>
- <article>
- <pre class="prettyprint source linenums"><code>/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-'use strict';
-
-const BinaryUtils = require('./internal/BinaryUtils');
-const BinaryReader = require('./internal/BinaryReader');
-const BinaryWriter = require('./internal/BinaryWriter');
-const ArgumentChecker = require('./internal/ArgumentChecker');
-const SqlQuery = require('./Query').SqlQuery;
-const SqlFieldsQuery = require('./Query').SqlFieldsQuery;
-const ScanQuery = require('./Query').ScanQuery;
-
-/**
- * Peek modes
- * @typedef CacheClient.PEEK_MODE
- * @enum
- * @readonly
- * @property ALL 0
- * @property NEAR 1
- * @property PRIMARY 2
- * @property BACKUP 3
- */
-const PEEK_MODE = Object.freeze({
- ALL : 0,
- NEAR : 1,
- PRIMARY : 2,
- BACKUP : 3
-});
-
-/**
- * Class representing and providing access to Ignite cache.
- *
- * The class has no public constructor. An instance of this class should be obtained
- * via the methods of {@link IgniteClient} objects.
- * One instance of this class provides access to one Ignite cache which is specified
- * during the instance obtaining and cannot be changed after that.
- *
- * There are three groups of methods in the cache client:
- * - methods to configure the cache client
- * - methods to operate with the cache using Key-Value Queries
- * - methods to operate with the cache using SQL and Scan Queries
- *
- * @hideconstructor
- */
-class CacheClient {
-
- static get PEEK_MODE() {
- return PEEK_MODE;
- }
-
- /* Methods to configure the cache client */
-
- /**
- * Specifies a type of the cache key.
- *
- * The cache client assumes that keys in all further operations with the cache
- * will have the specified type.
- * Eg. the cache client will convert keys provided as input parameters of the methods
- * to the specified object type before sending them to a server.
- *
- * After the cache client creation a type of the cache key is not specified (null).
- *
- * If the type is not specified then during operations the cache client
- * will do automatic mapping between some of the JavaScript types and object types -
- * according to the mapping table defined in the description of the {@link ObjectType} class.
- *
- * @param {ObjectType.PRIMITIVE_TYPE | CompositeType} type - type of the keys in the cache:
- * - either a type code of primitive (simple) type
- * - or an instance of class representing non-primitive (composite) type
- * - or null (means the type is not specified).
- *
- * @return {CacheClient} - the same instance of the cache client.
- *
- * @throws {IgniteClientError} if error.
- */
- setKeyType(type) {
- BinaryUtils.checkObjectType(type, 'type');
- this._keyType = type;
- return this;
- }
-
- /**
- * Specifies a type of the cache value.
- *
- * The cache client assumes that values in all further operations with the cache
- * will have the specified type.
- * Eg. the cache client will convert values provided as input parameters of the methods
- * to the specified object type before sending them to a server.
- *
- * After the cache client creation a type of the cache value is not specified (null).
- *
- * If the type is not specified then during operations the cache client
- * will do automatic mapping between some of the JavaScript types and object types -
- * according to the mapping table defined in the description of the {@link ObjectType} class.
- *
- * @param {ObjectType.PRIMITIVE_TYPE | CompositeType} type - type of the values in the cache:
- * - either a type code of primitive (simple) type
- * - or an instance of class representing non-primitive (composite) type
- * - or null (means the type is not specified).
- *
- * @return {CacheClient} - the same instance of the cache client.
- *
- * @throws {IgniteClientError} if error.
- */
- setValueType(type) {
- BinaryUtils.checkObjectType(type, 'type');
- this._valueType = type;
- return this;
- }
-
- /* Methods to operate with the cache using Key-Value Queries */
-
- /**
- * Retrieves a value associated with the specified key from the cache.
- *
- * @async
- *
- * @param {*} key - key.
- *
- * @return {Promise<*>} - value associated with the specified key, or null if it does not exist.
- *
- * @throws {IgniteClientError} if error.
- */
- async get(key) {
- return await this._writeKeyReadValueOp(BinaryUtils.OPERATION.CACHE_GET, key);
- }
-
- /**
- * Retrieves entries associated with the specified keys from the cache.
- *
- * @async
- *
- * @param {Array<*>} keys - keys.
- *
- * @return {Promise<Array<CacheEntry>>} - the retrieved entries (key-value pairs).
- * Entries with the keys which do not exist in the cache are not included into the array.
- *
- * @throws {IgniteClientError} if error.
- */
- async getAll(keys) {
- ArgumentChecker.notEmpty(keys, 'keys');
- ArgumentChecker.hasType(keys, 'keys', false, Array);
- let result = null;
- await this._socket.send(
- BinaryUtils.OPERATION.CACHE_GET_ALL,
- async (payload) => {
- this._writeCacheInfo(payload);
- await this._writeKeys(payload, keys);
- },
- async (payload) => {
- const resultCount = payload.readInteger();
- result = new Array(resultCount);
- for (let i = 0; i < resultCount; i++) {
- result[i] = new CacheEntry(
- await BinaryReader.readObject(payload, this._getKeyType()),
- await BinaryReader.readObject(payload, this._getValueType()));
- }
- });
- return result;
- }
-
- /**
- * Associates the specified value with the specified key in the cache.
- *
- * Overwrites the previous value if the key exists in the cache,
- * otherwise creates new entry (key-value pair).
- *
- * @async
- *
- * @param {*} key - key.
- * @param {*} value - value to be associated with the specified key.
- *
- * @throws {IgniteClientError} if error.
- */
- async put(key, value) {
- await this._writeKeyValueOp(BinaryUtils.OPERATION.CACHE_PUT, key, value);
- }
-
- /**
- * Associates the specified values with the specified keys in the cache.
- *
- * Overwrites the previous value if a key exists in the cache,
- * otherwise creates new entry (key-value pair).
- *
- * @async
- *
- * @param {Array<CacheEntry>} entries - entries (key-value pairs) to be put into the cache.
- *
- * @throws {IgniteClientError} if error.
- */
- async putAll(entries) {
- ArgumentChecker.notEmpty(entries, 'entries');
- ArgumentChecker.hasType(entries, 'entries', true, CacheEntry);
- await this._socket.send(
- BinaryUtils.OPERATION.CACHE_PUT_ALL,
- async (payload) => {
- this._writeCacheInfo(payload);
- payload.writeInteger(entries.length);
- for (let entry of entries) {
- await this._writeKeyValue(payload, entry.getKey(), entry.getValue());
- }
- });
- }
-
- /**
- * Checks if the specified key exists in the cache.
- *
- * @async
- *
- * @param {*} key - key to check.
- *
- * @return {Promise<boolean>} - true if the key exists, false otherwise.
- *
- * @throws {IgniteClientError} if error.
- */
- async containsKey(key) {
- return await this._writeKeyReadBooleanOp(BinaryUtils.OPERATION.CACHE_CONTAINS_KEY, key);
- }
-
- /**
- * Checks if all the specified keys exist in the cache.
- *
- * @async
- *
- * @param {Array<*>} keys - keys to check.
- *
- * @return {Promise<boolean>} - true if all the keys exist,
- * false if at least one of the keys does not exist in the cache.
- *
- * @throws {IgniteClientError} if error.
- */
- async containsKeys(keys) {
- return await this._writeKeysReadBooleanOp(BinaryUtils.OPERATION.CACHE_CONTAINS_KEYS, keys);
- }
-
- /**
- * Associates the specified value with the specified key in the cache
- * and returns the previous associated value, if any.
- *
- * Overwrites the previous value if the key exists in the cache,
- * otherwise creates new entry (key-value pair).
- *
- * @async
- *
- * @param {*} key - key.
- * @param {*} value - value to be associated with the specified key.
- *
- * @return {Promise<*>} - the previous value associated with the specified key, or null if it did not exist.
- *
- * @throws {IgniteClientError} if error.
- */
- async getAndPut(key, value) {
- return await this._writeKeyValueReadValueOp(BinaryUtils.OPERATION.CACHE_GET_AND_PUT, key, value);
- }
-
- /**
- * Associates the specified value with the specified key in the cache
- * and returns the previous associated value, if the key exists in the cache.
- * Otherwise does nothing and returns null.
- *
- * @async
- *
- * @param {*} key - key.
- * @param {*} value - value to be associated with the specified key.
- *
- * @return {Promise<*>} - the previous value associated with the specified key, or null if it did not exist.
- *
- * @throws {IgniteClientError} if error.
- */
- async getAndReplace(key, value) {
- return await this._writeKeyValueReadValueOp(BinaryUtils.OPERATION.CACHE_GET_AND_REPLACE, key, value);
- }
-
- /**
- * Removes the cache entry with the specified key
- * and returns the last associated value, if any.
- *
- * @async
- *
- * @param {*} key - key of the entry to be removed.
- *
- * @return {Promise<*>} - the last value associated with the specified key, or null if it did not exist.
- *
- * @throws {IgniteClientError} if error.
- */
- async getAndRemove(key) {
- return await this._writeKeyReadValueOp(BinaryUtils.OPERATION.CACHE_GET_AND_REMOVE, key);
- }
-
- /**
- * Creates new entry (key-value pair) if the specified key does not exist in the cache.
- * Otherwise does nothing.
- *
- * @async
- *
- * @param {*} key - key.
- * @param {*} value - value to be associated with the specified key.
- *
- * @return {Promise<boolean>} - true if the operation has been done, false otherwise.
- *
- * @throws {IgniteClientError} if error.
- */
- async putIfAbsent(key, value) {
- return await this._writeKeyValueReadBooleanOp(BinaryUtils.OPERATION.CACHE_PUT_IF_ABSENT, key, value);
- }
-
- /**
- * Creates new entry (key-value pair) if the specified key does not exist in the cache.
- * Otherwise returns the current value associated with the existing key.
- *
- * @async
- *
- * @param {*} key - key.
- * @param {*} value - value to be associated with the specified key.
- *
- * @return {Promise<*>} - the current value associated with the key if it already exists in the cache,
- * null if the new entry is created.
- *
- * @throws {IgniteClientError} if error.
- */
- async getAndPutIfAbsent(key, value) {
- return await this._writeKeyValueReadValueOp(BinaryUtils.OPERATION.CACHE_GET_AND_PUT_IF_ABSENT, key, value);
- }
-
- /**
- * Associates the specified value with the specified key, if the key exists in the cache.
- * Otherwise does nothing.
- *
- * @async
- *
- * @param {*} key - key.
- * @param {*} value - value to be associated with the specified key.
- *
- * @return {Promise<boolean>} - true if the operation has been done, false otherwise.
- *
- * @throws {IgniteClientError} if error.
- */
- async replace(key, value) {
- return await this._writeKeyValueReadBooleanOp(BinaryUtils.OPERATION.CACHE_REPLACE, key, value);
- }
-
- /**
- * Associates the new value with the specified key, if the key exists in the cache
- * and the current value equals to the provided one.
- * Otherwise does nothing.
- *
- * @async
- *
- * @param {*} key - key.
- * @param {*} value - value to be compared with the current value associated with the specified key.
- * @param {*} newValue - new value to be associated with the specified key.
- *
- * @return {Promise<boolean>} - true if the operation has been done, false otherwise.
- *
- * @throws {IgniteClientError} if error.
- */
- async replaceIfEquals(key, value, newValue) {
- ArgumentChecker.notNull(key, 'key');
- ArgumentChecker.notNull(value, 'value');
- ArgumentChecker.notNull(newValue, 'newValue');
- let result;
- await this._socket.send(
- BinaryUtils.OPERATION.CACHE_REPLACE_IF_EQUALS,
- async (payload) => {
- this._writeCacheInfo(payload);
- await this._writeKeyValue(payload, key, value);
- await BinaryWriter.writeObject(payload, newValue, this._getValueType());
- },
- async (payload) => {
- result = payload.readBoolean();
- });
- return result;
- }
-
- /**
- * Removes all entries from the cache, without notifying listeners and cache writers.
- *
- * @async
- *
- * @throws {IgniteClientError} if error.
- */
- async clear() {
- await this._socket.send(
- BinaryUtils.OPERATION.CACHE_CLEAR,
- async (payload) => {
- this._writeCacheInfo(payload);
- });
- }
-
- /**
- * Removes entry with the specified key from the cache, without notifying listeners and cache writers.
- *
- * @async
- *
- * @param {*} key - key to be removed.
- *
- * @throws {IgniteClientError} if error.
- */
- async clearKey(key) {
- await this._writeKeyOp(BinaryUtils.OPERATION.CACHE_CLEAR_KEY, key);
- }
-
- /**
- * Removes entries with the specified keys from the cache, without notifying listeners and cache writers.
- *
- * @async
- *
- * @param {Array<*>} keys - keys to be removed.
- *
- * @throws {IgniteClientError} if error.
- */
- async clearKeys(keys) {
- await this._writeKeysOp(BinaryUtils.OPERATION.CACHE_CLEAR_KEYS, keys);
- }
-
- /**
- * Removes entry with the specified key from the cache, notifying listeners and cache writers.
- *
- * @async
- *
- * @param {*} key - key to be removed.
- *
- * @return {Promise<boolean>} - true if the operation has been done, false otherwise.
- *
- * @throws {IgniteClientError} if error.
- */
- async removeKey(key) {
- return await this._writeKeyReadBooleanOp(BinaryUtils.OPERATION.CACHE_REMOVE_KEY, key);
- }
-
- /**
- * Removes entry with the specified key from the cache, if the current value equals to the provided one.
- * Notifies listeners and cache writers.
- *
- * @async
- *
- * @param {*} key - key to be removed.
- * @param {*} value - value to be compared with the current value associated with the specified key.
- *
- * @return {Promise<boolean>} - true if the operation has been done, false otherwise.
- *
- * @throws {IgniteClientError} if error.
- */
- async removeIfEquals(key, value) {
- return await this._writeKeyValueReadBooleanOp(BinaryUtils.OPERATION.CACHE_REMOVE_IF_EQUALS, key, value);
- }
-
- /**
- * Removes entries with the specified keys from the cache, notifying listeners and cache writers.
- *
- * @async
- *
- * @param {Array<*>} keys - keys to be removed.
- *
- * @throws {IgniteClientError} if error.
- */
- async removeKeys(keys) {
- await this._writeKeysOp(BinaryUtils.OPERATION.CACHE_REMOVE_KEYS, keys);
- }
-
- /**
- * Removes all entries from the cache, notifying listeners and cache writers.
- *
- * @async
- *
- * @throws {IgniteClientError} if error.
- */
- async removeAll() {
- await this._socket.send(
- BinaryUtils.OPERATION.CACHE_REMOVE_ALL,
- async (payload) => {
- this._writeCacheInfo(payload);
- });
- }
-
- /**
- * Returns the number of the entries in the cache.
- *
- * @async
- *
- * @param {...CacheClient.PEEK_MODE} [peekModes] - peek modes.
- *
- * @return {Promise<number>} - the number of the entries in the cache.
- *
- * @throws {IgniteClientError} if error.
- */
- async getSize(...peekModes) {
- ArgumentChecker.hasValueFrom(peekModes, 'peekModes', true, CacheClient.PEEK_MODE);
- let result;
- await this._socket.send(
- BinaryUtils.OPERATION.CACHE_GET_SIZE,
- async (payload) => {
- this._writeCacheInfo(payload);
- payload.writeInteger(peekModes.length);
- for (let mode of peekModes) {
- payload.writeByte(mode);
- }
- },
- async (payload) => {
- result = payload.readLong().toNumber();
- });
- return result;
- }
-
- /* Methods to operate with the cache using SQL and Scan Queries */
-
- /**
- * Starts an SQL or Scan query operation.
- *
- * @async
- *
- * @param {SqlQuery | SqlFieldsQuery | ScanQuery} query - query to be executed.
- *
- * @return {Promise<Cursor>} - cursor to obtain the results of the query operation:
- * - {@link SqlFieldsCursor} in case of {@link SqlFieldsQuery} query
- * - {@link Cursor} in case of other types of query
- *
- * @throws {IgniteClientError} if error.
- */
- async query(query) {
- ArgumentChecker.notNull(query, 'query');
- ArgumentChecker.hasType(query, 'query', false, SqlQuery, SqlFieldsQuery, ScanQuery);
-
- let value = null;
- await this._socket.send(
- query._operation,
- async (payload) => {
- this._writeCacheInfo(payload);
- await query._write(payload);
- },
- async (payload) => {
- value = await query._getCursor(this._socket, payload, this._keyType, this._valueType);
- });
- return value;
- }
-
- /** Private methods */
-
- /**
- * @ignore
- */
- constructor(name, config, socket) {
- this._name = name;
- this._cacheId = CacheClient._calculateId(this._name);
- this._config = config;
- this._keyType = null;
- this._valueType = null;
- this._socket = socket;
- }
-
- /**
- * @ignore
- */
- static _calculateId(name) {
- return BinaryUtils.hashCode(name);
- }
-
- /**
- * @ignore
- */
- _writeCacheInfo(payload) {
- payload.writeInteger(this._cacheId);
- payload.writeByte(0);
- }
-
- /**
- * @ignore
- */
- async _writeKeyValue(payload, key, value) {
- await BinaryWriter.writeObject(payload, key, this._getKeyType());
- await BinaryWriter.writeObject(payload, value, this._getValueType());
- }
-
- /**
- * @ignore
- */
- async _writeKeys(payload, keys) {
- payload.writeInteger(keys.length);
- for (let key of keys) {
- await BinaryWriter.writeObject(payload, key, this._getKeyType());
- }
- }
-
- /**
- * @ignore
- */
- _getKeyType() {
- return this._keyType;
- }
-
- /**
- * @ignore
- */
- _getValueType() {
- return this._valueType;
- }
-
- /**
- * @ignore
- */
- async _writeKeyValueOp(operation, key, value, payloadReader = null) {
- ArgumentChecker.notNull(key, 'key');
- ArgumentChecker.notNull(value, 'value');
- await this._socket.send(
- operation,
- async (payload) => {
- this._writeCacheInfo(payload);
- await this._writeKeyValue(payload, key, value);
- },
- payloadReader);
- }
-
- /**
- * @ignore
- */
- async _writeKeyValueReadValueOp(operation, key, value) {
- let result = null;
- await this._writeKeyValueOp(
- operation, key, value,
- async (payload) => {
- result = await BinaryReader.readObject(payload, this._getValueType());
- });
- return result;
- }
-
- /**
- * @ignore
- */
- async _writeKeyValueReadBooleanOp(operation, key, value) {
- let result = false;
- await this._writeKeyValueOp(
- operation, key, value,
- async (payload) => {
- result = payload.readBoolean();
- });
- return result;
- }
-
- /**
- * @ignore
- */
- async _writeKeyOp(operation, key, payloadReader = null) {
- ArgumentChecker.notNull(key, 'key');
- await this._socket.send(
- operation,
- async (payload) => {
- this._writeCacheInfo(payload);
- await BinaryWriter.writeObject(payload, key, this._getKeyType());
- },
- payloadReader);
- }
-
- /**
- * @ignore
- */
- async _writeKeyReadValueOp(operation, key) {
- let value = null;
- await this._writeKeyOp(
- operation, key,
- async (payload) => {
- value = await BinaryReader.readObject(payload, this._getValueType());
- });
- return value;
- }
-
- /**
- * @ignore
- */
- async _writeKeyReadBooleanOp(operation, key) {
- let result = false;
- await this._writeKeyOp(
- operation, key,
- async (payload) => {
- result = payload.readBoolean();
- });
- return result;
- }
-
- /**
- * @ignore
- */
- async _writeKeysOp(operation, keys, payloadReader = null) {
- ArgumentChecker.notEmpty(keys, 'keys');
- ArgumentChecker.hasType(keys, 'keys', false, Array);
- await this._socket.send(
- operation,
- async (payload) => {
- this._writeCacheInfo(payload);
- await this._writeKeys(payload, keys);
- },
- payloadReader);
- }
-
- /**
- * @ignore
- */
- async _writeKeysReadBooleanOp(operation, keys) {
- let result = false;
- await this._writeKeysOp(
- operation, keys,
- async (payload) => {
- result = payload.readBoolean();
- });
- return result;
- }
-}
-
-/**
- * A cache entry (key-value pair).
- */
-class CacheEntry {
-
- /**
- * Public constructor.
- *
- * @param {*} key - key corresponding to this entry.
- * @param {*} value - value associated with the key.
- *
- * @return {CacheEntry} - new CacheEntry instance
- */
- constructor(key, value) {
- this._key = key;
- this._value = value;
- }
-
- /**
- * Returns the key corresponding to this entry.
- *
- * @return {*} - the key corresponding to this entry.
- */
- getKey() {
- return this._key;
- }
-
- /**
- * Returns the value corresponding to this entry.
- *
- * @return {*} - the value corresponding to this entry.
- */
- getValue() {
- return this._value;
- }
-}
-
-module.exports = CacheClient;
-module.exports.CacheEntry = CacheEntry;
-</code></pre>
- </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 hr [...]
-</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:48 GMT+0300 (Russia TZ 2 Standard Time)
-</footer>
-
-<script> prettyPrint(); </script>
-<script src="scripts/linenumber.js"> </script>
-</body>
-</html>
diff --git a/modules/platforms/nodejs/api_spec/CacheConfiguration.html b/modules/platforms/nodejs/api_spec/CacheConfiguration.html
deleted file mode 100644
index 17fd22c..0000000
--- a/modules/platforms/nodejs/api_spec/CacheConfiguration.html
+++ /dev/null
@@ -1,8527 +0,0 @@
-<!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"> → {<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"> → {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"> → {<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"> → {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"> → {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"> → {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"> → {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"> → {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"> → {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"> → {Array.<<a href="CacheKeyConfiguration.html">CacheKeyConfiguration</a>>}</span></h4>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-<dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
... 47052 lines suppressed ...