http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/api_spec/SqlFieldsQuery.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/SqlFieldsQuery.html b/modules/platforms/nodejs/api_spec/SqlFieldsQuery.html index a8299d2..3efdd1a 100644 --- a/modules/platforms/nodejs/api_spec/SqlFieldsQuery.html +++ b/modules/platforms/nodejs/api_spec/SqlFieldsQuery.html @@ -165,7 +165,7 @@ Every setting 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#line275">line 275</a> + <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line279">line 279</a> </li></ul></dd> @@ -197,6 +197,17 @@ Every setting may be changed using set methods.</p> </div> + <h3 class="subsection-title">Extends</h3> + + + + + <ul> + <li><a href="SqlQuery.html">SqlQuery</a></li> + </ul> + + + @@ -340,7 +351,7 @@ Every setting 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#line256">line 256</a> + <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line259">line 259</a> </li></ul></dd> @@ -368,7 +379,7 @@ Every setting may be changed using set methods.</p> - <h4 class="name" id="setCollocated"><span class="type-signature"></span>setCollocated<span class="signature">(collocated)</span><span class="type-signature"> → {<a href="SqlFieldsQuery.html">SqlFieldsQuery</a>}</span></h4> + <h4 class="name" id="setArgs"><span class="type-signature"></span>setArgs<span class="signature">(…args)</span><span class="type-signature"> → {<a href="SqlQuery.html">SqlQuery</a>}</span></h4> @@ -376,7 +387,11 @@ Every setting may be changed using set methods.</p> <div class="description"> - <p>Set collocated flag.</p> + <p>Set query arguments.</p> +<p>Type of any argument may be specified using setArgTypes() method. +If type of an argument 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> @@ -400,6 +415,8 @@ Every setting may be changed using set methods.</p> <th>Type</th> + <th>Attributes</th> + @@ -412,23 +429,33 @@ Every setting may be changed using set methods.</p> <tr> - <td class="name"><code>collocated</code></td> + <td class="name"><code>args</code></td> <td class="type"> -<span class="param-type">boolean</span> +<span class="param-type">*</span> </td> + <td class="attributes"> + + + + + + <repeatable><br> + + </td> + - <td class="description last"><p>collocated flag: true or false.</p></td> + <td class="description last"><p>Query arguments.</p></td> </tr> @@ -447,6 +474,11 @@ Every setting may be changed using set methods.</p> + <dt class="inherited-from">Inherited From:</dt> + <dd class="inherited-from"><ul class="dummy"><li> + <a href="SqlQuery.html#setArgs">SqlQuery#setArgs</a> + </li></ul></dd> + @@ -469,7 +501,7 @@ Every setting 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#line375">line 375</a> + <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line154">line 154</a> </li></ul></dd> @@ -497,7 +529,7 @@ Every setting may be changed using set methods.</p> <div class="param-desc"> <ul> -<li>the same instance of the SqlFieldsQuery.</li> +<li>the same instance of the SqlQuery.</li> </ul> </div> @@ -509,7 +541,7 @@ Every setting may be changed using set methods.</p> </dt> <dd> -<span class="param-type"><a href="SqlFieldsQuery.html">SqlFieldsQuery</a></span> +<span class="param-type"><a href="SqlQuery.html">SqlQuery</a></span> </dd> @@ -527,7 +559,7 @@ Every setting may be changed using set methods.</p> - <h4 class="name" id="setEnforceJoinOrder"><span class="type-signature"></span>setEnforceJoinOrder<span class="signature">(enforceJoinOrder)</span><span class="type-signature"> → {<a href="SqlFieldsQuery.html">SqlFieldsQuery</a>}</span></h4> + <h4 class="name" id="setArgTypes"><span class="type-signature"></span>setArgTypes<span class="signature">(…argTypes)</span><span class="type-signature"> → {<a href="SqlQuery.html">SqlQuery</a>}</span></h4> @@ -535,7 +567,11 @@ Every setting may be changed using set methods.</p> <div class="description"> - <p>Set enforce join order flag.</p> + <p>Specifies types of query arguments.</p> +<p>Query arguments itself are set using setArgs() method. +By default, a type of every argument is not specified that means 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> @@ -559,6 +595,8 @@ Every setting may be changed using set methods.</p> <th>Type</th> + <th>Attributes</th> + @@ -571,7 +609,191 @@ Every setting may be changed using set methods.</p> <tr> - <td class="name"><code>enforceJoinOrder</code></td> + <td class="name"><code>argTypes</code></td> + + + <td class="type"> + + +<span class="param-type"><a href="ObjectType.html#.PRIMITIVE_TYPE">ObjectType.PRIMITIVE_TYPE</a></span> +| + +<span class="param-type"><a href="CompositeType.html">CompositeType</a></span> + + + + </td> + + + <td class="attributes"> + + + + + + <repeatable><br> + + </td> + + + + + <td class="description last"><p>types of Query arguments. + The order of types must follow the order of arguments in the setArgs() method. + A type of every argument can be:</p> +<ul> +<li>either a type code of primitive (simple) type</li> +<li>or an instance of class representing non-primitive (composite) type</li> +<li>or null (means the type is not specified)</li> +</ul></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + <dt class="inherited-from">Inherited From:</dt> + <dd class="inherited-from"><ul class="dummy"><li> + <a href="SqlQuery.html#setArgTypes">SqlQuery#setArgTypes</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#line176">line 176</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the SqlQuery.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="SqlQuery.html">SqlQuery</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setCollocated"><span class="type-signature"></span>setCollocated<span class="signature">(collocated)</span><span class="type-signature"> → {<a href="SqlFieldsQuery.html">SqlFieldsQuery</a>}</span></h4> + + + + + + +<div class="description"> + <p>Set collocated 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>collocated</code></td> <td class="type"> @@ -587,7 +809,7 @@ Every setting may be changed using set methods.</p> - <td class="description last"><p>enforce join order flag: true or false.</p></td> + <td class="description last"><p>collocated flag: true or false.</p></td> </tr> @@ -628,7 +850,7 @@ Every setting 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#line363">line 363</a> + <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line379">line 379</a> </li></ul></dd> @@ -686,7 +908,7 @@ Every setting may be changed using set methods.</p> - <h4 class="name" id="setIncludeFieldNames"><span class="type-signature"></span>setIncludeFieldNames<span class="signature">(includeFieldNames)</span><span class="type-signature"> → {<a href="SqlFieldsQuery.html">SqlFieldsQuery</a>}</span></h4> + <h4 class="name" id="setDistributedJoins"><span class="type-signature"></span>setDistributedJoins<span class="signature">(distributedJoins)</span><span class="type-signature"> → {<a href="SqlQuery.html">SqlQuery</a>}</span></h4> @@ -694,7 +916,7 @@ Every setting may be changed using set methods.</p> <div class="description"> - <p>Set include field names flag.</p> + <p>Set distributed joins flag.</p> </div> @@ -730,7 +952,7 @@ Every setting may be changed using set methods.</p> <tr> - <td class="name"><code>includeFieldNames</code></td> + <td class="name"><code>distributedJoins</code></td> <td class="type"> @@ -746,7 +968,7 @@ Every setting may be changed using set methods.</p> - <td class="description last"><p>include field names flag: true or false.</p></td> + <td class="description last"><p>distributed joins flag: true or false.</p></td> </tr> @@ -765,6 +987,11 @@ Every setting may be changed using set methods.</p> + <dt class="inherited-from">Inherited From:</dt> + <dd class="inherited-from"><ul class="dummy"><li> + <a href="SqlQuery.html#setDistributedJoins">SqlQuery#setDistributedJoins</a> + </li></ul></dd> + @@ -787,7 +1014,7 @@ Every setting 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#line399">line 399</a> + <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line188">line 188</a> </li></ul></dd> @@ -815,7 +1042,7 @@ Every setting may be changed using set methods.</p> <div class="param-desc"> <ul> -<li>the same instance of the SqlFieldsQuery.</li> +<li>the same instance of the SqlQuery.</li> </ul> </div> @@ -827,7 +1054,7 @@ Every setting may be changed using set methods.</p> </dt> <dd> -<span class="param-type"><a href="SqlFieldsQuery.html">SqlFieldsQuery</a></span> +<span class="param-type"><a href="SqlQuery.html">SqlQuery</a></span> </dd> @@ -845,7 +1072,7 @@ Every setting may be changed using set methods.</p> - <h4 class="name" id="setLazy"><span class="type-signature"></span>setLazy<span class="signature">(lazy)</span><span class="type-signature"> → {<a href="SqlFieldsQuery.html">SqlFieldsQuery</a>}</span></h4> + <h4 class="name" id="setEnforceJoinOrder"><span class="type-signature"></span>setEnforceJoinOrder<span class="signature">(enforceJoinOrder)</span><span class="type-signature"> → {<a href="SqlFieldsQuery.html">SqlFieldsQuery</a>}</span></h4> @@ -853,7 +1080,7 @@ Every setting may be changed using set methods.</p> <div class="description"> - <p>Set lazy query execution flag.</p> + <p>Set enforce join order flag.</p> </div> @@ -889,7 +1116,7 @@ Every setting may be changed using set methods.</p> <tr> - <td class="name"><code>lazy</code></td> + <td class="name"><code>enforceJoinOrder</code></td> <td class="type"> @@ -905,7 +1132,7 @@ Every setting may be changed using set methods.</p> - <td class="description last"><p>lazy query execution flag: true or false.</p></td> + <td class="description last"><p>enforce join order flag: true or false.</p></td> </tr> @@ -946,7 +1173,7 @@ Every setting 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#line387">line 387</a> + <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line367">line 367</a> </li></ul></dd> @@ -1004,7 +1231,7 @@ Every setting may be changed using set methods.</p> - <h4 class="name" id="setMaxRows"><span class="type-signature"></span>setMaxRows<span class="signature">(maxRows)</span><span class="type-signature"> → {<a href="SqlFieldsQuery.html">SqlFieldsQuery</a>}</span></h4> + <h4 class="name" id="setIncludeFieldNames"><span class="type-signature"></span>setIncludeFieldNames<span class="signature">(includeFieldNames)</span><span class="type-signature"> → {<a href="SqlFieldsQuery.html">SqlFieldsQuery</a>}</span></h4> @@ -1012,7 +1239,7 @@ Every setting may be changed using set methods.</p> <div class="description"> - <p>Set max rows.</p> + <p>Set include field names flag.</p> </div> @@ -1048,13 +1275,13 @@ Every setting may be changed using set methods.</p> <tr> - <td class="name"><code>maxRows</code></td> + <td class="name"><code>includeFieldNames</code></td> <td class="type"> -<span class="param-type">number</span> +<span class="param-type">boolean</span> @@ -1064,7 +1291,7 @@ Every setting may be changed using set methods.</p> - <td class="description last"><p>max rows.</p></td> + <td class="description last"><p>include field names flag: true or false.</p></td> </tr> @@ -1105,7 +1332,7 @@ Every setting 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#line339">line 339</a> + <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line403">line 403</a> </li></ul></dd> @@ -1163,7 +1390,7 @@ Every setting may be changed using set methods.</p> - <h4 class="name" id="setSchema"><span class="type-signature"></span>setSchema<span class="signature">(schema)</span><span class="type-signature"> → {<a href="SqlFieldsQuery.html">SqlFieldsQuery</a>}</span></h4> + <h4 class="name" id="setLazy"><span class="type-signature"></span>setLazy<span class="signature">(lazy)</span><span class="type-signature"> → {<a href="SqlFieldsQuery.html">SqlFieldsQuery</a>}</span></h4> @@ -1171,7 +1398,7 @@ Every setting may be changed using set methods.</p> <div class="description"> - <p>Set schema for the query.</p> + <p>Set lazy query execution flag.</p> </div> @@ -1207,13 +1434,13 @@ Every setting may be changed using set methods.</p> <tr> - <td class="name"><code>schema</code></td> + <td class="name"><code>lazy</code></td> <td class="type"> -<span class="param-type">string</span> +<span class="param-type">boolean</span> @@ -1223,7 +1450,7 @@ Every setting may be changed using set methods.</p> - <td class="description last"><p>schema for the query.</p></td> + <td class="description last"><p>lazy query execution flag: true or false.</p></td> </tr> @@ -1264,7 +1491,7 @@ Every setting 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#line327">line 327</a> + <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line391">line 391</a> </li></ul></dd> @@ -1322,7 +1549,7 @@ Every setting may be changed using set methods.</p> - <h4 class="name" id="setStatementType"><span class="type-signature"></span>setStatementType<span class="signature">(type)</span><span class="type-signature"> → {<a href="SqlFieldsQuery.html">SqlFieldsQuery</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> @@ -1330,7 +1557,7 @@ Every setting may be changed using set methods.</p> <div class="description"> - <p>Set statement type.</p> + <p>Set local query flag.</p> </div> @@ -1366,13 +1593,13 @@ Every setting may be changed using set methods.</p> <tr> - <td class="name"><code>type</code></td> + <td class="name"><code>local</code></td> <td class="type"> -<span class="param-type"><a href="SqlFieldsQuery.html#.STATEMENT_TYPE">SqlFieldsQuery.STATEMENT_TYPE</a></span> +<span class="param-type">boolean</span> @@ -1382,7 +1609,7 @@ Every setting may be changed using set methods.</p> - <td class="description last"><p>statement type.</p></td> + <td class="description last"><p>local query flag: true or false.</p></td> </tr> @@ -1401,6 +1628,11 @@ Every setting may be changed using set methods.</p> + <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> + @@ -1423,7 +1655,7 @@ Every setting 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#line351">line 351</a> + <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line44">line 44</a> </li></ul></dd> @@ -1451,7 +1683,7 @@ Every setting may be changed using set methods.</p> <div class="param-desc"> <ul> -<li>the same instance of the SqlFieldsQuery.</li> +<li>the same instance of the Query.</li> </ul> </div> @@ -1463,7 +1695,1305 @@ Every setting may be changed using set methods.</p> </dt> <dd> -<span class="param-type"><a href="SqlFieldsQuery.html">SqlFieldsQuery</a></span> +<span class="param-type"><a href="Query.html">Query</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setMaxRows"><span class="type-signature"></span>setMaxRows<span class="signature">(maxRows)</span><span class="type-signature"> → {<a href="SqlFieldsQuery.html">SqlFieldsQuery</a>}</span></h4> + + + + + + +<div class="description"> + <p>Set max rows.</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>maxRows</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + </td> + + + + + + <td class="description last"><p>max rows.</p></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <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#line343">line 343</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the SqlFieldsQuery.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="SqlFieldsQuery.html">SqlFieldsQuery</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="setReplicatedOnly"><span class="type-signature"></span>setReplicatedOnly<span class="signature">(replicatedOnly)</span><span class="type-signature"> → {<a href="SqlQuery.html">SqlQuery</a>}</span></h4> + + + + + + +<div class="description"> + <p>Set replicated only 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>replicatedOnly</code></td> + + + <td class="type"> + + +<span class="param-type">boolean</span> + + + + </td> + + + + + + <td class="description last"><p>replicated only 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="SqlQuery.html#setReplicatedOnly">SqlQuery#setReplicatedOnly</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#line200">line 200</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the SqlQuery.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="SqlQuery.html">SqlQuery</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setSchema"><span class="type-signature"></span>setSchema<span class="signature">(schema)</span><span class="type-signature"> → {<a href="SqlFieldsQuery.html">SqlFieldsQuery</a>}</span></h4> + + + + + + +<div class="description"> + <p>Set schema for the query.</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>schema</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + + + + <td class="description last"><p>schema for the query.</p></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <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#line331">line 331</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the SqlFieldsQuery.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="SqlFieldsQuery.html">SqlFieldsQuery</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setSql"><span class="type-signature"></span>setSql<span class="signature">(sql)</span><span class="type-signature"> → {<a href="SqlQuery.html">SqlQuery</a>}</span></h4> + + + + + + +<div class="description"> + <p>Set SQL query string.</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>sql</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + + + + <td class="description last"><p>SQL query string.</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="SqlQuery.html#setSql">SqlQuery#setSql</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#line136">line 136</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the SqlQuery.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="SqlQuery.html">SqlQuery</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setStatementType"><span class="type-signature"></span>setStatementType<span class="signature">(type)</span><span class="type-signature"> → {<a href="SqlFieldsQuery.html">SqlFieldsQuery</a>}</span></h4> + + + + + + +<div class="description"> + <p>Set statement type.</p> +</div> + + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>type</code></td> + + + <td class="type"> + + +<span class="param-type"><a href="SqlFieldsQuery.html#.STATEMENT_TYPE">SqlFieldsQuery.STATEMENT_TYPE</a></span> + + + + </td> + + + + + + <td class="description last"><p>statement type.</p></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line355">line 355</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the SqlFieldsQuery.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="SqlFieldsQuery.html">SqlFieldsQuery</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setTimeout"><span class="type-signature"></span>setTimeout<span class="signature">(timeout)</span><span class="type-signature"> → {<a href="SqlQuery.html">SqlQuery</a>}</span></h4> + + + + + + +<div class="description"> + <p>Set timeout.</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>timeout</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + </td> + + + + + + <td class="description last"><p>timeout value in milliseconds. + Must be non-negative. Zero value disables timeout.</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="SqlQuery.html#setTimeout">SqlQuery#setTimeout</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#line213">line 213</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the SqlQuery.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="SqlQuery.html">SqlQuery</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setType"><span class="type-signature"></span>setType<span class="signature">(type)</span><span class="type-signature"> → {<a href="SqlQuery.html">SqlQuery</a>}</span></h4> + + + + + + +<div class="description"> + <p>Set name of a type or SQL table.</p> +</div> + + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>type</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + + + + <td class="description last"><p>name of a type or SQL table.</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="SqlQuery.html#setType">SqlQuery#setType</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#line118">line 118</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the SqlQuery.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="SqlQuery.html">SqlQuery</a></span> </dd> @@ -1497,7 +3027,7 @@ Every setting 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/SqlQuery.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/SqlQuery.html b/modules/platforms/nodejs/api_spec/SqlQuery.html index c9d32c5..119fda5 100644 --- a/modules/platforms/nodejs/api_spec/SqlQuery.html +++ b/modules/platforms/nodejs/api_spec/SqlQuery.html @@ -181,7 +181,7 @@ Every setting 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#line76">line 76</a> + <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line77">line 77</a> </li></ul></dd> @@ -213,6 +213,17 @@ Every setting may be changed using set methods.</p> </div> + <h3 class="subsection-title">Extends</h3> + + + + + <ul> + <li><a href="Query.html">Query</a></li> + </ul> + + + @@ -352,7 +363,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="Query.js.html">Query.js</a>, <a href="Query.js.html#line153">line 153</a> + <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line154">line 154</a> </li></ul></dd> @@ -537,7 +548,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="Query.js.html">Query.js</a>, <a href="Query.js.html#line175">line 175</a> + <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line176">line 176</a> </li></ul></dd> @@ -696,7 +707,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="Query.js.html">Query.js</a>, <a href="Query.js.html#line187">line 187</a> + <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line188">line 188</a> </li></ul></dd> @@ -754,6 +765,334 @@ according to the mapping table defined in the description of the <a href="Object + <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="setReplicatedOnly"><span class="type-signature"></span>setReplicatedOnly<span class="signature">(replicatedOnly)</span><span class="type-signature"> → {<a href="SqlQuery.html">SqlQuery</a>}</span></h4> @@ -855,7 +1194,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="Query.js.html">Query.js</a>, <a href="Query.js.html#line199">line 199</a> + <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line200">line 200</a> </li></ul></dd> @@ -1014,7 +1353,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="Query.js.html">Query.js</a>, <a href="Query.js.html#line135">line 135</a> + <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line136">line 136</a> </li></ul></dd> @@ -1174,7 +1513,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="Query.js.html">Query.js</a>, <a href="Query.js.html#line212">line 212</a> + <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line213">line 213</a> </li></ul></dd> @@ -1333,7 +1672,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="Query.js.html">Query.js</a>, <a href="Query.js.html#line117">line 117</a> + <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line118">line 118</a> </li></ul></dd> @@ -1407,7 +1746,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/Timestamp.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/Timestamp.html b/modules/platforms/nodejs/api_spec/Timestamp.html index 5507c19..a0b902f 100644 --- a/modules/platforms/nodejs/api_spec/Timestamp.html +++ b/modules/platforms/nodejs/api_spec/Timestamp.html @@ -30,11 +30,13 @@ <h2><span class="attribs"><span class="type-signature"></span></span>Timestamp<span class="signature">(time, nanos)</span><span class="type-signature"></span></h2> - <div class="class-description"><p>Class representing a timestamp.</p> -<p>The timestamp consists of:</p> + <div class="class-description"><p>Class representing an Ignite timestamp type.</p> +<p>The timestamp extends the standard JavaScript Date Object and consists of:</p> <ul> -<li>date - a standard JavaScript Date.</li> -<li>nanoseconds - fraction of the last second, which value could be in the range from 0 to 999999999.</li> +<li>time - the number of milliseconds since January 1, 1970, 00:00:00 UTC, +methods of the JavaScript Date Object can be used to operate with the time.</li> +<li>nanoseconds - fraction of the last millisecond in the range from 0 to 999999 nanoseconds, +this class specifies additional methods to operate with the nanoseconds.</li> </ul></div> @@ -133,7 +135,8 @@ - <td class="description last"><p>nanoseconds of the last second.</p></td> + <td class="description last"><p>integer value representing the nanoseconds of the last millisecond, + should be in the range from 0 to 999999.</p></td> </tr> @@ -174,7 +177,7 @@ <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="Timestamp.js.html">Timestamp.js</a>, <a href="Timestamp.js.html#line29">line 29</a> + <a href="Timestamp.js.html">Timestamp.js</a>, <a href="Timestamp.js.html#line32">line 32</a> </li></ul></dd> @@ -206,6 +209,17 @@ </div> + <h3 class="subsection-title">Extends</h3> + + + + + <ul> + <li>Date</li> + </ul> + + + @@ -236,7 +250,7 @@ <div class="description"> - <p>Returns the nanoseconds of the last second from the timestamp.</p> + <p>Returns the nanoseconds of the last millisecond from the timestamp.</p> </div> @@ -280,7 +294,7 @@ <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="Timestamp.js.html">Timestamp.js</a>, <a href="Timestamp.js.html#line51">line 51</a> + <a href="Timestamp.js.html">Timestamp.js</a>, <a href="Timestamp.js.html#line55">line 55</a> </li></ul></dd> @@ -308,7 +322,7 @@ <div class="param-desc"> <ul> -<li>nanoseconds of the last second.</li> +<li>nanoseconds of the last millisecond.</li> </ul> </div> @@ -346,7 +360,7 @@ <div class="description"> - <p>Updates the nanoseconds of the last second in the timestamp without changing the date.</p> + <p>Updates the nanoseconds of the last millisecond in the timestamp.</p> </div> @@ -398,7 +412,8 @@ - <td class="description last"><p>new value for the nanoseconds of the last second.</p></td> + <td class="description last"><p>new value for the nanoseconds of the last millisecond, + should be in the range from 0 to 999999.</p></td> </tr> @@ -439,7 +454,7 @@ <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> - <a href="Timestamp.js.html">Timestamp.js</a>, <a href="Timestamp.js.html#line64">line 64</a> + <a href="Timestamp.js.html">Timestamp.js</a>, <a href="Timestamp.js.html#line69">line 69</a> </li></ul></dd> @@ -542,7 +557,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/Timestamp.js.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/Timestamp.js.html b/modules/platforms/nodejs/api_spec/Timestamp.js.html index 17fafe5..69f7b2c 100644 --- a/modules/platforms/nodejs/api_spec/Timestamp.js.html +++ b/modules/platforms/nodejs/api_spec/Timestamp.js.html @@ -48,11 +48,14 @@ const ArgumentChecker = require('./internal/ArgumentChecker'); /** - * Class representing a timestamp. + * Class representing an Ignite timestamp type. * - * The timestamp consists of: - * - date - a standard JavaScript {@link Date}. - * - nanoseconds - fraction of the last second, which value could be in the range from 0 to 999999999. + * The timestamp extends the standard JavaScript {@link Date} Object and consists of: + * - time - the number of milliseconds since January 1, 1970, 00:00:00 UTC, + * methods of the JavaScript {@link Date} Object can be used to operate with the time. + * - nanoseconds - fraction of the last millisecond in the range from 0 to 999999 nanoseconds, + * this class specifies additional methods to operate with the nanoseconds. + * @extends Date */ class Timestamp extends Date { @@ -60,7 +63,8 @@ class Timestamp extends Date { * Public constructor. * * @param {number} time - integer value representing the number of milliseconds since January 1, 1970, 00:00:00 UTC. - * @param {number} nanos - nanoseconds of the last second. + * @param {number} nanos - integer value representing the nanoseconds of the last millisecond, + * should be in the range from 0 to 999999. * * @return {Timestamp} - new Timestamp instance * @@ -72,18 +76,19 @@ class Timestamp extends Date { } /** - * Returns the nanoseconds of the last second from the timestamp. + * Returns the nanoseconds of the last millisecond from the timestamp. * - * @return {number} - nanoseconds of the last second. + * @return {number} - nanoseconds of the last millisecond. */ getNanos() { return this._nanos; } /** - * Updates the nanoseconds of the last second in the timestamp without changing the date. + * Updates the nanoseconds of the last millisecond in the timestamp. * - * @param {number} nanos - new value for the nanoseconds of the last second. + * @param {number} nanos - new value for the nanoseconds of the last millisecond, + * should be in the range from 0 to 999999. * * @return {Timestamp} - the same instance of Timestamp * @@ -113,7 +118,7 @@ module.exports = Timestamp; <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/index.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/index.html b/modules/platforms/nodejs/api_spec/index.html index 8485b4a..cf13380 100644 --- a/modules/platforms/nodejs/api_spec/index.html +++ b/modules/platforms/nodejs/api_spec/index.html @@ -56,7 +56,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/lib/Cursor.js ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/lib/Cursor.js b/modules/platforms/nodejs/lib/Cursor.js index b97a82f..85176e3 100644 --- a/modules/platforms/nodejs/lib/Cursor.js +++ b/modules/platforms/nodejs/lib/Cursor.js @@ -200,6 +200,7 @@ class Cursor { * One instance of this class returns results of one SQL Fields query operation. * * @hideconstructor + * @extends Cursor */ class SqlFieldsCursor extends Cursor { http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/lib/IgniteClientConfiguration.js ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/lib/IgniteClientConfiguration.js b/modules/platforms/nodejs/lib/IgniteClientConfiguration.js index 0e53cca..f096a0a 100644 --- a/modules/platforms/nodejs/lib/IgniteClientConfiguration.js +++ b/modules/platforms/nodejs/lib/IgniteClientConfiguration.js @@ -97,8 +97,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. */ http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/lib/ObjectType.js ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/lib/ObjectType.js b/modules/platforms/nodejs/lib/ObjectType.js index 121ce2e..f1facfd 100644 --- a/modules/platforms/nodejs/lib/ObjectType.js +++ b/modules/platforms/nodejs/lib/ObjectType.js @@ -130,7 +130,8 @@ const COMPOSITE_TYPE = Object.freeze({ * In this case the Ignite client tries to make automatic mapping between JavaScript types * 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 @@ -166,7 +167,8 @@ const COMPOSITE_TYPE = Object.freeze({ * * 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 @@ -219,7 +221,8 @@ const COMPOSITE_TYPE = Object.freeze({ * | NULL | null | * </pre> * - * ============================================================================ + * ---------------------------------------------------------------------------- + * * RETURNED JavaScript types WHEN READING DATA OF THE SPECIFIED Ignite type code. * * When an application explicitly specifies an Ignite type for a field @@ -240,7 +243,8 @@ const COMPOSITE_TYPE = Object.freeze({ * - 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 @@ -264,21 +268,22 @@ const COMPOSITE_TYPE = Object.freeze({ * * - 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 - * (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures) + * ({@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 - * (https://github.com/MikeMcl/decimal.js) + * ({@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 */ @@ -499,8 +504,7 @@ class ObjectArrayType 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 */ @@ -524,10 +528,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 * http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/lib/Query.js ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/lib/Query.js b/modules/platforms/nodejs/lib/Query.js index 3458899..5c230df 100644 --- a/modules/platforms/nodejs/lib/Query.js +++ b/modules/platforms/nodejs/lib/Query.js @@ -72,6 +72,7 @@ class Query { /** * Class representing an SQL query which returns the whole cache entries (key-value pairs). + * @extends Query */ class SqlQuery extends Query { @@ -273,6 +274,7 @@ const STATEMENT_TYPE = Object.freeze({ /** * Class representing an SQL Fields query. + * @extends SqlQuery */ class SqlFieldsQuery extends SqlQuery { @@ -440,6 +442,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 { http://git-wip-us.apache.org/repos/asf/ignite/blob/84aa3495/modules/platforms/nodejs/lib/Timestamp.js ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/lib/Timestamp.js b/modules/platforms/nodejs/lib/Timestamp.js index 0694850..04d750c 100644 --- a/modules/platforms/nodejs/lib/Timestamp.js +++ b/modules/platforms/nodejs/lib/Timestamp.js @@ -24,9 +24,10 @@ const ArgumentChecker = require('./internal/ArgumentChecker'); * * The timestamp extends the standard JavaScript {@link Date} Object and consists of: * - time - the number of milliseconds since January 1, 1970, 00:00:00 UTC, - * methods of the JavaScript {@link Date} Object can be used to operate with the time. + * methods of the JavaScript {@link Date} Object can be used to operate with the time. * - nanoseconds - fraction of the last millisecond in the range from 0 to 999999 nanoseconds, - * this class specifies additional methods to operate with the nanoseconds. + * this class specifies additional methods to operate with the nanoseconds. + * @extends Date */ class Timestamp extends Date {
