| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <title>JSDoc: Class: SqlFieldsQuery</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: SqlFieldsQuery</h1> |
| |
| |
| |
| |
| |
| |
| <section> |
| |
| <header> |
| |
| <h2><span class="attribs"><span class="type-signature"></span></span>SqlFieldsQuery<span class="signature">(sql)</span><span class="type-signature"></span></h2> |
| |
| <div class="class-description"><p>Class representing an SQL Fields query.</p></div> |
| |
| |
| </header> |
| |
| <article> |
| <div class="container-overview"> |
| |
| |
| |
| |
| <h2>Constructor</h2> |
| |
| |
| |
| <h4 class="name" id="SqlFieldsQuery"><span class="type-signature"></span>new SqlFieldsQuery<span class="signature">(sql)</span><span class="type-signature"></span></h4> |
| |
| |
| |
| |
| |
| |
| <div class="description"> |
| <p>Public constructor.</p> |
| <p>Requires SQL query string to be specified. |
| Other SQL Fields query settings have the following defaults:</p> |
| <p><pre> |
| SQL Fields Query setting : Default value |
| Local query flag : false |
| Cursor page size : 1024 |
| Query arguments : not specified |
| Distributed joins flag : false |
| Replicated only flag : false |
| Timeout : 0 (disabled) |
| Schema for the query : not specified |
| Max rows : -1 |
| Statement type : STATEMENT_TYPE.ANY |
| Enforce join order flag : false |
| Collocated flag : false |
| Lazy query execution flag : false |
| Include field names flag : false |
| </pre> |
| Every setting may be changed using set methods.</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="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#line279">line 279</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </div> |
| |
| |
| <h3 class="subsection-title">Extends</h3> |
| |
| |
| |
| |
| <ul> |
| <li><a href="SqlQuery.html">SqlQuery</a></li> |
| </ul> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h3 class="subsection-title">Members</h3> |
| |
| |
| |
| <h4 class="name" id=".STATEMENT_TYPE"><span class="type-signature">(static, readonly) </span>STATEMENT_TYPE<span class="type-signature"></span></h4> |
| |
| |
| |
| |
| <div class="description"> |
| <p>Statement type of SQL Fields query.</p> |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| <h5 class="subsection-title">Properties:</h5> |
| |
| |
| |
| <table class="props"> |
| <thead> |
| <tr> |
| |
| <th>Name</th> |
| |
| |
| <th>Type</th> |
| |
| |
| |
| |
| |
| <th class="last">Description</th> |
| </tr> |
| </thead> |
| |
| <tbody> |
| |
| |
| <tr> |
| |
| <td class="name"><code>ANY</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last"><p>0</p></td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>SELECT</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last"><p>1</p></td> |
| </tr> |
| |
| |
| |
| <tr> |
| |
| <td class="name"><code>UPDATE</code></td> |
| |
| |
| <td class="type"> |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last"><p>2</p></td> |
| </tr> |
| |
| |
| </tbody> |
| </table> |
| |
| |
| |
| |
| <dl class="details"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <dt class="tag-source">Source:</dt> |
| <dd class="tag-source"><ul class="dummy"><li> |
| <a href="Query.js.html">Query.js</a>, <a href="Query.js.html#line259">line 259</a> |
| </li></ul></dd> |
| |
| |
| |
| |
| |
| |
| |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h3 class="subsection-title">Methods</h3> |
| |
| |
| |
| |
| |
| |
| |
| <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> |
| |
| |
| |
| |
| |
| |
| <div class="description"> |
| <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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <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>args</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">*</span> |
| |
| |
| |
| </td> |
| |
| |
| <td class="attributes"> |
| |
| |
| |
| |
| |
| <repeatable><br> |
| |
| </td> |
| |
| |
| |
| |
| <td class="description last"><p>Query arguments.</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#setArgs">SqlQuery#setArgs</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#line154">line 154</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="setArgTypes"><span class="type-signature"></span>setArgTypes<span class="signature">(…argTypes)</span><span class="type-signature"> → {<a href="SqlQuery.html">SqlQuery</a>}</span></h4> |
| |
| |
| |
| |
| |
| |
| <div class="description"> |
| <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> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <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>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"> |
| |
| |
| <span class="param-type">boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last"><p>collocated flag: true or false.</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#line379">line 379</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="setDistributedJoins"><span class="type-signature"></span>setDistributedJoins<span class="signature">(distributedJoins)</span><span class="type-signature"> → {<a href="SqlQuery.html">SqlQuery</a>}</span></h4> |
| |
| |
| |
| |
| |
| |
| <div class="description"> |
| <p>Set distributed joins 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>distributedJoins</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last"><p>distributed joins 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#setDistributedJoins">SqlQuery#setDistributedJoins</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#line188">line 188</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="setEnforceJoinOrder"><span class="type-signature"></span>setEnforceJoinOrder<span class="signature">(enforceJoinOrder)</span><span class="type-signature"> → {<a href="SqlFieldsQuery.html">SqlFieldsQuery</a>}</span></h4> |
| |
| |
| |
| |
| |
| |
| <div class="description"> |
| <p>Set enforce join order 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>enforceJoinOrder</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last"><p>enforce join order flag: true or false.</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#line367">line 367</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="setIncludeFieldNames"><span class="type-signature"></span>setIncludeFieldNames<span class="signature">(includeFieldNames)</span><span class="type-signature"> → {<a href="SqlFieldsQuery.html">SqlFieldsQuery</a>}</span></h4> |
| |
| |
| |
| |
| |
| |
| <div class="description"> |
| <p>Set include field names 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>includeFieldNames</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last"><p>include field names flag: true or false.</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#line403">line 403</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="setLazy"><span class="type-signature"></span>setLazy<span class="signature">(lazy)</span><span class="type-signature"> → {<a href="SqlFieldsQuery.html">SqlFieldsQuery</a>}</span></h4> |
| |
| |
| |
| |
| |
| |
| <div class="description"> |
| <p>Set lazy query execution 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>lazy</code></td> |
| |
| |
| <td class="type"> |
| |
| |
| <span class="param-type">boolean</span> |
| |
| |
| |
| </td> |
| |
| |
| |
| |
| |
| <td class="description last"><p>lazy query execution flag: true or false.</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#line391">line 391</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="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="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> |
| </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> |
