Apache\Ignite\Cache\QueryField Class Reference

Public Member Functions
	__construct (string $name=null, string $typeName=null)
	setName (string $name)
	getName ()
	setTypeName (string $typeName)
	getTypeName ()
	setIsKeyField (bool $isKeyField)
	getIsKeyField ()
	setIsNotNull (bool $isNotNull)
	getIsNotNull ()
	setDefaultValue ($defaultValue, $valueType=null)
	getDefaultValue ($valueType=null)
	setPrecision (int $precision)
	getPrecision ()
	setScale (int $scale)
	getScale ()

Detailed Description

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 & Destructor Documentation

__construct()

Apache\Ignite\Cache\QueryField::__construct	(	string	$name = null,
		string	$typeName = null
	)

QueryField constructor.

Parameters

string | null	$name
string | null	$typeName

Member Function Documentation

getDefaultValue()

Apache\Ignite\Cache\QueryField::getDefaultValue

(

$valueType = null

)

Parameters

int | ObjectType | null

$valueType

type of the default value: either a type code of primitive (simple) type (PrimitiveTypeCodes) or an instance of class representing non-primitive (composite) type or null (or not specified) that means the type is not specified

Returns

mixed

Exceptions

ClientException

if error.

getIsKeyField()

Apache\Ignite\Cache\QueryField::getIsKeyField

(

)

Returns

bool

getIsNotNull()

Apache\Ignite\Cache\QueryField::getIsNotNull

(

)

Returns

bool

getName()

Apache\Ignite\Cache\QueryField::getName

(

)

Returns

string|null

getPrecision()

Apache\Ignite\Cache\QueryField::getPrecision

(

)

Returns

int

getScale()

Apache\Ignite\Cache\QueryField::getScale

(

)

Returns

int

getTypeName()

Apache\Ignite\Cache\QueryField::getTypeName

(

)

Returns

string|null

setDefaultValue()

Apache\Ignite\Cache\QueryField::setDefaultValue	(		$defaultValue,
			$valueType = null
	)

Parameters

mixed	$defaultValue
int | ObjectType | null	$valueType	type of the default value: either a type code of primitive (simple) type (PrimitiveTypeCodes) or an instance of class representing non-primitive (composite) type or null (or not specified) that means the type is not specified

Returns

QueryField the same instance of the QueryField.

setIsKeyField()

Apache\Ignite\Cache\QueryField::setIsKeyField

(

bool

$isKeyField

)

Parameters

bool

$isKeyField

Returns

QueryField the same instance of the QueryField.

setIsNotNull()

Apache\Ignite\Cache\QueryField::setIsNotNull

(

bool

$isNotNull

)

Parameters

bool

$isNotNull

Returns

QueryField the same instance of the QueryField.

setName()

Apache\Ignite\Cache\QueryField::setName

(

string

$name

)

Parameters

string

$name

Returns

QueryField the same instance of the QueryField.

setPrecision()

Apache\Ignite\Cache\QueryField::setPrecision

(

int

$precision

)

Parameters

int

$precision

Returns

QueryField the same instance of the QueryField.

setScale()

Apache\Ignite\Cache\QueryField::setScale

(

int

$scale

)

Parameters

int

$scale

Returns

QueryField the same instance of the QueryField.

setTypeName()

Apache\Ignite\Cache\QueryField::setTypeName

(

string

$typeName

)

Parameters

string

$typeName

Returns

QueryField the same instance of the QueryField.

---

The documentation for this class was generated from the following file:

• src/Apache/Ignite/Cache/QueryField.php