http://git-wip-us.apache.org/repos/asf/ignite/blob/c56d16fb/modules/platforms/nodejs/api_spec/Query.js.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/Query.js.html b/modules/platforms/nodejs/api_spec/Query.js.html new file mode 100644 index 0000000..ac1a973 --- /dev/null +++ b/modules/platforms/nodejs/api_spec/Query.js.html @@ -0,0 +1,559 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>JSDoc: Source: Query.js</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">Source: Query.js</h1> + + + + + + + <section> + <article> + <pre class="prettyprint source linenums"><code>/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +'use strict'; + +const Cursor = require('./Cursor').Cursor; +const SqlFieldsCursor = require('./Cursor').SqlFieldsCursor; +const ArgumentChecker = require('./internal/ArgumentChecker'); +const BinaryWriter = require('./internal/BinaryWriter'); +const BinaryUtils = require('./internal/BinaryUtils'); + +const PAGE_SIZE_DEFAULT = 1024; + +/** + * Base class representing an Ignite SQL or Scan query. + * + * The class has no public constructor. Only subclasses may be instantiated. + * + * @hideconstructor + */ +class Query { + + /** + * Set local query flag. + * + * @param {boolean} local - local query flag: true or false. + * + * @return {Query} - the same instance of the Query. + */ + setLocal(local) { + this._local = local; + return this; + } + + /** + * Set {@link Cursor} page size. + * + * @param {number} pageSize - cursor page size. + * + * @return {Query} - the same instance of the Query. + */ + setPageSize(pageSize) { + this._pageSize = pageSize; + return this; + } + + /** Private methods */ + + /** + * @ignore + */ + constructor(operation) { + this._operation = operation; + this._local = false; + this._pageSize = PAGE_SIZE_DEFAULT; + } +} + +/** + * Class representing an SQL query which returns the whole cache entries (key-value pairs). + * @extends Query + */ +class SqlQuery extends Query { + + /** + * Public constructor. + * + * Requires name of a type (or SQL table) and SQL query string to be specified. + * Other SQL query settings have the following defaults: + * <pre> + * SQL 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) + * </pre> + * Every setting may be changed using set methods. + * + * @param {string} type - name of a type or SQL table. + * @param {string} sql - SQL query string. + * + * @return {SqlQuery} - new SqlQuery instance. + */ + constructor(type, sql) { + super(BinaryUtils.OPERATION.QUERY_SQL); + this.setType(type); + this.setSql(sql); + this._args = null; + this._argTypes = null; + this._distributedJoins = false; + this._replicatedOnly = false; + this._timeout = 0; + } + + /** + * Set name of a type or SQL table. + * + * @param {string} type - name of a type or SQL table. + * + * @return {SqlQuery} - the same instance of the SqlQuery. + */ + setType(type) { + if (this instanceof SqlFieldsQuery) { + ArgumentChecker.invalidArgument(type, 'type', SqlFieldsQuery); + } + else { + ArgumentChecker.notNull(type, 'type'); + } + this._type = type; + return this; + } + + /** + * Set SQL query string. + * + * @param {string} sql - SQL query string. + * + * @return {SqlQuery} - the same instance of the SqlQuery. + */ + setSql(sql) { + ArgumentChecker.notNull(sql, 'sql'); + this._sql = sql; + return this; + } + + /** + * Set query arguments. + * + * 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 {@link ObjectType} class. + * + * @param {...*} args - Query arguments. + * + * @return {SqlQuery} - the same instance of the SqlQuery. + */ + setArgs(...args) { + this._args = args; + return this; + } + + /** + * Specifies types of query arguments. + * + * 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 {@link ObjectType} class. + * + * @param {...ObjectType.PRIMITIVE_TYPE | CompositeType} argTypes - 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: + * - either a type code of primitive (simple) type + * - or an instance of class representing non-primitive (composite) type + * - or null (means the type is not specified) + * + * @return {SqlQuery} - the same instance of the SqlQuery. + */ + setArgTypes(...argTypes) { + this._argTypes = argTypes; + return this; + } + + /** + * Set distributed joins flag. + * + * @param {boolean} distributedJoins - distributed joins flag: true or false. + * + * @return {SqlQuery} - the same instance of the SqlQuery. + */ + setDistributedJoins(distributedJoins) { + this._distributedJoins = distributedJoins; + return this; + } + + /** + * Set replicated only flag. + * + * @param {boolean} replicatedOnly - replicated only flag: true or false. + * + * @return {SqlQuery} - the same instance of the SqlQuery. + */ + setReplicatedOnly(replicatedOnly) { + this._replicatedOnly = replicatedOnly; + return this; + } + + /** + * Set timeout. + * + * @param {number} timeout - timeout value in milliseconds. + * Must be non-negative. Zero value disables timeout. + * + * @return {SqlQuery} - the same instance of the SqlQuery. + */ + setTimeout(timeout) { + this._timeout = timeout; + return this; + } + + /** Private methods */ + + /** + * @ignore + */ + async _write(buffer) { + await BinaryWriter.writeString(buffer, this._type); + await BinaryWriter.writeString(buffer, this._sql); + await this._writeArgs(buffer); + buffer.writeBoolean(this._distributedJoins); + buffer.writeBoolean(this._local); + buffer.writeBoolean(this._replicatedOnly); + buffer.writeInteger(this._pageSize); + buffer.writeLong(this._timeout); + } + + /** + * @ignore + */ + async _writeArgs(buffer) { + const argsLength = this._args ? this._args.length : 0; + buffer.writeInteger(argsLength); + if (argsLength > 0) { + let argType; + for (let i = 0; i < argsLength; i++) { + argType = this._argTypes && i < this._argTypes.length ? this._argTypes[i] : null; + await BinaryWriter.writeObject(buffer, this._args[i], argType); + } + } + } + + /** + * @ignore + */ + async _getCursor(socket, payload, keyType = null, valueType = null) { + const cursor = new Cursor(socket, BinaryUtils.OPERATION.QUERY_SQL_CURSOR_GET_PAGE, payload, keyType, valueType); + cursor._readId(payload); + return cursor; + } +} + +/** + * Statement type of SQL Fields query. + * @typedef SqlFieldsQuery.STATEMENT_TYPE + * @enum + * @readonly + * @property ANY 0 + * @property SELECT 1 + * @property UPDATE 2 + */ +const STATEMENT_TYPE = Object.freeze({ + ANY : 0, + SELECT : 1, + UPDATE : 2 +}); + + +/** + * Class representing an SQL Fields query. + * @extends SqlQuery + */ +class SqlFieldsQuery extends SqlQuery { + + /** + * Public constructor. + * + * Requires SQL query string to be specified. + * Other SQL Fields query settings have the following defaults: + * <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. + * + * @param {string} sql - SQL query string. + * + * @return {SqlFieldsQuery} - new SqlFieldsQuery instance. + */ + constructor(sql) { + super(null, sql); + this._operation = BinaryUtils.OPERATION.QUERY_SQL_FIELDS; + this._schema = null; + this._maxRows = -1; + this._statementType = SqlFieldsQuery.STATEMENT_TYPE.ANY; + this._enforceJoinOrder = false; + this._collocated = false; + this._lazy = false; + this._includeFieldNames = false; + } + + static get STATEMENT_TYPE() { + return STATEMENT_TYPE; + } + + /** + * Set schema for the query. + * + * @param {string} schema - schema for the query. + * + * @return {SqlFieldsQuery} - the same instance of the SqlFieldsQuery. + */ + setSchema(schema) { + this._schema = schema; + return this; + } + + /** + * Set max rows. + * + * @param {number} maxRows - max rows. + * + * @return {SqlFieldsQuery} - the same instance of the SqlFieldsQuery. + */ + setMaxRows(maxRows) { + this._maxRows = maxRows; + return this; + } + + /** + * Set statement type. + * + * @param {SqlFieldsQuery.STATEMENT_TYPE} type - statement type. + * + * @return {SqlFieldsQuery} - the same instance of the SqlFieldsQuery. + */ + setStatementType(type) { + this._statementType = type; + return this; + } + + /** + * Set enforce join order flag. + * + * @param {boolean} enforceJoinOrder - enforce join order flag: true or false. + * + * @return {SqlFieldsQuery} - the same instance of the SqlFieldsQuery. + */ + setEnforceJoinOrder(enforceJoinOrder) { + this._enforceJoinOrder = enforceJoinOrder; + return this; + } + + /** + * Set collocated flag. + * + * @param {boolean} collocated - collocated flag: true or false. + * + * @return {SqlFieldsQuery} - the same instance of the SqlFieldsQuery. + */ + setCollocated(collocated) { + this._collocated = collocated; + return this; + } + + /** + * Set lazy query execution flag. + * + * @param {boolean} lazy - lazy query execution flag: true or false. + * + * @return {SqlFieldsQuery} - the same instance of the SqlFieldsQuery. + */ + setLazy(lazy) { + this._lazy = lazy; + return this; + } + + /** + * Set include field names flag. + * + * @param {boolean} includeFieldNames - include field names flag: true or false. + * + * @return {SqlFieldsQuery} - the same instance of the SqlFieldsQuery. + */ + setIncludeFieldNames(includeFieldNames) { + this._includeFieldNames = includeFieldNames; + return this; + } + + /** Private methods */ + + /** + * @ignore + */ + async _write(buffer) { + await BinaryWriter.writeString(buffer, this._schema); + buffer.writeInteger(this._pageSize); + buffer.writeInteger(this._maxRows); + await BinaryWriter.writeString(buffer, this._sql); + await this._writeArgs(buffer) + buffer.writeByte(this._statementType); + buffer.writeBoolean(this._distributedJoins); + buffer.writeBoolean(this._local); + buffer.writeBoolean(this._replicatedOnly); + buffer.writeBoolean(this._enforceJoinOrder); + buffer.writeBoolean(this._collocated); + buffer.writeBoolean(this._lazy); + buffer.writeLong(this._timeout); + buffer.writeBoolean(this._includeFieldNames); + } + + /** + * @ignore + */ + async _getCursor(socket, payload, keyType = null, valueType = null) { + const cursor = new SqlFieldsCursor(socket, payload); + await cursor._readFieldNames(payload, this._includeFieldNames); + return cursor; + } +} + +/** + * Class representing a Scan query which returns the whole cache entries (key-value pairs). + * + * 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 { + + /** + * Public constructor. + * + * Scan query settings have the following defaults: + * <pre> + * Scan Query setting : Default value + * Local query flag : false + * Cursor page size : 1024 + * Partition number : -1 (entire cache) + * Filter object : null (not supported) + * </pre> + * Every setting (except Filter object) may be changed using set methods. + * + * @return {ScanQuery} - new ScanQuery instance. + */ + constructor() { + super(BinaryUtils.OPERATION.QUERY_SCAN); + this._partitionNumber = -1; + } + + /** + * Sets a partition number over which this query should iterate. + * + * If negative, the query will iterate over all partitions in the cache. + * + * @param {number} partitionNumber - partition number over which this query should iterate. + * + * @return {ScanQuery} - the same instance of the ScanQuery. + */ + setPartitionNumber(partitionNumber) { + this._partitionNumber = partitionNumber; + return this; + } + + /** Private methods */ + + /** + * @ignore + */ + async _write(buffer) { + // filter + await BinaryWriter.writeObject(buffer, null); + buffer.writeInteger(this._pageSize); + buffer.writeInteger(this._partitionNumber); + buffer.writeBoolean(this._local); + } + + /** + * @ignore + */ + async _getCursor(socket, payload, keyType = null, valueType = null) { + const cursor = new Cursor(socket, BinaryUtils.OPERATION.QUERY_SCAN_CURSOR_GET_PAGE, payload, keyType, valueType); + cursor._readId(payload); + return cursor; + } +} + +module.exports.SqlQuery = SqlQuery; +module.exports.SqlFieldsQuery = SqlFieldsQuery; +module.exports.ScanQuery = ScanQuery; +</code></pre> + </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:48 GMT+0300 (Russia TZ 2 Standard Time) +</footer> + +<script> prettyPrint(); </script> +<script src="scripts/linenumber.js"> </script> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/ignite/blob/c56d16fb/modules/platforms/nodejs/api_spec/QueryEntity.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/QueryEntity.html b/modules/platforms/nodejs/api_spec/QueryEntity.html new file mode 100644 index 0000000..d012b82 --- /dev/null +++ b/modules/platforms/nodejs/api_spec/QueryEntity.html @@ -0,0 +1,2218 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>JSDoc: Class: QueryEntity</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: QueryEntity</h1> + + + + + + +<section> + +<header> + + <h2><span class="attribs"><span class="type-signature"></span></span>QueryEntity<span class="signature">()</span><span class="type-signature"></span></h2> + + <div class="class-description"><p>Class representing one Query Entity element of Ignite <a href="CacheConfiguration.html">CacheConfiguration</a>.</p> +<p>All configuration settings are optional and have defaults which are defined on a server side.</p> +<p>See Apache Ignite documentation for details of every configuration setting.</p></div> + + +</header> + +<article> + <div class="container-overview"> + + + + + <h2>Constructor</h2> + + + + <h4 class="name" id="QueryEntity"><span class="type-signature"></span>new QueryEntity<span class="signature">()</span><span class="type-signature"></span></h4> + + + + + + +<div class="description"> + <p>Public constructor.</p> +</div> + + + + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line118">line 118</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + + + + + + </div> + + + + + + + + + + + + + + + + + <h3 class="subsection-title">Methods</h3> + + + + + + + + <h4 class="name" id="getAliases"><span class="type-signature"></span>getAliases<span class="signature">()</span><span class="type-signature"> → {Map.<string, string>}</span></h4> + + + + + + + + + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line279">line 279</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">Map.<string, string></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="getFields"><span class="type-signature"></span>getFields<span class="signature">()</span><span class="type-signature"> → {Array.<<a href="QueryField.html">QueryField</a>>}</span></h4> + + + + + + + + + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line258">line 258</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">Array.<<a href="QueryField.html">QueryField</a>></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="getIndexes"><span class="type-signature"></span>getIndexes<span class="signature">()</span><span class="type-signature"> → {Array.<<a href="QueryIndex.html">QueryIndex</a>>}</span></h4> + + + + + + + + + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line300">line 300</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">Array.<<a href="QueryIndex.html">QueryIndex</a>></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="getKeyFieldName"><span class="type-signature"></span>getKeyFieldName<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> + + + + + + + + + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line216">line 216</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">string</span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="getKeyTypeName"><span class="type-signature"></span>getKeyTypeName<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> + + + + + + + + + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line153">line 153</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">string</span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="getTableName"><span class="type-signature"></span>getTableName<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> + + + + + + + + + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line195">line 195</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">string</span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="getValueFieldName"><span class="type-signature"></span>getValueFieldName<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> + + + + + + + + + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line237">line 237</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">string</span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="getValueTypeName"><span class="type-signature"></span>getValueTypeName<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> + + + + + + + + + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line174">line 174</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">string</span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setAliases"><span class="type-signature"></span>setAliases<span class="signature">(aliases)</span><span class="type-signature"> → {<a href="QueryEntity.html">QueryEntity</a>}</span></h4> + + + + + + + + + + + + + + + <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>aliases</code></td> + + + <td class="type"> + + +<span class="param-type">Map.<string, string></span> + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line269">line 269</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the QueryEntity.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="QueryEntity.html">QueryEntity</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setFields"><span class="type-signature"></span>setFields<span class="signature">(fields)</span><span class="type-signature"> → {<a href="QueryEntity.html">QueryEntity</a>}</span></h4> + + + + + + + + + + + + + + + <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>fields</code></td> + + + <td class="type"> + + +<span class="param-type">Array.<<a href="QueryField.html">QueryField</a>></span> + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line248">line 248</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the QueryEntity.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="QueryEntity.html">QueryEntity</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setIndexes"><span class="type-signature"></span>setIndexes<span class="signature">(indexes)</span><span class="type-signature"> → {<a href="QueryEntity.html">QueryEntity</a>}</span></h4> + + + + + + + + + + + + + + + <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>indexes</code></td> + + + <td class="type"> + + +<span class="param-type">Array.<<a href="QueryIndex.html">QueryIndex</a>></span> + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line290">line 290</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the QueryEntity.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="QueryEntity.html">QueryEntity</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setKeyFieldName"><span class="type-signature"></span>setKeyFieldName<span class="signature">(keyFieldName)</span><span class="type-signature"> → {<a href="QueryEntity.html">QueryEntity</a>}</span></h4> + + + + + + + + + + + + + + + <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>keyFieldName</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line206">line 206</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the QueryEntity.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="QueryEntity.html">QueryEntity</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setKeyTypeName"><span class="type-signature"></span>setKeyTypeName<span class="signature">(keyTypeName)</span><span class="type-signature"> → {<a href="QueryEntity.html">QueryEntity</a>}</span></h4> + + + + + + + + + + + + + + + <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>keyTypeName</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line143">line 143</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the QueryEntity.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="QueryEntity.html">QueryEntity</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setTableName"><span class="type-signature"></span>setTableName<span class="signature">(tableName)</span><span class="type-signature"> → {<a href="QueryEntity.html">QueryEntity</a>}</span></h4> + + + + + + + + + + + + + + + <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>tableName</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line185">line 185</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the QueryEntity.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="QueryEntity.html">QueryEntity</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setValueFieldName"><span class="type-signature"></span>setValueFieldName<span class="signature">(valueFieldName)</span><span class="type-signature"> → {<a href="QueryEntity.html">QueryEntity</a>}</span></h4> + + + + + + + + + + + + + + + <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>valueFieldName</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line227">line 227</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the QueryEntity.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="QueryEntity.html">QueryEntity</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setValueTypeName"><span class="type-signature"></span>setValueTypeName<span class="signature">(valueTypeName)</span><span class="type-signature"> → {<a href="QueryEntity.html">QueryEntity</a>}</span></h4> + + + + + + + + + + + + + + + <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>valueTypeName</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line164">line 164</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the QueryEntity.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="QueryEntity.html">QueryEntity</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> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/ignite/blob/c56d16fb/modules/platforms/nodejs/api_spec/QueryField.html ---------------------------------------------------------------------- diff --git a/modules/platforms/nodejs/api_spec/QueryField.html b/modules/platforms/nodejs/api_spec/QueryField.html new file mode 100644 index 0000000..444942e --- /dev/null +++ b/modules/platforms/nodejs/api_spec/QueryField.html @@ -0,0 +1,2211 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="utf-8"> + <title>JSDoc: Class: QueryField</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: QueryField</h1> + + + + + + +<section> + +<header> + + <h2><span class="attribs"><span class="type-signature"></span></span>QueryField<span class="signature">(name<span class="signature-attributes">opt</span>, typeName<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2> + + <div class="class-description"><p>Class representing one Query Field element of <a href="QueryEntity.html">QueryEntity</a> of Ignite <a href="CacheConfiguration.html">CacheConfiguration</a>.</p> +<p>All configuration settings are optional and have defaults which are defined on a server side.</p> +<p>See Apache Ignite documentation for details of every configuration setting.</p></div> + + +</header> + +<article> + <div class="container-overview"> + + + + + <h2>Constructor</h2> + + + + <h4 class="name" id="QueryField"><span class="type-signature"></span>new QueryField<span class="signature">(name<span class="signature-attributes">opt</span>, typeName<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> + + + + + + +<div class="description"> + <p>Public constructor.</p> +</div> + + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + <th>Attributes</th> + + + + <th>Default</th> + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>name</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + <td class="attributes"> + + <optional><br> + + + + + + </td> + + + + <td class="default"> + + null + + </td> + + + <td class="description last"></td> + </tr> + + + + <tr> + + <td class="name"><code>typeName</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + <td class="attributes"> + + <optional><br> + + + + + + </td> + + + + <td class="default"> + + null + + </td> + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line400">line 400</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + + + + + + + + </div> + + + + + + + + + + + + + + + + + <h3 class="subsection-title">Methods</h3> + + + + + + + + <h4 class="name" id="getDefaultValue"><span class="type-signature">(async) </span>getDefaultValue<span class="signature">(valueType<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {*}</span></h4> + + + + + + + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + <th>Attributes</th> + + + + <th>Default</th> + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>valueType</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"> + + <optional><br> + + + + + + </td> + + + + <td class="default"> + + null + + </td> + + + <td class="description last"><p>type of the default value:</p> +<ul> +<li>either a type code of primitive (simple) type</li> +<li>or an instance of class representing non-primitive (composite) type</li> +<li>or null (or not specified) that means the type is not specified</li> +</ul></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line536">line 536</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">*</span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="getIsKeyField"><span class="type-signature"></span>getIsKeyField<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> + + + + + + + + + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line482">line 482</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">boolean</span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="getIsNotNull"><span class="type-signature"></span>getIsNotNull<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> + + + + + + + + + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line503">line 503</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">boolean</span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="getName"><span class="type-signature"></span>getName<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> + + + + + + + + + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line440">line 440</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">string</span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="getPrecision"><span class="type-signature"></span>getPrecision<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> + + + + + + + + + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line572">line 572</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">number</span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="getScale"><span class="type-signature"></span>getScale<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> + + + + + + + + + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line594">line 594</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">number</span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="getTypeName"><span class="type-signature"></span>getTypeName<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> + + + + + + + + + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line461">line 461</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type">string</span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setDefaultValue"><span class="type-signature"></span>setDefaultValue<span class="signature">(defaultValue, valueType<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="QueryField.html">QueryField</a>}</span></h4> + + + + + + + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + <th>Attributes</th> + + + + <th>Default</th> + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>defaultValue</code></td> + + + <td class="type"> + + +<span class="param-type">*</span> + + + + </td> + + + <td class="attributes"> + + + + + + </td> + + + + <td class="default"> + + </td> + + + <td class="description last"></td> + </tr> + + + + <tr> + + <td class="name"><code>valueType</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"> + + <optional><br> + + + + + + </td> + + + + <td class="default"> + + null + + </td> + + + <td class="description last"><p>type of the default value:</p> +<ul> +<li>either a type code of primitive (simple) type</li> +<li>or an instance of class representing non-primitive (composite) type</li> +<li>or null (or not specified) that means the type is not specified</li> +</ul></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line518">line 518</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the QueryField.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="QueryField.html">QueryField</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setIsKeyField"><span class="type-signature"></span>setIsKeyField<span class="signature">(isKeyField)</span><span class="type-signature"> → {<a href="QueryField.html">QueryField</a>}</span></h4> + + + + + + + + + + + + + + + <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>isKeyField</code></td> + + + <td class="type"> + + +<span class="param-type">boolean</span> + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line472">line 472</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the QueryField.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="QueryField.html">QueryField</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setIsNotNull"><span class="type-signature"></span>setIsNotNull<span class="signature">(isNotNull)</span><span class="type-signature"> → {<a href="QueryField.html">QueryField</a>}</span></h4> + + + + + + + + + + + + + + + <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>isNotNull</code></td> + + + <td class="type"> + + +<span class="param-type">boolean</span> + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line493">line 493</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the QueryField.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="QueryField.html">QueryField</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setName"><span class="type-signature"></span>setName<span class="signature">(name)</span><span class="type-signature"> → {<a href="QueryField.html">QueryField</a>}</span></h4> + + + + + + + + + + + + + + + <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>name</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line430">line 430</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the QueryField.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="QueryField.html">QueryField</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setPrecision"><span class="type-signature"></span>setPrecision<span class="signature">(precision)</span><span class="type-signature"> → {<a href="QueryField.html">QueryField</a>}</span></h4> + + + + + + + + + + + + + + + <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>precision</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line561">line 561</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the QueryField.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="QueryField.html">QueryField</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setScale"><span class="type-signature"></span>setScale<span class="signature">(scale)</span><span class="type-signature"> → {<a href="QueryField.html">QueryField</a>}</span></h4> + + + + + + + + + + + + + + + <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>scale</code></td> + + + <td class="type"> + + +<span class="param-type">number</span> + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line583">line 583</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the QueryField.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="QueryField.html">QueryField</a></span> + + + </dd> +</dl> + + + + + + + + + + + + + + <h4 class="name" id="setTypeName"><span class="type-signature"></span>setTypeName<span class="signature">(typeName)</span><span class="type-signature"> → {<a href="QueryField.html">QueryField</a>}</span></h4> + + + + + + + + + + + + + + + <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>typeName</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + <dt class="tag-source">Source:</dt> + <dd class="tag-source"><ul class="dummy"><li> + <a href="CacheConfiguration.js.html">CacheConfiguration.js</a>, <a href="CacheConfiguration.js.html#line451">line 451</a> + </li></ul></dd> + + + + + + + +</dl> + + + + + + + + + + + + + +<h5>Returns:</h5> + + +<div class="param-desc"> + <ul> +<li>the same instance of the QueryField.</li> +</ul> +</div> + + + +<dl> + <dt> + Type + </dt> + <dd> + +<span class="param-type"><a href="QueryField.html">QueryField</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> \ No newline at end of file
