http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/ObjectType.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/ObjectType.html b/modules/platforms/nodejs/api_spec/ObjectType.html index aecb9d0..e0d38a5 100644 --- a/modules/platforms/nodejs/api_spec/ObjectType.html +++ b/modules/platforms/nodejs/api_spec/ObjectType.html @@ -44,30 +44,145 @@ Eg. a kind of map or a kind of collection.</p> </ul> <p>This class helps the Ignite client to make a mapping between JavaScript types and types used by Ignite.</p> -<p>In many methods the Ignite client does not require to directly specify an object type. +<p>In many methods the Ignite client does not require to directly specify a type of Ignite object. In this case the Ignite client tries to make automatic mapping between JavaScript types -and Ignite object types according to the following mapping table:</p> -<p><pre> - TODO - JavaScript type to / from type code (<a href="ObjectType.html#.PRIMITIVE_TYPE">ObjectType.PRIMITIVE_TYPE</a> and <a href="ObjectType.html#.COMPOSITE_TYPE">ObjectType.COMPOSITE_TYPE</a>) - null to / from NULL - number to / from DOUBLE - Array of number to / from DOUBLE_ARRAY - string to / from STRING - Array of string to / from STRING_ARRAY - boolean to / from BOOLEAN - Array of boolean to / from BOOLEAN_ARRAY - Date to / from DATE - Array of Date to / from DATE_ARRAY - Map to / from MAP (HASH_MAP) - BinaryObject to / from COMPLEX_OBJECT - Array of BinaryObject to / from OBJECT_ARRAY - any other Object to / - COMPLEX_OBJECT - Array of any other Object to / - OBJECT_ARRAY +and Ignite object types according to the following mapping tables:</p> +<hr> +<p>DEFAULT MAPPING FROM JavaScript type TO Ignite type code.</p> +<p>This mapping is used when an application does not explicitly specify an Ignite type +for a field and is writing data to that field.</p> +<pre> +| JavaScript type | Ignite type code | +| ------------------------- | ----------------------| +| number | DOUBLE | +| boolean | BOOLEAN | +| string | STRING | +| Date | DATE | +| Timestamp* | TIMESTAMP | +| EnumItem* | ENUM | +| Decimal** | DECIMAL | +| BinaryObject* | COMPLEX_OBJECT | +| Array of number | DOUBLE_ARRAY | +| Array of boolean | BOOLEAN_ARRAY | +| Array of string | STRING_ARRAY | +| Array of Date | DATE_ARRAY | +| Array of Timestamp* | TIMESTAMP_ARRAY | +| Array of EnumItem* | ENUM_ARRAY | +| Array of Decimal** | DECIMAL_ARRAY | +| Array of BinaryObject* | OBJECT_ARRAY | +| Array of any other Object | OBJECT_ARRAY | +| Set | COLLECTION (HASH_SET) | +| Map | MAP (HASH_MAP) | +| any other Object | COMPLEX_OBJECT | </pre> -Note: type of an array content is determined by the type of the first element of the array -(empty array has no automatic mapping).</p> -<p>All other JavaScript types have no automatic mapping.</p></div> + +<p>Type of an array content is determined by the type of the first element of the array. +Empty array has no default mapping.</p> +<p>All other JavaScript types have no default mapping.</p> +<hr> +<p>DEFAULT MAPPING FROM Ignite type code TO JavaScript type.</p> +<p>This mapping is used when an application does not explicitly specify an Ignite type +for a field and is reading data from that field.</p> +<pre> +| Ignite type code | JavaScript type | +| ---------------------------- | --------------------------------------| +| BYTE | number | +| SHORT | number | +| INTEGER | number | +| LONG | number | +| FLOAT | number | +| DOUBLE | number | +| DECIMAL | Decimal** | +| BOOLEAN | boolean | +| STRING | string | +| CHAR | string (one character) | +| UUID | Array of number (16 numbers) | +| DATE | Date | +| TIME | Date | +| TIMESTAMP | Timestamp* | +| ENUM | EnumItem* | +| COMPLEX_OBJECT | BinaryObject* | +| BYTE_ARRAY | Array of number | +| SHORT_ARRAY | Array of number | +| INTEGER_ARRAY | Array of number | +| LONG_ARRAY | Array of number | +| FLOAT_ARRAY | Array of number | +| DOUBLE_ARRAY | Array of number | +| DECIMAL_ARRAY | Array of Decimal** | +| BOOLEAN_ARRAY | Array of boolean | +| STRING_ARRAY | Array of string | +| CHAR_ARRAY | Array of string (one character) | +| UUID_ARRAY | Array of Array of number (16 numbers) | +| DATE_ARRAY | Array of Date | +| TIME_ARRAY | Array of Date | +| TIMESTAMP_ARRAY | Array of Timestamp* | +| ENUM_ARRAY | Array of EnumItem* | +| OBJECT_ARRAY | Array | +| COLLECTION (USER_COL) | Array | +| COLLECTION (ARR_LIST) | Array | +| COLLECTION (LINKED_LIST) | Array | +| COLLECTION (SINGLETON_LIST) | Array | +| COLLECTION (HASH_SET) | Set | +| COLLECTION (LINKED_HASH_SET) | Set | +| COLLECTION (USER_SET) | Set | +| MAP (HASH_MAP) | Map | +| MAP (LINKED_HASH_MAP) | Map | +| NULL | null | +</pre> + +<hr> +<p>RETURNED JavaScript types WHEN READING DATA OF THE SPECIFIED Ignite type code.</p> +<p>When an application explicitly specifies an Ignite type for a field +and is reading data from that field - the following JavaScript types +are returned for every concrete Ignite type code -</p> +<p>SEE THE PREVIOUS TABLE with the following additional comments:</p> +<ul> +<li><p>for COMPLEX_OBJECT the Ignite Client returns a JavaScript Object +which is defined by the specified <a href="ComplexObjectType.html">ComplexObjectType</a>.</p> +</li> +<li><p>the returned Map for MAP is defined by the specified <a href="MapObjectType.html">MapObjectType</a>.</p> +</li> +<li><p>the returned Set or Array for COLLECTION is defined by the specified <a href="CollectionObjectType.html">CollectionObjectType</a>.</p> +</li> +<li><p>the returned Array for OBJECT_ARRAY is defined by the specified <a href="ObjectArrayType.html">ObjectArrayType</a>.</p> +</li> +<li><p>NULL cannot be specified as a type of a field but JavaScript null may be returned +as a value of a field.</p> +</li> +</ul> +<hr> +<p>ALLOWED JavaScript types WHEN WRITING DATA OF THE SPECIFIED Ignite type code.</p> +<p>When an application explicitly specifies an Ignite type for a field +and is writing data to that field - the following JavaScript types +are allowed for every concrete Ignite type code -</p> +<p>SEE THE PREVIOUS TABLE with the following additional comments:</p> +<ul> +<li><p>for COMPLEX_OBJECT the Ignite Client allows a JavaScript Object +which is defined by the specified <a href="ComplexObjectType.html">ComplexObjectType</a>.</p> +</li> +<li><p>the allowed Map for MAP is defined by the specified <a href="MapObjectType.html">MapObjectType</a>.</p> +</li> +<li><p>the allowed Set or Array for COLLECTION is defined by the specified <a href="CollectionObjectType.html">CollectionObjectType</a>.</p> +</li> +<li><p>the allowed Array for OBJECT_ARRAY is defined by the specified <a href="ObjectArrayType.html">ObjectArrayType</a>.</p> +</li> +<li><p>NULL cannot be specified as a type of a field but JavaScript null is allowed +as value of a field (but not as a key/value in a cache) or as a value of Array/Set/Map element +for all Ignite types, except BYTE, SHORT, INTEGER, LONG, FLOAT, DOUBLE, CHAR, BOOLEAN.</p> +</li> +<li><p>for all *_ARRAY Ignite types an empty JavaScript Array is allowed.</p> +</li> +</ul> +<hr> +<p>COMMENTS TO ALL TABLES</p> +<p>JavaScript type - is a JavaScript primitive or a JavaScript Object +(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures";>https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures</a>)</p> +<p>(*) Timestamp, EnumItem and BinaryObject - are JavaScript Objects introduced by the Ignite client.</p> +<p>(**) Decimal - is an external JavaScript Object exported into the Ignite client +(<a href="https://github.com/MikeMcl/decimal.js";>https://github.com/MikeMcl/decimal.js</a>)</p> +<p>Ignite type code - is the type code of an Ignite primitive type (<a href="ObjectType.html#.PRIMITIVE_TYPE">ObjectType.PRIMITIVE_TYPE</a>) +or an Ignite composite type (<a href="ObjectType.html#.COMPOSITE_TYPE">ObjectType.COMPOSITE_TYPE</a>).</p> +<hr></div> </header> @@ -120,7 +235,7 @@ Note: type of an array content is determined by the type of the first element of <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#line158">line 158</a> + <a href="ObjectType.js.html">ObjectType.js</a>, <a href="ObjectType.js.html#line291">line 291</a> </li></ul></dd> @@ -1002,7 +1117,7 @@ Note: type of an array content is determined by the type of the first element of <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/ObjectType.js.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/ObjectType.js.html b/modules/platforms/nodejs/api_spec/ObjectType.js.html index 54c8eb9..3771526 100644 --- a/modules/platforms/nodejs/api_spec/ObjectType.js.html +++ b/modules/platforms/nodejs/api_spec/ObjectType.js.html @@ -154,31 +154,164 @@ const COMPOSITE_TYPE = Object.freeze({ * This class helps the Ignite client to make a mapping between JavaScript types * and types used by Ignite. * - * In many methods the Ignite client does not require to directly specify an object type. + * In many methods the Ignite client does not require to directly specify a type of Ignite object. * In this case the Ignite client tries to make automatic mapping between JavaScript types - * and Ignite object types according to the following mapping table: + * and Ignite object types according to the following mapping tables: + * + * ---------------------------------------------------------------------------- + * + * DEFAULT MAPPING FROM JavaScript type TO Ignite type code. + * + * This mapping is used when an application does not explicitly specify an Ignite type + * for a field and is writing data to that field. + * + * <pre> + * | JavaScript type | Ignite type code | + * | ------------------------- | ----------------------| + * | number | DOUBLE | + * | boolean | BOOLEAN | + * | string | STRING | + * | Date | DATE | + * | Timestamp* | TIMESTAMP | + * | EnumItem* | ENUM | + * | Decimal** | DECIMAL | + * | BinaryObject* | COMPLEX_OBJECT | + * | Array of number | DOUBLE_ARRAY | + * | Array of boolean | BOOLEAN_ARRAY | + * | Array of string | STRING_ARRAY | + * | Array of Date | DATE_ARRAY | + * | Array of Timestamp* | TIMESTAMP_ARRAY | + * | Array of EnumItem* | ENUM_ARRAY | + * | Array of Decimal** | DECIMAL_ARRAY | + * | Array of BinaryObject* | OBJECT_ARRAY | + * | Array of any other Object | OBJECT_ARRAY | + * | Set | COLLECTION (HASH_SET) | + * | Map | MAP (HASH_MAP) | + * | any other Object | COMPLEX_OBJECT | + * </pre> + * + * Type of an array content is determined by the type of the first element of the array. + * Empty array has no default mapping. + * + * All other JavaScript types have no default mapping. + * + * ---------------------------------------------------------------------------- + * + * DEFAULT MAPPING FROM Ignite type code TO JavaScript type. + * + * This mapping is used when an application does not explicitly specify an Ignite type + * for a field and is reading data from that field. + * * <pre> - * TODO - * JavaScript type to / from type code ({@link ObjectType.PRIMITIVE_TYPE} and {@link ObjectType.COMPOSITE_TYPE}) - * null to / from NULL - * number to / from DOUBLE - * Array of number to / from DOUBLE_ARRAY - * string to / from STRING - * Array of string to / from STRING_ARRAY - * boolean to / from BOOLEAN - * Array of boolean to / from BOOLEAN_ARRAY - * Date to / from DATE - * Array of Date to / from DATE_ARRAY - * Map to / from MAP (HASH_MAP) - * BinaryObject to / from COMPLEX_OBJECT - * Array of BinaryObject to / from OBJECT_ARRAY - * any other Object to / - COMPLEX_OBJECT - * Array of any other Object to / - OBJECT_ARRAY + * | Ignite type code | JavaScript type | + * | ---------------------------- | --------------------------------------| + * | BYTE | number | + * | SHORT | number | + * | INTEGER | number | + * | LONG | number | + * | FLOAT | number | + * | DOUBLE | number | + * | DECIMAL | Decimal** | + * | BOOLEAN | boolean | + * | STRING | string | + * | CHAR | string (one character) | + * | UUID | Array of number (16 numbers) | + * | DATE | Date | + * | TIME | Date | + * | TIMESTAMP | Timestamp* | + * | ENUM | EnumItem* | + * | COMPLEX_OBJECT | BinaryObject* | + * | BYTE_ARRAY | Array of number | + * | SHORT_ARRAY | Array of number | + * | INTEGER_ARRAY | Array of number | + * | LONG_ARRAY | Array of number | + * | FLOAT_ARRAY | Array of number | + * | DOUBLE_ARRAY | Array of number | + * | DECIMAL_ARRAY | Array of Decimal** | + * | BOOLEAN_ARRAY | Array of boolean | + * | STRING_ARRAY | Array of string | + * | CHAR_ARRAY | Array of string (one character) | + * | UUID_ARRAY | Array of Array of number (16 numbers) | + * | DATE_ARRAY | Array of Date | + * | TIME_ARRAY | Array of Date | + * | TIMESTAMP_ARRAY | Array of Timestamp* | + * | ENUM_ARRAY | Array of EnumItem* | + * | OBJECT_ARRAY | Array | + * | COLLECTION (USER_COL) | Array | + * | COLLECTION (ARR_LIST) | Array | + * | COLLECTION (LINKED_LIST) | Array | + * | COLLECTION (SINGLETON_LIST) | Array | + * | COLLECTION (HASH_SET) | Set | + * | COLLECTION (LINKED_HASH_SET) | Set | + * | COLLECTION (USER_SET) | Set | + * | MAP (HASH_MAP) | Map | + * | MAP (LINKED_HASH_MAP) | Map | + * | NULL | null | * </pre> - * Note: type of an array content is determined by the type of the first element of the array - * (empty array has no automatic mapping). * - * All other JavaScript types have no automatic mapping. + * ---------------------------------------------------------------------------- + * + * RETURNED JavaScript types WHEN READING DATA OF THE SPECIFIED Ignite type code. + * + * When an application explicitly specifies an Ignite type for a field + * and is reading data from that field - the following JavaScript types + * are returned for every concrete Ignite type code - + * + * SEE THE PREVIOUS TABLE with the following additional comments: + * + * - for COMPLEX_OBJECT the Ignite Client returns a JavaScript Object + * which is defined by the specified {@link ComplexObjectType}. + * + * - the returned Map for MAP is defined by the specified {@link MapObjectType}. + * + * - the returned Set or Array for COLLECTION is defined by the specified {@link CollectionObjectType}. + * + * - the returned Array for OBJECT_ARRAY is defined by the specified {@link ObjectArrayType}. + * + * - NULL cannot be specified as a type of a field but JavaScript null may be returned + * as a value of a field. + * + * ---------------------------------------------------------------------------- + * + * ALLOWED JavaScript types WHEN WRITING DATA OF THE SPECIFIED Ignite type code. + * + * When an application explicitly specifies an Ignite type for a field + * and is writing data to that field - the following JavaScript types + * are allowed for every concrete Ignite type code - + * + * SEE THE PREVIOUS TABLE with the following additional comments: + * + * - for COMPLEX_OBJECT the Ignite Client allows a JavaScript Object + * which is defined by the specified {@link ComplexObjectType}. + * + * - the allowed Map for MAP is defined by the specified {@link MapObjectType}. + * + * - the allowed Set or Array for COLLECTION is defined by the specified {@link CollectionObjectType}. + * + * - the allowed Array for OBJECT_ARRAY is defined by the specified {@link ObjectArrayType}. + * + * - NULL cannot be specified as a type of a field but JavaScript null is allowed + * as value of a field (but not as a key/value in a cache) or as a value of Array/Set/Map element + * for all Ignite types, except BYTE, SHORT, INTEGER, LONG, FLOAT, DOUBLE, CHAR, BOOLEAN. + * + * - for all *_ARRAY Ignite types an empty JavaScript Array is allowed. + * + * ---------------------------------------------------------------------------- + * + * COMMENTS TO ALL TABLES + * + * JavaScript type - is a JavaScript primitive or a JavaScript Object + * ({@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures}) + * + * (*) Timestamp, EnumItem and BinaryObject - are JavaScript Objects introduced by the Ignite client. + * + * (**) Decimal - is an external JavaScript Object exported into the Ignite client + * ({@link https://github.com/MikeMcl/decimal.js}) + * + * Ignite type code - is the type code of an Ignite primitive type ({@link ObjectType.PRIMITIVE_TYPE}) + * or an Ignite composite type ({@link ObjectType.COMPOSITE_TYPE}). + * + * ---------------------------------------------------------------------------- * * @hideconstructor */ @@ -346,10 +479,52 @@ class CollectionObjectType extends CompositeType { /** * @ignore */ + static _isSet(subType) { + return subType === CollectionObjectType.COLLECTION_SUBTYPE.USER_SET || + subType === CollectionObjectType.COLLECTION_SUBTYPE.HASH_SET || + subType === CollectionObjectType.COLLECTION_SUBTYPE.LINKED_HASH_SET; + } + + /** + * @ignore + */ _isSet() { - return this._subType === CollectionObjectType.COLLECTION_SUBTYPE.USER_SET || - this._subType === CollectionObjectType.COLLECTION_SUBTYPE.HASH_SET || - this._subType === CollectionObjectType.COLLECTION_SUBTYPE.LINKED_HASH_SET; + return CollectionObjectType._isSet(this._subType); + } +} + +/** + * Class representing an array type of Ignite objects. + * + * It is described by COMPOSITE_TYPE.OBJECT_ARRAY {@link ObjectType.COMPOSITE_TYPE}. + * + * @extends CompositeType + */ +class ObjectArrayType extends CompositeType { + + /** + * Public constructor. + * + * Optionally specifies a type of elements in the array. + * + * 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 {@link ObjectType} class. + * + * @param {ObjectType.PRIMITIVE_TYPE | CompositeType} [elementType=null] - type of the array element: + * - 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 {ObjectArrayType} - new ObjectArrayType instance + * + * @throws {IgniteClientError} if error. + */ + constructor(elementType = null) { + super(COMPOSITE_TYPE.OBJECT_ARRAY); + const BinaryUtils = require('./internal/BinaryUtils'); + BinaryUtils.checkObjectType(elementType, 'elementType'); + this._elementType = elementType; } } @@ -357,8 +532,7 @@ class CollectionObjectType extends CompositeType { * Class representing a complex type of Ignite object. * * It is described by COMPOSITE_TYPE.COMPLEX_OBJECT {@link ObjectType.COMPOSITE_TYPE}, - * 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. + * by a name of the complex type and by a JavaScript Object which is mapped to/from the Ignite complex type. * * @extends CompositeType */ @@ -382,10 +556,10 @@ class ComplexObjectType extends CompositeType { * A type of any field may be specified later by setFieldType() method. * * 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. + * The name may be explicitely specified using optional typeName parameter in the constructor. * * @param {object} jsObject - instance of JavaScript Object which will be mapped to/from this complex type. - * @param {string | number} [typeNameOrId] - name of the complex type or the type Id. + * @param {string} [typeName] - name of the complex type. * * @return {ComplexObjectType} - new ComplexObjectType instance * @@ -393,6 +567,7 @@ class ComplexObjectType extends CompositeType { */ constructor(jsObject, typeName = null) { super(COMPOSITE_TYPE.COMPLEX_OBJECT); + ArgumentChecker.notEmpty(jsObject, 'jsObject'); this._template = jsObject; this._objectConstructor = jsObject && jsObject.constructor ? jsObject.constructor : Object; @@ -445,32 +620,6 @@ class ComplexObjectType extends CompositeType { } } -/** - * ??? Class representing an array of Ignite complex type objects. - * - * It is described by COMPOSITE_TYPE.OBJECT_ARRAY {@link ObjectType.COMPOSITE_TYPE} - * and by a concrete {@link CompositeType} instance which defines an element of the array. - * - * @extends CompositeType - */ -class ObjectArrayType extends CompositeType { - - /** - * Public constructor. - * - * @param {CompositeType} [elementType] - type of the array element - * - * @return {ObjectArrayType} - new ObjectArrayType instance - * - * @throws {IgniteClientError} if error. - */ - constructor(elementType = null) { - super(COMPOSITE_TYPE.OBJECT_ARRAY); - ArgumentChecker.hasType(elementType, 'elementType', false, CompositeType); - this._elementType = elementType; - } -} - module.exports.ObjectType = ObjectType; module.exports.CompositeType = CompositeType; module.exports.MapObjectType = MapObjectType; @@ -493,7 +642,7 @@ module.exports.ObjectArrayType = ObjectArrayType; <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/OperationError.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/OperationError.html b/modules/platforms/nodejs/api_spec/OperationError.html index 80c35d4..2e2e2db 100644 --- a/modules/platforms/nodejs/api_spec/OperationError.html +++ b/modules/platforms/nodejs/api_spec/OperationError.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/Query.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/Query.html b/modules/platforms/nodejs/api_spec/Query.html index f032878..e0ff718 100644 --- a/modules/platforms/nodejs/api_spec/Query.html +++ b/modules/platforms/nodejs/api_spec/Query.html @@ -472,7 +472,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/Query.js.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/Query.js.html b/modules/platforms/nodejs/api_spec/Query.js.html index 0d24a70..0b1f695 100644 --- a/modules/platforms/nodejs/api_spec/Query.js.html +++ b/modules/platforms/nodejs/api_spec/Query.js.html @@ -100,6 +100,7 @@ class Query { /** * Class representing an SQL query which returns the whole cache entries (key-value pairs). + * @extends Query */ class SqlQuery extends Query { @@ -277,7 +278,9 @@ class SqlQuery extends Query { * @ignore */ async _getCursor(socket, payload, keyType = null, valueType = null) { - return new Cursor(socket, BinaryUtils.OPERATION.QUERY_SQL_CURSOR_GET_PAGE, payload, keyType, valueType); + const cursor = new Cursor(socket, BinaryUtils.OPERATION.QUERY_SQL_CURSOR_GET_PAGE, payload, keyType, valueType); + cursor._readId(payload); + return cursor; } } @@ -299,6 +302,7 @@ const STATEMENT_TYPE = Object.freeze({ /** * Class representing an SQL Fields query. + * @extends SqlQuery */ class SqlFieldsQuery extends SqlQuery { @@ -466,6 +470,7 @@ class SqlFieldsQuery extends SqlQuery { * * This version of the class does not support a possibility to specify a Filter object for the query. * The query returns all entries from the entire cache or from the specified partition. + * @extends Query */ class ScanQuery extends Query { @@ -477,7 +482,7 @@ class ScanQuery extends Query { * Scan Query setting : Default value * Local query flag : false * Cursor page size : 1024 - * Number of partitions : -1 (entire cache) + * Partition number : -1 (entire cache) * Filter object : null (not supported) * </pre> * Every setting (except Filter object) may be changed using set methods. @@ -486,20 +491,20 @@ class ScanQuery extends Query { */ constructor() { super(BinaryUtils.OPERATION.QUERY_SCAN); - this._partitionsNumber = -1; + this._partitionNumber = -1; } /** - * Sets number of partitions over which this query should iterate. + * Sets a partition number over which this query should iterate. * * If negative, the query will iterate over all partitions in the cache. * - * @param {number} partitionsNumber - number of partitions over which this query should iterate. + * @param {number} partitionNumber - partition number over which this query should iterate. * * @return {ScanQuery} - the same instance of the ScanQuery. */ - setPartitionsNumber(partitionsNumber) { - this._partitionsNumber = partitionsNumber; + setPartitionNumber(partitionNumber) { + this._partitionNumber = partitionNumber; return this; } @@ -512,7 +517,7 @@ class ScanQuery extends Query { // filter await BinaryWriter.writeObject(buffer, null); buffer.writeInteger(this._pageSize); - buffer.writeInteger(this._partitionsNumber); + buffer.writeInteger(this._partitionNumber); buffer.writeBoolean(this._local); } @@ -520,7 +525,9 @@ class ScanQuery extends Query { * @ignore */ async _getCursor(socket, payload, keyType = null, valueType = null) { - return new Cursor(socket, BinaryUtils.OPERATION.QUERY_SCAN_CURSOR_GET_PAGE, payload, keyType, valueType); + const cursor = new Cursor(socket, BinaryUtils.OPERATION.QUERY_SCAN_CURSOR_GET_PAGE, payload, keyType, valueType); + cursor._readId(payload); + return cursor; } } @@ -543,7 +550,7 @@ module.exports.ScanQuery = ScanQuery; <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/QueryEntity.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/QueryEntity.html b/modules/platforms/nodejs/api_spec/QueryEntity.html index f90adf9..5e5aa77 100644 --- a/modules/platforms/nodejs/api_spec/QueryEntity.html +++ b/modules/platforms/nodejs/api_spec/QueryEntity.html @@ -2209,7 +2209,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/QueryField.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/QueryField.html b/modules/platforms/nodejs/api_spec/QueryField.html index 01f8979..70cf45a 100644 --- a/modules/platforms/nodejs/api_spec/QueryField.html +++ b/modules/platforms/nodejs/api_spec/QueryField.html @@ -261,7 +261,7 @@ - <h4 class="name" id="getDefaultValue"><span class="type-signature"></span>getDefaultValue<span class="signature">(valueType<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {*}</span></h4> + <h4 class="name" id="getDefaultValue"><span class="type-signature">(async) </span>getDefaultValue<span class="signature">(valueType<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {*}</span></h4> @@ -386,7 +386,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#line529">line 529</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line534">line 534</a> </li></ul></dd> @@ -486,7 +486,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#line478">line 478</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line480">line 480</a> </li></ul></dd> @@ -586,7 +586,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#line499">line 499</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line501">line 501</a> </li></ul></dd> @@ -686,7 +686,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#line436">line 436</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line438">line 438</a> </li></ul></dd> @@ -786,7 +786,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#line457">line 457</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line459">line 459</a> </li></ul></dd> @@ -998,7 +998,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#line514">line 514</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line516">line 516</a> </li></ul></dd> @@ -1153,7 +1153,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#line468">line 468</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line470">line 470</a> </li></ul></dd> @@ -1308,7 +1308,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#line489">line 489</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line491">line 491</a> </li></ul></dd> @@ -1463,7 +1463,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#line426">line 426</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line428">line 428</a> </li></ul></dd> @@ -1618,7 +1618,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#line447">line 447</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line449">line 449</a> </li></ul></dd> @@ -1692,7 +1692,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/QueryIndex.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/QueryIndex.html b/modules/platforms/nodejs/api_spec/QueryIndex.html index 91daafb..19e56dc 100644 --- a/modules/platforms/nodejs/api_spec/QueryIndex.html +++ b/modules/platforms/nodejs/api_spec/QueryIndex.html @@ -207,7 +207,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#line580">line 580</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line602">line 602</a> </li></ul></dd> @@ -378,7 +378,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#line558">line 558</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line580">line 580</a> </li></ul></dd> @@ -454,7 +454,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#line684">line 684</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line706">line 706</a> </li></ul></dd> @@ -554,7 +554,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#line663">line 663</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line685">line 685</a> </li></ul></dd> @@ -654,7 +654,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#line618">line 618</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line640">line 640</a> </li></ul></dd> @@ -754,7 +754,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#line642">line 642</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line664">line 664</a> </li></ul></dd> @@ -903,7 +903,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#line674">line 674</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line696">line 696</a> </li></ul></dd> @@ -1058,7 +1058,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#line653">line 653</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line675">line 675</a> </li></ul></dd> @@ -1213,7 +1213,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#line608">line 608</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line630">line 630</a> </li></ul></dd> @@ -1368,7 +1368,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#line631">line 631</a> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line653">line 653</a> </li></ul></dd> @@ -1471,7 +1471,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/ScanQuery.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/ScanQuery.html b/modules/platforms/nodejs/api_spec/ScanQuery.html index 182bf8e..864b8ba 100644 --- a/modules/platforms/nodejs/api_spec/ScanQuery.html +++ b/modules/platforms/nodejs/api_spec/ScanQuery.html @@ -61,7 +61,7 @@ The query returns all entries from the entire cache or from the specified partit Scan Query setting : Default value Local query flag : false Cursor page size : 1024 - Number of partitions : -1 (entire cache) + Partition number : -1 (entire cache) Filter object : null (not supported) </pre> Every setting (except Filter object) may be changed using set methods.</p> @@ -108,7 +108,7 @@ Every setting (except Filter object) may be changed using set methods.</p> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line442">line 442</a> + <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line447">line 447</a> </li></ul></dd> @@ -140,6 +140,17 @@ Every setting (except Filter object) may be changed using set methods.</p> </div> + <h3 class="subsection-title">Extends</h3> + + + + + <ul> + <li><a href="Query.html">Query</a></li> + </ul> + + + @@ -162,7 +173,335 @@ Every setting (except Filter object) may be changed using set methods.</p> - <h4 class="name" id="setPartitionsNumber"><span class="type-signature"></span>setPartitionsNumber<span class="signature">(partitionsNumber)</span><span class="type-signature"> → {<a href="ScanQuery.html">ScanQuery</a>}</span></h4> + <h4 class="name" id="setLocal"><span class="type-signature"></span>setLocal<span class="signature">(local)</span><span class="type-signature"> → {<a href="Query.html">Query</a>}</span></h4> + + + + + + +<div class="description"> + <p>Set local query flag.</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>local</code></td> + + + <td class="type"> + + +<span class="param-type">boolean</span> + + + + </td> + + + + + + <td class="description last"><p>local query flag: true or false.</p></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + <dt class="inherited-from">Inherited From:</dt> + <dd class="inherited-from"><ul class="dummy"><li> + <a href="Query.html#setLocal">Query#setLocal</a> + </li></ul></dd> + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line44">line 44</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the Query.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="Query.html">Query</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setPageSize"><span class="type-signature"></span>setPageSize<span class="signature">(pageSize)</span><span class="type-signature"> → {<a href="Query.html">Query</a>}</span></h4> + + + + + + +<div class="description"> + <p>Set <a href="Cursor.html">Cursor</a> page size.</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>pageSize</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + </td> + + + + + + <td class="description last"><p>cursor page size.</p></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + <dt class="inherited-from">Inherited From:</dt> + <dd class="inherited-from"><ul class="dummy"><li> + <a href="Query.html#setPageSize">Query#setPageSize</a> + </li></ul></dd> + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line56">line 56</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the Query.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="Query.html">Query</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setPartitionNumber"><span class="type-signature"></span>setPartitionNumber<span class="signature">(partitionNumber)</span><span class="type-signature"> → {<a href="ScanQuery.html">ScanQuery</a>}</span></h4> @@ -170,7 +509,7 @@ Every setting (except Filter object) may be changed using set methods.</p> <div class="description"> - <p>Sets number of partitions over which this query should iterate.</p> + <p>Sets a partition number over which this query should iterate.</p> <p>If negative, the query will iterate over all partitions in the cache.</p> </div> @@ -207,7 +546,7 @@ Every setting (except Filter object) may be changed using set methods.</p> <tr> - <td class="name"><code>partitionsNumber</code></td> + <td class="name"><code>partitionNumber</code></td> <td class="type"> @@ -223,7 +562,7 @@ Every setting (except Filter object) may be changed using set methods.</p> - <td class="description last"><p>number of partitions over which this query should iterate.</p></td> + <td class="description last"><p>partition number over which this query should iterate.</p></td> </tr> @@ -264,7 +603,7 @@ Every setting (except Filter object) may be changed using set methods.</p> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line473">line 473</a> + <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line478">line 478</a> </li></ul></dd> @@ -338,7 +677,7 @@ Every setting (except Filter object) may be changed using set methods.</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/SqlFieldsCursor.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/SqlFieldsCursor.html b/modules/platforms/nodejs/api_spec/SqlFieldsCursor.html index 36214e2..60617f1 100644 --- a/modules/platforms/nodejs/api_spec/SqlFieldsCursor.html +++ b/modules/platforms/nodejs/api_spec/SqlFieldsCursor.html @@ -86,7 +86,7 @@ One instance of this class returns results of one SQL Fields query operation.</p <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="Cursor.js.html">Cursor.js</a>, <a href="Cursor.js.html#line200">line 200</a> + <a href="Cursor.js.html">Cursor.js</a>, <a href="Cursor.js.html#line205">line 205</a> </li></ul></dd> @@ -118,6 +118,17 @@ One instance of this class returns results of one SQL Fields query operation.</p </div> + <h3 class="subsection-title">Extends</h3> + + + + + <ul> + <li><a href="Cursor.html">Cursor</a></li> + </ul> + + + @@ -140,6 +151,99 @@ One instance of this class returns results of one SQL Fields query operation.</p + <h4 class="name" id="close"><span class="type-signature">(async) </span>close<span class="signature">()</span><span class="type-signature"></span></h4> + + + + + + +<div class="description"> + <p>Closes the cursor. Obtaining elements from the results is not possible after this.</p> +<p>This method should be called if no more elements are needed. +It is not neccessary to call it if all elements have been already obtained.</p> +</div> + + + + + + + + + + + + + +<dl class="details"> + + + + + + + <dt class="inherited-from">Inherited From:</dt> + <dd class="inherited-from"><ul class="dummy"><li> + <a href="Cursor.html#close">Cursor#close</a> + </li></ul></dd> + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="Cursor.js.html">Cursor.js</a>, <a href="Cursor.js.html#line101">line 101</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + + + + + + + + + + <h4 class="name" id="getAll"><span class="type-signature">(async) </span>getAll<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<Array.<*>>>}</span></h4> @@ -174,6 +278,11 @@ is relatively small and will not cause memory utilization issues.</p> + <dt class="tag-overrides">Overrides:</dt> + <dd class="tag-overrides"><ul class="dummy"><li> + <a href="Cursor.html#getAll">Cursor#getAll</a> + </li></ul></dd> + @@ -194,7 +303,7 @@ is relatively small and will not cause memory utilization issues.</p> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="Cursor.js.html">Cursor.js</a>, <a href="Cursor.js.html#line229">line 229</a> + <a href="Cursor.js.html">Cursor.js</a>, <a href="Cursor.js.html#line234">line 234</a> </li></ul></dd> @@ -306,7 +415,7 @@ Every element of the array is an array with values of the fields requested by th <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="Cursor.js.html">Cursor.js</a>, <a href="Cursor.js.html#line241">line 241</a> + <a href="Cursor.js.html">Cursor.js</a>, <a href="Cursor.js.html#line246">line 246</a> </li></ul></dd> @@ -399,6 +508,11 @@ If the method returns null, no more elements are available.</p> + <dt class="tag-overrides">Overrides:</dt> + <dd class="tag-overrides"><ul class="dummy"><li> + <a href="Cursor.html#getValue">Cursor#getValue</a> + </li></ul></dd> + @@ -419,7 +533,7 @@ If the method returns null, no more elements are available.</p> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="Cursor.js.html">Cursor.js</a>, <a href="Cursor.js.html#line213">line 213</a> + <a href="Cursor.js.html">Cursor.js</a>, <a href="Cursor.js.html#line218">line 218</a> </li></ul></dd> @@ -477,6 +591,121 @@ If the method returns null, no more elements are available.</p> + <h4 class="name" id="hasMore"><span class="type-signature"></span>hasMore<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> + + + + + + +<div class="description"> + <p>Checks if more elements are available in the query results.</p> +</div> + + + + + + + + + + + + + +<dl class="details"> + + + + + + + <dt class="inherited-from">Inherited From:</dt> + <dd class="inherited-from"><ul class="dummy"><li> + <a href="Cursor.html#hasMore">Cursor#hasMore</a> + </li></ul></dd> + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="Cursor.js.html">Cursor.js</a>, <a href="Cursor.js.html#line65">line 65</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>true if more cache entries are available, false otherwise.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">boolean</span> + + + </dd> +</dl> + + + + + + + + + + + + + <h4 class="name" id="setFieldTypes"><span class="type-signature"></span>setFieldTypes<span class="signature">(…fieldTypes)</span><span class="type-signature"> → {<a href="SqlFieldsCursor.html">SqlFieldsCursor</a>}</span></h4> @@ -603,7 +832,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="Cursor.js.html">Cursor.js</a>, <a href="Cursor.js.html#line261">line 261</a> + <a href="Cursor.js.html">Cursor.js</a>, <a href="Cursor.js.html#line266">line 266</a> </li></ul></dd> @@ -677,7 +906,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>
