Class: QueryField

QueryField(nameopt, typeNameopt)

Class representing one Query Field element of QueryEntity of Ignite CacheConfiguration.

All configuration settings are optional and have defaults which are defined on a server side.

See Apache Ignite documentation for details of every configuration setting.

Constructor

new QueryField(nameopt, typeNameopt)

Public constructor.

Parameters:
Name Type Attributes Default Description
name string <optional>
null
typeName string <optional>
null
Source:

Methods

(async) getDefaultValue(valueTypeopt) → {*}

Parameters:
Name Type Attributes Default Description
valueType ObjectType.PRIMITIVE_TYPE | CompositeType <optional>
null

type of the default value:

  • either a type code of primitive (simple) type
  • or an instance of class representing non-primitive (composite) type
  • or null (or not specified) that means the type is not specified
Source:
Returns:
Type
*

getIsKeyField() → {boolean}

Source:
Returns:
Type
boolean

getIsNotNull() → {boolean}

Source:
Returns:
Type
boolean

getName() → {string}

Source:
Returns:
Type
string

getPrecision() → {number}

Source:
Returns:
Type
number

getScale() → {number}

Source:
Returns:
Type
number

getTypeName() → {string}

Source:
Returns:
Type
string

setDefaultValue(defaultValue, valueTypeopt) → {QueryField}

Parameters:
Name Type Attributes Default Description
defaultValue *
valueType ObjectType.PRIMITIVE_TYPE | CompositeType <optional>
null

type of the default value:

  • either a type code of primitive (simple) type
  • or an instance of class representing non-primitive (composite) type
  • or null (or not specified) that means the type is not specified
Source:
Returns:
  • the same instance of the QueryField.
Type
QueryField

setIsKeyField(isKeyField) → {QueryField}

Parameters:
Name Type Description
isKeyField boolean
Source:
Returns:
  • the same instance of the QueryField.
Type
QueryField

setIsNotNull(isNotNull) → {QueryField}

Parameters:
Name Type Description
isNotNull boolean
Source:
Returns:
  • the same instance of the QueryField.
Type
QueryField

setName(name) → {QueryField}

Parameters:
Name Type Description
name string
Source:
Returns:
  • the same instance of the QueryField.
Type
QueryField

setPrecision(precision) → {QueryField}

Parameters:
Name Type Description
precision number
Source:
Returns:
  • the same instance of the QueryField.
Type
QueryField

setScale(scale) → {QueryField}

Parameters:
Name Type Description
scale number
Source:
Returns:
  • the same instance of the QueryField.
Type
QueryField

setTypeName(typeName) → {QueryField}

Parameters:
Name Type Description
typeName string
Source:
Returns:
  • the same instance of the QueryField.
Type
QueryField