api spec
Project: http://git-wip-us.apache.org/repos/asf/ignite/repo Commit: http://git-wip-us.apache.org/repos/asf/ignite/commit/84aa3495 Tree: http://git-wip-us.apache.org/repos/asf/ignite/tree/84aa3495 Diff: http://git-wip-us.apache.org/repos/asf/ignite/diff/84aa3495 Branch: refs/heads/ignite-7777 Commit: 84aa3495d349d85f4b52e96bac19e2f48b4d9265 Parents: 9a7be81 Author: ekaterina-nbl <[email protected]> Authored: Tue May 8 23:56:16 2018 +0300 Committer: ekaterina-nbl <[email protected]> Committed: Tue May 8 23:56:16 2018 +0300 ---------------------------------------------------------------------- .../platforms/nodejs/api_spec/BinaryObject.html | 167 +- .../nodejs/api_spec/BinaryObject.js.html | 28 +- .../platforms/nodejs/api_spec/CacheClient.html | 2 +- .../nodejs/api_spec/CacheClient.js.html | 2 +- .../nodejs/api_spec/CacheConfiguration.html | 130 +- .../nodejs/api_spec/CacheConfiguration.js.html | 34 +- .../platforms/nodejs/api_spec/CacheEntry.html | 2 +- .../nodejs/api_spec/CacheKeyConfiguration.html | 2 +- .../nodejs/api_spec/CollectionObjectType.html | 6 +- .../nodejs/api_spec/ComplexObjectType.html | 34 +- .../nodejs/api_spec/CompositeType.html | 4 +- modules/platforms/nodejs/api_spec/Cursor.html | 2 +- .../platforms/nodejs/api_spec/Cursor.js.html | 53 +- modules/platforms/nodejs/api_spec/EnumItem.html | 50 +- .../platforms/nodejs/api_spec/EnumItem.js.html | 30 +- .../platforms/nodejs/api_spec/Errors.js.html | 2 +- .../platforms/nodejs/api_spec/IgniteClient.html | 2 +- .../nodejs/api_spec/IgniteClient.js.html | 2 +- .../api_spec/IgniteClientConfiguration.html | 10 +- .../api_spec/IgniteClientConfiguration.js.html | 6 +- .../nodejs/api_spec/IgniteClientError.html | 2 +- .../nodejs/api_spec/IllegalStateError.html | 2 +- .../nodejs/api_spec/LostConnectionError.html | 2 +- .../nodejs/api_spec/MapObjectType.html | 6 +- .../nodejs/api_spec/ObjectArrayType.html | 23 +- .../platforms/nodejs/api_spec/ObjectType.html | 163 +- .../nodejs/api_spec/ObjectType.js.html | 259 ++- .../nodejs/api_spec/OperationError.html | 2 +- modules/platforms/nodejs/api_spec/Query.html | 2 +- modules/platforms/nodejs/api_spec/Query.js.html | 27 +- .../platforms/nodejs/api_spec/QueryEntity.html | 2 +- .../platforms/nodejs/api_spec/QueryField.html | 24 +- .../platforms/nodejs/api_spec/QueryIndex.html | 22 +- .../platforms/nodejs/api_spec/ScanQuery.html | 355 +++- .../nodejs/api_spec/SqlFieldsCursor.html | 241 ++- .../nodejs/api_spec/SqlFieldsQuery.html | 1626 +++++++++++++++++- modules/platforms/nodejs/api_spec/SqlQuery.html | 357 +++- .../platforms/nodejs/api_spec/Timestamp.html | 41 +- .../platforms/nodejs/api_spec/Timestamp.js.html | 25 +- modules/platforms/nodejs/api_spec/index.html | 2 +- modules/platforms/nodejs/lib/Cursor.js | 1 + .../nodejs/lib/IgniteClientConfiguration.js | 4 +- modules/platforms/nodejs/lib/ObjectType.js | 28 +- modules/platforms/nodejs/lib/Query.js | 3 + modules/platforms/nodejs/lib/Timestamp.js | 5 +- 45 files changed, 3369 insertions(+), 423 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/BinaryObject.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/BinaryObject.html b/modules/platforms/nodejs/api_spec/BinaryObject.html index 00a8cbc..c376947 100644 --- a/modules/platforms/nodejs/api_spec/BinaryObject.html +++ b/modules/platforms/nodejs/api_spec/BinaryObject.html @@ -374,7 +374,7 @@ Otherwise, the type Id is generated from the name of the JavaScript Object.</p> <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#line100">line 100</a> + <a href="BinaryObject.js.html">BinaryObject.js</a>, <a href="BinaryObject.js.html#line103">line 103</a> </li></ul></dd> @@ -629,7 +629,7 @@ according to the mapping table defined in the description of the <a href="Object <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#line192">line 192</a> + <a href="BinaryObject.js.html">BinaryObject.js</a>, <a href="BinaryObject.js.html#line207">line 207</a> </li></ul></dd> @@ -650,6 +650,35 @@ according to the mapping table defined in the description of the <a href="Object +<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> @@ -739,7 +768,7 @@ according to the mapping table defined in the description of the <a href="Object <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#line241">line 241</a> + <a href="BinaryObject.js.html">BinaryObject.js</a>, <a href="BinaryObject.js.html#line259">line 259</a> </li></ul></dd> @@ -760,6 +789,35 @@ according to the mapping table defined in the description of the <a href="Object +<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> @@ -849,7 +907,7 @@ according to the mapping table defined in the description of the <a href="Object <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#line232">line 232</a> + <a href="BinaryObject.js.html">BinaryObject.js</a>, <a href="BinaryObject.js.html#line248">line 248</a> </li></ul></dd> @@ -1008,7 +1066,7 @@ according to the mapping table defined in the description of the <a href="Object <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#line170">line 170</a> + <a href="BinaryObject.js.html">BinaryObject.js</a>, <a href="BinaryObject.js.html#line182">line 182</a> </li></ul></dd> @@ -1029,6 +1087,35 @@ according to the mapping table defined in the description of the <a href="Object +<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> @@ -1074,8 +1161,8 @@ according to the mapping table defined in the description of the <a href="Object <div class="description"> - <p>Removes the specified field.</p> -<p>Does nothing if the field does not exist.</p> + <p>Removes the specified field. +Does nothing if the field does not exist.</p> </div> @@ -1168,7 +1255,7 @@ according to the mapping table defined in the description of the <a href="Object <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#line156">line 156</a> + <a href="BinaryObject.js.html">BinaryObject.js</a>, <a href="BinaryObject.js.html#line165">line 165</a> </li></ul></dd> @@ -1189,6 +1276,35 @@ according to the mapping table defined in the description of the <a href="Object +<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> @@ -1430,7 +1546,7 @@ according to the mapping table defined in the description of the <a href="Object <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#line139">line 139</a> + <a href="BinaryObject.js.html">BinaryObject.js</a>, <a href="BinaryObject.js.html#line146">line 146</a> </li></ul></dd> @@ -1451,6 +1567,35 @@ according to the mapping table defined in the description of the <a href="Object +<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> @@ -1589,7 +1734,7 @@ according to the mapping table defined in the description of the <a href="Object <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> + <a href="BinaryObject.js.html">BinaryObject.js</a>, <a href="BinaryObject.js.html#line225">line 225</a> </li></ul></dd> @@ -1693,7 +1838,7 @@ which corresponds to the specified complex object type.</li> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/BinaryObject.js.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/BinaryObject.js.html b/modules/platforms/nodejs/api_spec/BinaryObject.js.html index 032fcda..0c3f52f 100644 --- a/modules/platforms/nodejs/api_spec/BinaryObject.js.html +++ b/modules/platforms/nodejs/api_spec/BinaryObject.js.html @@ -94,8 +94,11 @@ class BinaryObject { * @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); @@ -126,9 +129,11 @@ class BinaryObject { * @throws {IgniteClientError} if error. */ static async fromObject(jsObject, complexObjectType = null) { + ArgumentChecker.notEmpty(jsObject, 'jsObject'); ArgumentChecker.hasType(complexObjectType, 'complexObjectType', false, ComplexObjectType); - const result = new BinaryObject(null); - result._typeBuilder = BinaryTypeBuilder.fromObject(jsObject, 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; @@ -163,8 +168,11 @@ class BinaryObject { * - 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); @@ -174,14 +182,16 @@ class BinaryObject { /** * 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); @@ -194,8 +204,11 @@ class BinaryObject { * @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)); } @@ -216,8 +229,11 @@ class BinaryObject { * - 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; } @@ -265,6 +281,8 @@ class BinaryObject { * 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 => { @@ -292,7 +310,7 @@ class BinaryObject { * @ignore */ static async _fromBuffer(buffer) { - const result = new BinaryObject(null); + const result = new BinaryObject(new ComplexObjectType({})._typeName); result._buffer = buffer; result._startPos = buffer.position; await result._read(); @@ -516,7 +534,7 @@ module.exports = BinaryObject; <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/CacheClient.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/CacheClient.html b/modules/platforms/nodejs/api_spec/CacheClient.html index 34937b7..79f76ba 100644 --- a/modules/platforms/nodejs/api_spec/CacheClient.html +++ b/modules/platforms/nodejs/api_spec/CacheClient.html @@ -4858,7 +4858,7 @@ according to the mapping table defined in the description of the <a href="Object <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/CacheClient.js.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/CacheClient.js.html b/modules/platforms/nodejs/api_spec/CacheClient.js.html index cf9d06e..d3898fa 100644 --- a/modules/platforms/nodejs/api_spec/CacheClient.js.html +++ b/modules/platforms/nodejs/api_spec/CacheClient.js.html @@ -803,7 +803,7 @@ module.exports.CacheEntry = CacheEntry; <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/CacheConfiguration.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/CacheConfiguration.html b/modules/platforms/nodejs/api_spec/CacheConfiguration.html index ccd1ece..24a6365 100644 --- a/modules/platforms/nodejs/api_spec/CacheConfiguration.html +++ b/modules/platforms/nodejs/api_spec/CacheConfiguration.html @@ -99,7 +99,7 @@ <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#line875">line 875</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line897">line 897</a> </li></ul></dd> @@ -252,7 +252,7 @@ <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#line791">line 791</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line813">line 813</a> </li></ul></dd> @@ -393,7 +393,7 @@ <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#line804">line 804</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line826">line 826</a> </li></ul></dd> @@ -570,7 +570,7 @@ <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#line819">line 819</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line841">line 841</a> </li></ul></dd> @@ -711,7 +711,7 @@ <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#line838">line 838</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line860">line 860</a> </li></ul></dd> @@ -852,7 +852,7 @@ <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#line853">line 853</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line875">line 875</a> </li></ul></dd> @@ -928,7 +928,7 @@ <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#line926">line 926</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line948">line 948</a> </li></ul></dd> @@ -1028,7 +1028,7 @@ <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> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line969">line 969</a> </li></ul></dd> @@ -1128,7 +1128,7 @@ <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#line971">line 971</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line993">line 993</a> </li></ul></dd> @@ -1228,7 +1228,7 @@ <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#line992">line 992</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1014">line 1014</a> </li></ul></dd> @@ -1328,7 +1328,7 @@ <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#line1013">line 1013</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1035">line 1035</a> </li></ul></dd> @@ -1428,7 +1428,7 @@ <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#line1097">line 1097</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1119">line 1119</a> </li></ul></dd> @@ -1528,7 +1528,7 @@ <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#line1034">line 1034</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1056">line 1056</a> </li></ul></dd> @@ -1628,7 +1628,7 @@ <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#line1076">line 1076</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1098">line 1098</a> </li></ul></dd> @@ -1728,7 +1728,7 @@ <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#line1160">line 1160</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1182">line 1182</a> </li></ul></dd> @@ -1828,7 +1828,7 @@ <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#line1508">line 1508</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1530">line 1530</a> </li></ul></dd> @@ -1928,7 +1928,7 @@ <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#line1118">line 1118</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1140">line 1140</a> </li></ul></dd> @@ -2028,7 +2028,7 @@ <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#line1139">line 1139</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1161">line 1161</a> </li></ul></dd> @@ -2128,7 +2128,7 @@ <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#line1184">line 1184</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1206">line 1206</a> </li></ul></dd> @@ -2228,7 +2228,7 @@ <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#line1205">line 1205</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1227">line 1227</a> </li></ul></dd> @@ -2328,7 +2328,7 @@ <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1532">line 1532</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1554">line 1554</a> </li></ul></dd> @@ -2428,7 +2428,7 @@ <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#line1226">line 1226</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1248">line 1248</a> </li></ul></dd> @@ -2528,7 +2528,7 @@ <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#line1247">line 1247</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1269">line 1269</a> </li></ul></dd> @@ -2628,7 +2628,7 @@ <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#line1289">line 1289</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1311">line 1311</a> </li></ul></dd> @@ -2728,7 +2728,7 @@ <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#line1268">line 1268</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1290">line 1290</a> </li></ul></dd> @@ -2828,7 +2828,7 @@ <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#line1310">line 1310</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1332">line 1332</a> </li></ul></dd> @@ -2928,7 +2928,7 @@ <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#line1334">line 1334</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1356">line 1356</a> </li></ul></dd> @@ -3028,7 +3028,7 @@ <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#line1355">line 1355</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1377">line 1377</a> </li></ul></dd> @@ -3128,7 +3128,7 @@ <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#line1376">line 1376</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1398">line 1398</a> </li></ul></dd> @@ -3228,7 +3228,7 @@ <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#line1397">line 1397</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1419">line 1419</a> </li></ul></dd> @@ -3328,7 +3328,7 @@ <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#line1418">line 1418</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1440">line 1440</a> </li></ul></dd> @@ -3428,7 +3428,7 @@ <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#line1439">line 1439</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1461">line 1461</a> </li></ul></dd> @@ -3528,7 +3528,7 @@ <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#line1460">line 1460</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1482">line 1482</a> </li></ul></dd> @@ -3628,7 +3628,7 @@ <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#line1055">line 1055</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1077">line 1077</a> </li></ul></dd> @@ -3728,7 +3728,7 @@ <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#line1484">line 1484</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1506">line 1506</a> </li></ul></dd> @@ -3877,7 +3877,7 @@ <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#line915">line 915</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line937">line 937</a> </li></ul></dd> @@ -4061,7 +4061,7 @@ <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#line937">line 937</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line959">line 959</a> </li></ul></dd> @@ -4216,7 +4216,7 @@ <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#line960">line 960</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line982">line 982</a> </li></ul></dd> @@ -4400,7 +4400,7 @@ <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#line982">line 982</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1004">line 1004</a> </li></ul></dd> @@ -4555,7 +4555,7 @@ <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#line1003">line 1003</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1025">line 1025</a> </li></ul></dd> @@ -4710,7 +4710,7 @@ <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#line1087">line 1087</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1109">line 1109</a> </li></ul></dd> @@ -4865,7 +4865,7 @@ <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#line1024">line 1024</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1046">line 1046</a> </li></ul></dd> @@ -5020,7 +5020,7 @@ <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#line1066">line 1066</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1088">line 1088</a> </li></ul></dd> @@ -5175,7 +5175,7 @@ <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#line1150">line 1150</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1172">line 1172</a> </li></ul></dd> @@ -5342,7 +5342,7 @@ <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#line1497">line 1497</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1519">line 1519</a> </li></ul></dd> @@ -5526,7 +5526,7 @@ <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#line1108">line 1108</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1130">line 1130</a> </li></ul></dd> @@ -5681,7 +5681,7 @@ <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#line1129">line 1129</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1151">line 1151</a> </li></ul></dd> @@ -5836,7 +5836,7 @@ <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#line1173">line 1173</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1195">line 1195</a> </li></ul></dd> @@ -6020,7 +6020,7 @@ <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#line1195">line 1195</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1217">line 1217</a> </li></ul></dd> @@ -6187,7 +6187,7 @@ <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#line1521">line 1521</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1543">line 1543</a> </li></ul></dd> @@ -6371,7 +6371,7 @@ <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#line1216">line 1216</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1238">line 1238</a> </li></ul></dd> @@ -6526,7 +6526,7 @@ <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#line1237">line 1237</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1259">line 1259</a> </li></ul></dd> @@ -6681,7 +6681,7 @@ <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#line1279">line 1279</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1301">line 1301</a> </li></ul></dd> @@ -6836,7 +6836,7 @@ <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#line1258">line 1258</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1280">line 1280</a> </li></ul></dd> @@ -6991,7 +6991,7 @@ <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#line1300">line 1300</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1322">line 1322</a> </li></ul></dd> @@ -7146,7 +7146,7 @@ <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#line1323">line 1323</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1345">line 1345</a> </li></ul></dd> @@ -7330,7 +7330,7 @@ <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#line1345">line 1345</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1367">line 1367</a> </li></ul></dd> @@ -7485,7 +7485,7 @@ <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#line1366">line 1366</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1388">line 1388</a> </li></ul></dd> @@ -7640,7 +7640,7 @@ <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#line1387">line 1387</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1409">line 1409</a> </li></ul></dd> @@ -7795,7 +7795,7 @@ <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#line1408">line 1408</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1430">line 1430</a> </li></ul></dd> @@ -7950,7 +7950,7 @@ <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#line1429">line 1429</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1451">line 1451</a> </li></ul></dd> @@ -8105,7 +8105,7 @@ <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#line1450">line 1450</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1472">line 1472</a> </li></ul></dd> @@ -8260,7 +8260,7 @@ <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#line1045">line 1045</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1067">line 1067</a> </li></ul></dd> @@ -8415,7 +8415,7 @@ <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#line1473">line 1473</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line1495">line 1495</a> </li></ul></dd> @@ -8518,7 +8518,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/CacheConfiguration.js.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/CacheConfiguration.js.html b/modules/platforms/nodejs/api_spec/CacheConfiguration.js.html index 9eab739..3422033 100644 --- a/modules/platforms/nodejs/api_spec/CacheConfiguration.js.html +++ b/modules/platforms/nodejs/api_spec/CacheConfiguration.js.html @@ -440,8 +440,10 @@ class QueryField { this._typeName = typeName; this._isKeyField = false; this._isNotNull = false; - this._defaultValue = null; + this._defaultValue = undefined; this._valueType = null; + this._buffer = null; + this._index = null; } /** @@ -542,6 +544,7 @@ class QueryField { setDefaultValue(defaultValue, valueType = null) { this._defaultValue = defaultValue; this._valueType = valueType; + return this; } /** @@ -552,10 +555,26 @@ class QueryField { * - or an instance of class representing non-primitive (composite) type * - or null (or not specified) that means the type is not specified * + * @async + * * @return {*} */ - getDefaultValue(valueType = null) { - return this._defaultValue; + async getDefaultValue(valueType = null) { + if (this._defaultValue === undefined) { + if (this._buffer) { + const position = this._buffer.position; + this._buffer.position = this._index; + const result = await BinaryReader.readObject(this._buffer, valueType); + this._buffer.position = position; + return result; + } + else { + return null; + } + } + else { + return this._defaultValue; + } } /** Private methods */ @@ -568,7 +587,7 @@ class QueryField { await BinaryWriter.writeString(buffer, this._typeName); buffer.writeBoolean(this._isKeyField); buffer.writeBoolean(this._isNotNull); - await BinaryWriter.writeObject(buffer, this._defaultValue, this._valueType); + await BinaryWriter.writeObject(buffer, this._defaultValue ? this._defaultValue : null, this._valueType); } /** @@ -579,7 +598,10 @@ class QueryField { this._typeName = await BinaryReader.readObject(buffer); this._isKeyField = buffer.readBoolean(); this._isNotNull = buffer.readBoolean(); - this._defaultValue = await BinaryReader.readObject(buffer, this._valueType); + this._defaultValue = undefined; + this._buffer = buffer; + this._index = buffer.position; + await BinaryReader.readObject(buffer); } } @@ -1703,7 +1725,7 @@ module.exports.CacheKeyConfiguration = CacheKeyConfiguration; <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/CacheEntry.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/CacheEntry.html b/modules/platforms/nodejs/api_spec/CacheEntry.html index b860003..eb08719 100644 --- a/modules/platforms/nodejs/api_spec/CacheEntry.html +++ b/modules/platforms/nodejs/api_spec/CacheEntry.html @@ -459,7 +459,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/CacheKeyConfiguration.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/CacheKeyConfiguration.html b/modules/platforms/nodejs/api_spec/CacheKeyConfiguration.html index e5faae9..dc2b3a7 100644 --- a/modules/platforms/nodejs/api_spec/CacheKeyConfiguration.html +++ b/modules/platforms/nodejs/api_spec/CacheKeyConfiguration.html @@ -787,7 +787,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/CollectionObjectType.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/CollectionObjectType.html b/modules/platforms/nodejs/api_spec/CollectionObjectType.html index 7d82ee9..411a50b 100644 --- a/modules/platforms/nodejs/api_spec/CollectionObjectType.html +++ b/modules/platforms/nodejs/api_spec/CollectionObjectType.html @@ -217,7 +217,7 @@ according to the mapping table defined in the description of the <a href="Object <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="ObjectType.js.html">ObjectType.js</a>, <a href="ObjectType.js.html#line280">line 280</a> + <a href="ObjectType.js.html">ObjectType.js</a>, <a href="ObjectType.js.html#line413">line 413</a> </li></ul></dd> @@ -475,7 +475,7 @@ according to the mapping table defined in the description of the <a href="Object <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="ObjectType.js.html">ObjectType.js</a>, <a href="ObjectType.js.html#line249">line 249</a> + <a href="ObjectType.js.html">ObjectType.js</a>, <a href="ObjectType.js.html#line382">line 382</a> </li></ul></dd> @@ -515,7 +515,7 @@ according to the mapping table defined in the description of the <a href="Object <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/ComplexObjectType.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/ComplexObjectType.html b/modules/platforms/nodejs/api_spec/ComplexObjectType.html index 7c5ea6b..83f4fa4 100644 --- a/modules/platforms/nodejs/api_spec/ComplexObjectType.html +++ b/modules/platforms/nodejs/api_spec/ComplexObjectType.html @@ -28,12 +28,11 @@ <header> - <h2><span class="attribs"><span class="type-signature"></span></span>ComplexObjectType<span class="signature">(jsObject, typeNameOrId<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2> + <h2><span class="attribs"><span class="type-signature"></span></span>ComplexObjectType<span class="signature">(jsObject, typeName<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2> <div class="class-description"><p>Class representing a complex type of Ignite object.</p> <p>It is described by COMPOSITE_TYPE.COMPLEX_OBJECT <a href="ObjectType.html#.COMPOSITE_TYPE">ObjectType.COMPOSITE_TYPE</a>, -by a name of the complex type or by the type Id -and by a JavaScript Object which is mapped to/from the Ignite complex type.</p></div> +by a name of the complex type and by a JavaScript Object which is mapped to/from the Ignite complex type.</p></div> </header> @@ -48,7 +47,7 @@ and by a JavaScript Object which is mapped to/from the Ignite complex type.</p>< - <h4 class="name" id="ComplexObjectType"><span class="type-signature"></span>new ComplexObjectType<span class="signature">(jsObject, typeNameOrId<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> + <h4 class="name" id="ComplexObjectType"><span class="type-signature"></span>new ComplexObjectType<span class="signature">(jsObject, typeName<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> @@ -67,7 +66,7 @@ will try to make automatic mapping between JavaScript types and Ignite object ty according to the mapping table defined in the description of the <a href="ObjectType.html">ObjectType</a> class.</p> <p>A type of any field may be specified later by setFieldType() method.</p> <p>By default, the name of the complex type is the name of the JavaScript Object. -The name or the type Id may be explicitely specified using optional typeNameOrId parameter in the constructor.</p> +The name may be explicitely specified using optional typeName parameter in the constructor.</p> </div> @@ -95,6 +94,8 @@ The name or the type Id may be explicitely specified using optional typeNameOrId + <th>Default</th> + <th class="last">Description</th> </tr> @@ -128,6 +129,10 @@ The name or the type Id may be explicitely specified using optional typeNameOrId + <td class="default"> + + </td> + <td class="description last"><p>instance of JavaScript Object which will be mapped to/from this complex type.</p></td> </tr> @@ -136,16 +141,13 @@ The name or the type Id may be explicitely specified using optional typeNameOrId <tr> - <td class="name"><code>typeNameOrId</code></td> + <td class="name"><code>typeName</code></td> <td class="type"> <span class="param-type">string</span> -| - -<span class="param-type">number</span> @@ -164,8 +166,14 @@ The name or the type Id may be explicitely specified using optional typeNameOrId + <td class="default"> + + null + + </td> + - <td class="description last"><p>name of the complex type or the type Id.</p></td> + <td class="description last"><p>name of the complex type.</p></td> </tr> @@ -206,7 +214,7 @@ The name or the type Id may be explicitely specified using optional typeNameOrId <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="ObjectType.js.html">ObjectType.js</a>, <a href="ObjectType.js.html#line337">line 337</a> + <a href="ObjectType.js.html">ObjectType.js</a>, <a href="ObjectType.js.html#line511">line 511</a> </li></ul></dd> @@ -406,7 +414,7 @@ according to the mapping table defined in the description of the <a href="Object <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="ObjectType.js.html">ObjectType.js</a>, <a href="ObjectType.js.html#line399">line 399</a> + <a href="ObjectType.js.html">ObjectType.js</a>, <a href="ObjectType.js.html#line574">line 574</a> </li></ul></dd> @@ -509,7 +517,7 @@ according to the mapping table defined in the description of the <a href="Object <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/CompositeType.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/CompositeType.html b/modules/platforms/nodejs/api_spec/CompositeType.html index dec2784..36b27e6 100644 --- a/modules/platforms/nodejs/api_spec/CompositeType.html +++ b/modules/platforms/nodejs/api_spec/CompositeType.html @@ -84,7 +84,7 @@ <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="ObjectType.js.html">ObjectType.js</a>, <a href="ObjectType.js.html#line182">line 182</a> + <a href="ObjectType.js.html">ObjectType.js</a>, <a href="ObjectType.js.html#line315">line 315</a> </li></ul></dd> @@ -161,7 +161,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/Cursor.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/Cursor.html b/modules/platforms/nodejs/api_spec/Cursor.html index ee06090..6be34b6 100644 --- a/modules/platforms/nodejs/api_spec/Cursor.html +++ b/modules/platforms/nodejs/api_spec/Cursor.html @@ -579,7 +579,7 @@ If the method returns null, no more entries are available.</p> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/Cursor.js.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/Cursor.js.html b/modules/platforms/nodejs/api_spec/Cursor.js.html index ad6cf8e..e29db46 100644 --- a/modules/platforms/nodejs/api_spec/Cursor.js.html +++ b/modules/platforms/nodejs/api_spec/Cursor.js.html @@ -77,7 +77,7 @@ class Cursor { await this._getValues(); this._valueIndex = 0; } - if (this._values) { + if (this._values && this._values.length > 0) { const value = this._values[this._valueIndex]; this._valueIndex++; return value; @@ -190,27 +190,31 @@ class Cursor { buffer.writeLong(this._id); } + /** + * @ignore + */ + _readId(buffer) { + this._id = buffer.readLong(); + } /** * @ignore */ - async _read(buffer) { - const id = buffer.readLong(); - if (this._id) { - if (!this._id.equals(id)) { - throw Errors.IgniteClientError.internalError(); - } - } - else { - this._id = id; - } + async _readRow(buffer) { const CacheEntry = require('./CacheClient').CacheEntry; + return new CacheEntry( + await BinaryReader.readObject(buffer, this._keyType), + await BinaryReader.readObject(buffer, this._valueType)); + } + + /** + * @ignore + */ + async _read(buffer) { const rowCount = buffer.readInteger(); this._values = new Array(rowCount); for (let i = 0; i < rowCount; i++) { - this._values[i] = new CacheEntry( - await BinaryReader.readObject(buffer, this._keyType), - await BinaryReader.readObject(buffer, this._valueType)); + this._values[i] = await this._readRow(buffer); } this._hasNext = buffer.readBoolean(); } @@ -224,6 +228,7 @@ class Cursor { * One instance of this class returns results of one SQL Fields query operation. * * @hideconstructor + * @extends Cursor */ class SqlFieldsCursor extends Cursor { @@ -317,20 +322,14 @@ class SqlFieldsCursor extends Cursor { /** * @ignore */ - async _read(buffer) { - const rowCount = buffer.readInteger(); - this._values = new Array(rowCount); - let values; + async _readRow(buffer) { + let values = new Array(this._fieldCount); let fieldType; - for (let i = 0; i < rowCount; i++) { - values = new Array(this._fieldCount); - for (let j = 0; j < this._fieldCount; j++) { - fieldType = this._fieldTypes && j < this._fieldTypes.length ? this._fieldTypes[j] : null; - values[j] = await BinaryReader.readObject(buffer); - } - this._values[i] = values; + for (let i = 0; i < this._fieldCount; i++) { + fieldType = this._fieldTypes && i < this._fieldTypes.length ? this._fieldTypes[i] : null; + values[i] = await BinaryReader.readObject(buffer); } - this._hasNext = buffer.readBoolean(); + return values; } } @@ -352,7 +351,7 @@ module.exports.SqlFieldsCursor = SqlFieldsCursor; <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/EnumItem.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/EnumItem.html b/modules/platforms/nodejs/api_spec/EnumItem.html index f9c4bf3..96bf448 100644 --- a/modules/platforms/nodejs/api_spec/EnumItem.html +++ b/modules/platforms/nodejs/api_spec/EnumItem.html @@ -30,16 +30,18 @@ <h2><span class="attribs"><span class="type-signature"></span></span>EnumItem<span class="signature">(typeId)</span><span class="type-signature"></span></h2> - <div class="class-description"><p>Class representing an item of enum.</p> + <div class="class-description"><p>Class representing an item of Ignite enum type.</p> <p>The item is defined by:</p> <ul> -<li>type Id (mandatory) - Id of the enum type.</li> -<li>ordinal (optional) - ordinal of the item in the enum type.</li> -<li>name (optional) - name of the item.</li> +<li>type Id (mandatory) - Id of the Ignite enum type.</li> +<li>ordinal (optional) - ordinal of the item in the Ignite enum type.</li> +<li>name (optional) - name of the item (field name in the Ignite enum type).</li> <li>value (optional) - value of the item. Usually, at least one from the optional ordinal, name or value must be specified -in order to use an instance of this class.</li> -</ul></div> +in order to use an instance of this class in Ignite operations.</li> +</ul> +<p>To distinguish one item from another, the Ignite client analyzes the optional fields in the following order: +ordinal, name, value.</p></div> </header> @@ -114,7 +116,7 @@ in order to use an instance of this class.</li> - <td class="description last"><p>Id of the enum type.</p></td> + <td class="description last"><p>Id of the Ignite enum type.</p></td> </tr> @@ -155,7 +157,7 @@ in order to use an instance of this class.</li> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="EnumItem.js.html">EnumItem.js</a>, <a href="EnumItem.js.html#line35">line 35</a> + <a href="EnumItem.js.html">EnumItem.js</a>, <a href="EnumItem.js.html#line37">line 37</a> </li></ul></dd> @@ -262,7 +264,7 @@ or null if name is not set.</p> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="EnumItem.js.html">EnumItem.js</a>, <a href="EnumItem.js.html#line108">line 108</a> + <a href="EnumItem.js.html">EnumItem.js</a>, <a href="EnumItem.js.html#line110">line 110</a> </li></ul></dd> @@ -328,7 +330,7 @@ or null if name is not set.</p> <div class="description"> - <p>Returns ordinal of the item in the enum type + <p>Returns ordinal of the item in the Ignite enum type or null if ordinal is not set.</p> </div> @@ -373,7 +375,7 @@ or null if ordinal is not set.</p> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="EnumItem.js.html">EnumItem.js</a>, <a href="EnumItem.js.html#line83">line 83</a> + <a href="EnumItem.js.html">EnumItem.js</a>, <a href="EnumItem.js.html#line85">line 85</a> </li></ul></dd> @@ -401,7 +403,7 @@ or null if ordinal is not set.</p> <div class="param-desc"> <ul> -<li>ordinal of the item in the enum type.</li> +<li>ordinal of the item in the Ignite enum type.</li> </ul> </div> @@ -439,7 +441,7 @@ or null if ordinal is not set.</p> <div class="description"> - <p>Returns Id of the enum type.</p> + <p>Returns Id of the Ignite enum type.</p> </div> @@ -483,7 +485,7 @@ or null if ordinal is not set.</p> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="EnumItem.js.html">EnumItem.js</a>, <a href="EnumItem.js.html#line58">line 58</a> + <a href="EnumItem.js.html">EnumItem.js</a>, <a href="EnumItem.js.html#line60">line 60</a> </li></ul></dd> @@ -594,7 +596,7 @@ or null if value is not set.</p> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="EnumItem.js.html">EnumItem.js</a>, <a href="EnumItem.js.html#line133">line 133</a> + <a href="EnumItem.js.html">EnumItem.js</a>, <a href="EnumItem.js.html#line135">line 135</a> </li></ul></dd> @@ -753,7 +755,7 @@ or null if value is not set.</p> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="EnumItem.js.html">EnumItem.js</a>, <a href="EnumItem.js.html#line121">line 121</a> + <a href="EnumItem.js.html">EnumItem.js</a>, <a href="EnumItem.js.html#line123">line 123</a> </li></ul></dd> @@ -848,7 +850,7 @@ or null if value is not set.</p> <div class="description"> - <p>Sets or updates ordinal of the item in the enum type.</p> + <p>Sets or updates ordinal of the item in the Ignite enum type.</p> </div> @@ -900,7 +902,7 @@ or null if value is not set.</p> - <td class="description last"><p>ordinal of the item in the enum type.</p></td> + <td class="description last"><p>ordinal of the item in the Ignite enum type.</p></td> </tr> @@ -941,7 +943,7 @@ or null if value is not set.</p> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="EnumItem.js.html">EnumItem.js</a>, <a href="EnumItem.js.html#line96">line 96</a> + <a href="EnumItem.js.html">EnumItem.js</a>, <a href="EnumItem.js.html#line98">line 98</a> </li></ul></dd> @@ -1036,7 +1038,7 @@ or null if value is not set.</p> <div class="description"> - <p>Updates Id of the enum type.</p> + <p>Updates Id of the Ignite enum type.</p> </div> @@ -1088,7 +1090,7 @@ or null if value is not set.</p> - <td class="description last"><p>new Id of the enum type.</p></td> + <td class="description last"><p>new Id of the Ignite enum type.</p></td> </tr> @@ -1129,7 +1131,7 @@ or null if value is not set.</p> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="EnumItem.js.html">EnumItem.js</a>, <a href="EnumItem.js.html#line71">line 71</a> + <a href="EnumItem.js.html">EnumItem.js</a>, <a href="EnumItem.js.html#line73">line 73</a> </li></ul></dd> @@ -1317,7 +1319,7 @@ or null if value is not set.</p> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="EnumItem.js.html">EnumItem.js</a>, <a href="EnumItem.js.html#line146">line 146</a> + <a href="EnumItem.js.html">EnumItem.js</a>, <a href="EnumItem.js.html#line148">line 148</a> </li></ul></dd> @@ -1420,7 +1422,7 @@ or null if value is not set.</p> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/EnumItem.js.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/EnumItem.js.html b/modules/platforms/nodejs/api_spec/EnumItem.js.html index 0ff6190..b770fdd 100644 --- a/modules/platforms/nodejs/api_spec/EnumItem.js.html +++ b/modules/platforms/nodejs/api_spec/EnumItem.js.html @@ -49,23 +49,25 @@ const ArgumentChecker = require('./internal/ArgumentChecker'); const Errors = require('./Errors'); /** - * Class representing an item of enum. + * Class representing an item of Ignite enum type. * * The item is defined by: - * - type Id (mandatory) - Id of the enum type. - * - ordinal (optional) - ordinal of the item in the enum type. - * - name (optional) - name of the item. + * - type Id (mandatory) - Id of the Ignite enum type. + * - ordinal (optional) - ordinal of the item in the Ignite enum type. + * - name (optional) - name of the item (field name in the Ignite enum type). * - value (optional) - value of the item. * Usually, at least one from the optional ordinal, name or value must be specified - * in order to use an instance of this class. + * in order to use an instance of this class in Ignite operations. * + * To distinguish one item from another, the Ignite client analyzes the optional fields in the following order: + * ordinal, name, value. */ class EnumItem { /** * Public constructor. * - * @param {number} typeId - Id of the enum type. + * @param {number} typeId - Id of the Ignite enum type. * * @return {EnumItem} - new EnumItem instance * @@ -79,7 +81,7 @@ class EnumItem { } /** - * Returns Id of the enum type. + * Returns Id of the Ignite enum type. * * @return {number} - Id of the enum type. */ @@ -88,9 +90,9 @@ class EnumItem { } /** - * Updates Id of the enum type. + * Updates Id of the Ignite enum type. * - * @param {number} typeId - new Id of the enum type. + * @param {number} typeId - new Id of the Ignite enum type. * * @return {EnumItem} - the same instance of EnumItem * @@ -103,19 +105,19 @@ class EnumItem { } /** - * Returns ordinal of the item in the enum type + * Returns ordinal of the item in the Ignite enum type * or null if ordinal is not set. * - * @return {number} - ordinal of the item in the enum type. + * @return {number} - ordinal of the item in the Ignite enum type. */ getOrdinal() { return this._ordinal; } /** - * Sets or updates ordinal of the item in the enum type. + * Sets or updates ordinal of the item in the Ignite enum type. * - * @param {number} ordinal - ordinal of the item in the enum type. + * @param {number} ordinal - ordinal of the item in the Ignite enum type. * * @return {EnumItem} - the same instance of EnumItem * @@ -244,7 +246,7 @@ module.exports = EnumItem; <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/Errors.js.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/Errors.js.html b/modules/platforms/nodejs/api_spec/Errors.js.html index b09ec00..4d6583b 100644 --- a/modules/platforms/nodejs/api_spec/Errors.js.html +++ b/modules/platforms/nodejs/api_spec/Errors.js.html @@ -163,7 +163,7 @@ module.exports.LostConnectionError = LostConnectionError; <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/IgniteClient.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/IgniteClient.html b/modules/platforms/nodejs/api_spec/IgniteClient.html index 41ec326..6c14c33 100644 --- a/modules/platforms/nodejs/api_spec/IgniteClient.html +++ b/modules/platforms/nodejs/api_spec/IgniteClient.html @@ -2359,7 +2359,7 @@ Disabled by default.</p> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/IgniteClient.js.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/IgniteClient.js.html b/modules/platforms/nodejs/api_spec/IgniteClient.js.html index f839a17..05c9522 100644 --- a/modules/platforms/nodejs/api_spec/IgniteClient.js.html +++ b/modules/platforms/nodejs/api_spec/IgniteClient.js.html @@ -334,7 +334,7 @@ module.exports = IgniteClient; <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/IgniteClientConfiguration.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/IgniteClientConfiguration.html b/modules/platforms/nodejs/api_spec/IgniteClientConfiguration.html index 701a563..f22f027 100644 --- a/modules/platforms/nodejs/api_spec/IgniteClientConfiguration.html +++ b/modules/platforms/nodejs/api_spec/IgniteClientConfiguration.html @@ -339,9 +339,11 @@ with the provided mandatory settings and default optional settings.</p> </td> - <td class="description last"><p>connection options. - For non-secure connection: options defined here https://nodejs.org/api/net.html#net_socket_connect_options_connectlistener - For secure connection: options defined here https://nodejs.org/api/tls.html#tls_tls_connect_options_callback</p></td> + <td class="description last"><p>connection options.</p> +<ul> +<li>For non-secure connection options defined here <a href="https://nodejs.org/api/net.html#net_socket_connect_options_connectlistener";>https://nodejs.org/api/net.html#net_socket_connect_options_connectlistener</a></li> +<li>For secure connection options defined here <a href="https://nodejs.org/api/tls.html#tls_tls_connect_options_callback";>https://nodejs.org/api/tls.html#tls_tls_connect_options_callback</a></li> +</ul></td> </tr> @@ -835,7 +837,7 @@ If password is not set, it is considered empty.</p> <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/IgniteClientConfiguration.js.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/IgniteClientConfiguration.js.html b/modules/platforms/nodejs/api_spec/IgniteClientConfiguration.js.html index 3abb167..c7a3622 100644 --- a/modules/platforms/nodejs/api_spec/IgniteClientConfiguration.js.html +++ b/modules/platforms/nodejs/api_spec/IgniteClientConfiguration.js.html @@ -125,8 +125,8 @@ class IgniteClientConfiguration { * @param {boolean} useTLS - if true, secure connection will be established; * if false, non-secure connection will be established. * @param {object} [connectionOptions=null] - connection options. - * For non-secure connection: options defined here https://nodejs.org/api/net.html#net_socket_connect_options_connectlistener - * For secure connection: options defined here https://nodejs.org/api/tls.html#tls_tls_connect_options_callback + * - For non-secure connection options defined here {@link https://nodejs.org/api/net.html#net_socket_connect_options_connectlistener} + * - For secure connection options defined here {@link https://nodejs.org/api/tls.html#tls_tls_connect_options_callback} * * @return {IgniteClientConfiguration} - the same instance of the IgniteClientConfiguration. */ @@ -154,7 +154,7 @@ module.exports = IgniteClientConfiguration; <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/IgniteClientError.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/IgniteClientError.html b/modules/platforms/nodejs/api_spec/IgniteClientError.html index 90f8b03..4a1999e 100644 --- a/modules/platforms/nodejs/api_spec/IgniteClientError.html +++ b/modules/platforms/nodejs/api_spec/IgniteClientError.html @@ -159,7 +159,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/IllegalStateError.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/IllegalStateError.html b/modules/platforms/nodejs/api_spec/IllegalStateError.html index 16905e9..0f33282 100644 --- a/modules/platforms/nodejs/api_spec/IllegalStateError.html +++ b/modules/platforms/nodejs/api_spec/IllegalStateError.html @@ -170,7 +170,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/LostConnectionError.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/LostConnectionError.html b/modules/platforms/nodejs/api_spec/LostConnectionError.html index 1f66500..75e0b8e 100644 --- a/modules/platforms/nodejs/api_spec/LostConnectionError.html +++ b/modules/platforms/nodejs/api_spec/LostConnectionError.html @@ -170,7 +170,7 @@ <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/MapObjectType.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/MapObjectType.html b/modules/platforms/nodejs/api_spec/MapObjectType.html index bf01b47..66ee558 100644 --- a/modules/platforms/nodejs/api_spec/MapObjectType.html +++ b/modules/platforms/nodejs/api_spec/MapObjectType.html @@ -268,7 +268,7 @@ according to the mapping table defined in the description of the <a href="Object <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="ObjectType.js.html">ObjectType.js</a>, <a href="ObjectType.js.html#line206">line 206</a> + <a href="ObjectType.js.html">ObjectType.js</a>, <a href="ObjectType.js.html#line339">line 339</a> </li></ul></dd> @@ -436,7 +436,7 @@ according to the mapping table defined in the description of the <a href="Object <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="ObjectType.js.html">ObjectType.js</a>, <a href="ObjectType.js.html#line185">line 185</a> + <a href="ObjectType.js.html">ObjectType.js</a>, <a href="ObjectType.js.html#line318">line 318</a> </li></ul></dd> @@ -476,7 +476,7 @@ according to the mapping table defined in the description of the <a href="Object <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script> http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/ObjectArrayType.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/ObjectArrayType.html b/modules/platforms/nodejs/api_spec/ObjectArrayType.html index 8437d02..ceb96dc 100644 --- a/modules/platforms/nodejs/api_spec/ObjectArrayType.html +++ b/modules/platforms/nodejs/api_spec/ObjectArrayType.html @@ -30,9 +30,8 @@ <h2><span class="attribs"><span class="type-signature"></span></span>ObjectArrayType<span class="signature">(elementType<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2> - <div class="class-description"><p>??? Class representing an array of Ignite complex type objects.</p> -<p>It is described by COMPOSITE_TYPE.OBJECT_ARRAY <a href="ObjectType.html#.COMPOSITE_TYPE">ObjectType.COMPOSITE_TYPE</a> -and by a concrete <a href="CompositeType.html">CompositeType</a> instance which defines an element of the array.</p></div> + <div class="class-description"><p>Class representing an array type of Ignite objects.</p> +<p>It is described by COMPOSITE_TYPE.OBJECT_ARRAY <a href="ObjectType.html#.COMPOSITE_TYPE">ObjectType.COMPOSITE_TYPE</a>.</p></div> </header> @@ -56,6 +55,10 @@ and by a concrete <a href="CompositeType.html">CompositeType</a> instance which <div class="description"> <p>Public constructor.</p> +<p>Optionally specifies a type of elements in the array.</p> +<p>If the type of elements 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> @@ -101,6 +104,9 @@ and by a concrete <a href="CompositeType.html">CompositeType</a> instance which <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> @@ -127,7 +133,12 @@ and by a concrete <a href="CompositeType.html">CompositeType</a> instance which </td> - <td class="description last"><p>type of the array element</p></td> + <td class="description last"><p>type of the array element:</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> @@ -168,7 +179,7 @@ and by a concrete <a href="CompositeType.html">CompositeType</a> instance which <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="ObjectType.js.html">ObjectType.js</a>, <a href="ObjectType.js.html#line428">line 428</a> + <a href="ObjectType.js.html">ObjectType.js</a>, <a href="ObjectType.js.html#line475">line 475</a> </li></ul></dd> @@ -245,7 +256,7 @@ and by a concrete <a href="CompositeType.html">CompositeType</a> instance which <br class="clear"> <footer> - Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Sat May 05 2018 19:39:34 GMT+0300 (Russia TZ 2 Standard Time) + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc";>JSDoc 3.5.5</a> on Tue May 08 2018 23:52:08 GMT+0300 (Russia TZ 2 Standard Time) </footer> <script> prettyPrint(); </script>
