Apache\Ignite\Cache\QueryIndex Class Reference

Public Member Functions
	__construct (string $name=null, int $type=self::TYPE_SORTED)
	setName (string $name)
	getName ()
	setType (int $type)
	getType ()
	setInlineSize (int $inlineSize)
	getInlineSize ()
	setFields (array $fields)
	getFields ()

Public Attributes
QueryIndexType
const	TYPE_SORTED = 0
const	TYPE_FULLTEXT = 1
const	TYPE_GEOSPATIAL = 2

Detailed Description

Class representing one Query Index 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\QueryIndex::__construct	(	string	$name = null,
		int	$type = self::TYPE_SORTED
	)

QueryIndex constructor.

Parameters

string | null	$name
int	$type	one of QueryIndexType constants.

Exceptions

ClientException

if error.

Member Function Documentation

getFields()

Apache\Ignite\Cache\QueryIndex::getFields

(

)

Returns

array[string => bool]|null

getInlineSize()

Apache\Ignite\Cache\QueryIndex::getInlineSize

(

)

Returns

int

getName()

Apache\Ignite\Cache\QueryIndex::getName

(

)

Returns

string|null

getType()

Apache\Ignite\Cache\QueryIndex::getType

(

)

Returns

int index type, one of QueryIndexType constants.

setFields()

Apache\Ignite\Cache\QueryIndex::setFields

(

array

$fields

)

Parameters

array[string

=> bool] $fields

Returns

QueryIndex the same instance of the QueryIndex.

setInlineSize()

Apache\Ignite\Cache\QueryIndex::setInlineSize

(

int

$inlineSize

)

Parameters

int

$inlineSize

Returns

QueryIndex the same instance of the QueryIndex.

setName()

Apache\Ignite\Cache\QueryIndex::setName

(

string

$name

)

Parameters

string

$name

Returns

QueryIndex the same instance of the QueryIndex.

setType()

Apache\Ignite\Cache\QueryIndex::setType

(

int

$type

)

Parameters

int

$type

one of QueryIndexType constants.

Returns

QueryIndex the same instance of the QueryIndex.

Exceptions

ClientException

if error.

---

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

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