api_spec/SqlFieldsCursor.html - ignite-nodejs-thin-client - Git at Google

 <!DOCTYPE html>
 <html lang="en">
 <head>
     <meta charset="utf-8">
     <title>JSDoc: Class: SqlFieldsCursor</title>

     <script src="scripts/prettify/prettify.js"> </script>
     <script src="scripts/prettify/lang-css.js"> </script>
     <!--[if lt IE 9]>
       <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
     <![endif]-->
     <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
     <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
 </head>

 <body>

 <div id="main">

     <h1 class="page-title">Class: SqlFieldsCursor</h1>


 <section>

 <header>

         <h2><span class="attribs"><span class="type-signature"></span></span>SqlFieldsCursor</h2>

             <div class="class-description"><p>Class representing a cursor to obtain results of SQL Fields query operation.</p>
 <p>The class has no public constructor. An instance of this class is obtained
 via query() method of <a href="CacheClient.html">CacheClient</a> objects.
 One instance of this class returns results of one SQL Fields query operation.</p></div>


 </header>

 <article>
     <div class="container-overview">


 <dl class="details">


     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
         <a href="Cursor.js.html">Cursor.js</a>, <a href="Cursor.js.html#line205">line 205</a>
     </li></ul></dd>


 </dl>


     </div>


         <h3 class="subsection-title">Extends</h3>


     <ul>
         <li><a href="Cursor.html">Cursor</a></li>
     </ul>


         <h3 class="subsection-title">Methods</h3>


     <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"> &rarr; {Promise.&lt;Array.&lt;Array.&lt;*>>>}</span></h4>


 <div class="description">
     <p>Returns all elements (arrays with values of the fields) from the query results.</p>
 <p>May be used instead of getValue() method if the number of returned elements
 is relatively small and will not cause memory utilization issues.</p>
 </div>


 <dl class="details">


     <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>


     <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#line234">line 234</a>
     </li></ul></dd>


 </dl>


 <h5>Returns:</h5>


 <div class="param-desc">
     <ul>
 <li>all results returned by SQL Fields query.
 Every element of the array is an array with values of the fields requested by the query.</li>
 </ul>
 </div>


 <dl>
     <dt>
         Type
     </dt>
     <dd>

 <span class="param-type">Promise.&lt;Array.&lt;Array.&lt;*>>></span>


     </dd>
 </dl>


     <h4 class="name" id="getFieldNames"><span class="type-signature"></span>getFieldNames<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;string>}</span></h4>


 <div class="description">
     <p>Returns names of the fields which were requested in the SQL Fields query.</p>
 <p>Empty array is returned if &quot;include field names&quot; flag was false in the query.</p>
 </div>


 <dl class="details">


     <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#line246">line 246</a>
     </li></ul></dd>


 </dl>


 <h5>Returns:</h5>


 <div class="param-desc">
     <ul>
 <li>field names.
 The order of names corresponds to the order of field values returned in the results of the query.</li>
 </ul>
 </div>


 <dl>
     <dt>
         Type
     </dt>
     <dd>

 <span class="param-type">Array.&lt;string></span>


     </dd>
 </dl>


     <h4 class="name" id="getValue"><span class="type-signature">(async) </span>getValue<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;*>>}</span></h4>


 <div class="description">
     <p>Returns one element (array with values of the fields) from the query results.</p>
 <p>Every new call returns the next element from the query results.
 If the method returns null, no more elements are available.</p>
 </div>


 <dl class="details">


     <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>


     <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#line218">line 218</a>
     </li></ul></dd>


 </dl>


 <h5>Returns:</h5>


 <div class="param-desc">
     <ul>
 <li>array with values of the fields requested by the query.</li>
 </ul>
 </div>


 <dl>
     <dt>
         Type
     </dt>
     <dd>

 <span class="param-type">Promise.&lt;Array.&lt;*>></span>


     </dd>
 </dl>


     <h4 class="name" id="hasMore"><span class="type-signature"></span>hasMore<span class="signature">()</span><span class="type-signature"> &rarr; {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">(&hellip;fieldTypes)</span><span class="type-signature"> &rarr; {<a href="SqlFieldsCursor.html">SqlFieldsCursor</a>}</span></h4>


 <div class="description">
     <p>Specifies types of the fields returned by the SQL Fields query.</p>
 <p>By default, a type of every field 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>


     <h5>Parameters:</h5>


 <table class="params">
     <thead>
     <tr>

         <th>Name</th>


         <th>Type</th>


         <th>Attributes</th>


         <th class="last">Description</th>
     </tr>
     </thead>

     <tbody>


         <tr>

                 <td class="name"><code>fieldTypes</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">


                     &lt;repeatable><br>

                 </td>


             <td class="description last"><p>types of the returned fields.
   The order of types must correspond the order of field values returned in the results of the query.
   A type of every field 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="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#line266">line 266</a>
     </li></ul></dd>


 </dl>


 <h5>Returns:</h5>


 <div class="param-desc">
     <ul>
 <li>the same instance of the SqlFieldsCursor.</li>
 </ul>
 </div>


 <dl>
     <dt>
         Type
     </dt>
     <dd>

 <span class="param-type"><a href="SqlFieldsCursor.html">SqlFieldsCursor</a></span>


     </dd>
 </dl>


 </article>

 </section>


 </div>

 <nav>
     <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BinaryObject.html">BinaryObject</a></li><li><a href="CacheClient.html">CacheClient</a></li><li><a href="CacheConfiguration.html">CacheConfiguration</a></li><li><a href="CacheEntry.html">CacheEntry</a></li><li><a href="CacheKeyConfiguration.html">CacheKeyConfiguration</a></li><li><a href="CollectionObjectType.html">CollectionObjectType</a></li><li><a href="ComplexObjectType.html">ComplexObjectType</a></li><li><a href="CompositeType.html">CompositeType</a></li><li><a href="Cursor.html">Cursor</a></li><li><a href="EnumItem.html">EnumItem</a></li><li><a href="IgniteClient.html">IgniteClient</a></li><li><a href="IgniteClientConfiguration.html">IgniteClientConfiguration</a></li><li><a href="IgniteClientError.html">IgniteClientError</a></li><li><a href="IllegalStateError.html">IllegalStateError</a></li><li><a href="LostConnectionError.html">LostConnectionError</a></li><li><a href="MapObjectType.html">MapObjectType</a></li><li><a href="ObjectArrayType.html">ObjectArrayType</a></li><li><a href="ObjectType.html">ObjectType</a></li><li><a href="OperationError.html">OperationError</a></li><li><a href="Query.html">Query</a></li><li><a href="QueryEntity.html">QueryEntity</a></li><li><a href="QueryField.html">QueryField</a></li><li><a href="QueryIndex.html">QueryIndex</a></li><li><a href="ScanQuery.html">ScanQuery</a></li><li><a href="SqlFieldsCursor.html">SqlFieldsCursor</a></li><li><a href="SqlFieldsQuery.html">SqlFieldsQuery</a></li><li><a href="SqlQuery.html">SqlQuery</a></li><li><a href="Timestamp.html">Timestamp</a></li></ul>
 </nav>

 <br class="clear">

 <footer>
     Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue May 22 2018 12:08:49 GMT+0300 (Russia TZ 2 Standard Time)
 </footer>

 <script> prettyPrint(); </script>
 <script src="scripts/linenumber.js"> </script>
 </body>
 </html>
	<!DOCTYPE html>
	<html lang="en">
	<head>
	<meta charset="utf-8">
	<title>JSDoc: Class: SqlFieldsCursor</title>

	<script src="scripts/prettify/prettify.js"> </script>
	<script src="scripts/prettify/lang-css.js"> </script>
	<!--[if lt IE 9]>
	<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
	<![endif]-->
	<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
	<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
	</head>

	<body>

	<div id="main">

	<h1 class="page-title">Class: SqlFieldsCursor</h1>






	<section>

	<header>

	<h2><span class="attribs"><span class="type-signature"></span></span>SqlFieldsCursor</h2>

	<div class="class-description"><p>Class representing a cursor to obtain results of SQL Fields query operation.</p>
	<p>The class has no public constructor. An instance of this class is obtained
	via query() method of <a href="CacheClient.html">CacheClient</a> objects.
	One instance of this class returns results of one SQL Fields query operation.</p></div>


	</header>

	<article>
	<div class="container-overview">

















	<dl class="details">


























	<dt class="tag-source">Source:</dt>
	<dd class="tag-source"><ul class="dummy"><li>
	<a href="Cursor.js.html">Cursor.js</a>, <a href="Cursor.js.html#line205">line 205</a>
	</li></ul></dd>







	</dl>



















	</div>


	<h3 class="subsection-title">Extends</h3>




	<ul>
	<li><a href="Cursor.html">Cursor</a></li>
	</ul>

















	<h3 class="subsection-title">Methods</h3>







	<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>






	<div class="description">
	<p>Returns all elements (arrays with values of the fields) from the query results.</p>
	<p>May be used instead of getValue() method if the number of returned elements
	is relatively small and will not cause memory utilization issues.</p>
	</div>













	<dl class="details">








	<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>



















	<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#line234">line 234</a>
	</li></ul></dd>







	</dl>













	<h5>Returns:</h5>


	<div class="param-desc">
	<ul>
	<li>all results returned by SQL Fields query.
	Every element of the array is an array with values of the fields requested by the query.</li>
	</ul>
	</div>



	<dl>
	<dt>
	Type
	</dt>
	<dd>

	<span class="param-type">Promise.<Array.<Array.<*>>></span>


	</dd>
	</dl>













	<h4 class="name" id="getFieldNames"><span class="type-signature"></span>getFieldNames<span class="signature">()</span><span class="type-signature"> → {Array.<string>}</span></h4>






	<div class="description">
	<p>Returns names of the fields which were requested in the SQL Fields query.</p>
	<p>Empty array is returned if "include field names" flag was false in the query.</p>
	</div>













	<dl class="details">


























	<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#line246">line 246</a>
	</li></ul></dd>







	</dl>













	<h5>Returns:</h5>


	<div class="param-desc">
	<ul>
	<li>field names.
	The order of names corresponds to the order of field values returned in the results of the query.</li>
	</ul>
	</div>



	<dl>
	<dt>
	Type
	</dt>
	<dd>

	<span class="param-type">Array.<string></span>


	</dd>
	</dl>













	<h4 class="name" id="getValue"><span class="type-signature">(async) </span>getValue<span class="signature">()</span><span class="type-signature"> → {Promise.<Array.<*>>}</span></h4>






	<div class="description">
	<p>Returns one element (array with values of the fields) from the query results.</p>
	<p>Every new call returns the next element from the query results.
	If the method returns null, no more elements are available.</p>
	</div>













	<dl class="details">








	<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>



















	<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#line218">line 218</a>
	</li></ul></dd>







	</dl>













	<h5>Returns:</h5>


	<div class="param-desc">
	<ul>
	<li>array with values of the fields requested by the query.</li>
	</ul>
	</div>



	<dl>
	<dt>
	Type
	</dt>
	<dd>

	<span class="param-type">Promise.<Array.<*>></span>


	</dd>
	</dl>













	<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>






	<div class="description">
	<p>Specifies types of the fields returned by the SQL Fields query.</p>
	<p>By default, a type of every field 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>









	<h5>Parameters:</h5>


	<table class="params">
	<thead>
	<tr>

	<th>Name</th>


	<th>Type</th>


	<th>Attributes</th>




	<th class="last">Description</th>
	</tr>
	</thead>

	<tbody>


	<tr>

	<td class="name"><code>fieldTypes</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 the returned fields.
	The order of types must correspond the order of field values returned in the results of the query.
	A type of every field 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="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#line266">line 266</a>
	</li></ul></dd>







	</dl>













	<h5>Returns:</h5>


	<div class="param-desc">
	<ul>
	<li>the same instance of the SqlFieldsCursor.</li>
	</ul>
	</div>



	<dl>
	<dt>
	Type
	</dt>
	<dd>

	<span class="param-type"><a href="SqlFieldsCursor.html">SqlFieldsCursor</a></span>


	</dd>
	</dl>













	</article>

	</section>




	</div>

	<nav>
	<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="BinaryObject.html">BinaryObject</a></li><li><a href="CacheClient.html">CacheClient</a></li><li><a href="CacheConfiguration.html">CacheConfiguration</a></li><li><a href="CacheEntry.html">CacheEntry</a></li><li><a href="CacheKeyConfiguration.html">CacheKeyConfiguration</a></li><li><a href="CollectionObjectType.html">CollectionObjectType</a></li><li><a href="ComplexObjectType.html">ComplexObjectType</a></li><li><a href="CompositeType.html">CompositeType</a></li><li><a href="Cursor.html">Cursor</a></li><li><a href="EnumItem.html">EnumItem</a></li><li><a href="IgniteClient.html">IgniteClient</a></li><li><a href="IgniteClientConfiguration.html">IgniteClientConfiguration</a></li><li><a href="IgniteClientError.html">IgniteClientError</a></li><li><a href="IllegalStateError.html">IllegalStateError</a></li><li><a href="LostConnectionError.html">LostConnectionError</a></li><li><a href="MapObjectType.html">MapObjectType</a></li><li><a href="ObjectArrayType.html">ObjectArrayType</a></li><li><a href="ObjectType.html">ObjectType</a></li><li><a href="OperationError.html">OperationError</a></li><li><a href="Query.html">Query</a></li><li><a href="QueryEntity.html">QueryEntity</a></li><li><a href="QueryField.html">QueryField</a></li><li><a href="QueryIndex.html">QueryIndex</a></li><li><a href="ScanQuery.html">ScanQuery</a></li><li><a href="SqlFieldsCursor.html">SqlFieldsCursor</a></li><li><a href="SqlFieldsQuery.html">SqlFieldsQuery</a></li><li><a href="SqlQuery.html">SqlQuery</a></li><li><a href="Timestamp.html">Timestamp</a></li></ul>
	</nav>

	<br class="clear">

	<footer>
	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue May 22 2018 12:08:49 GMT+0300 (Russia TZ 2 Standard Time)
	</footer>

	<script> prettyPrint(); </script>
	<script src="scripts/linenumber.js"> </script>
	</body>
	</html>