Apache\Ignite\Cache\CacheConfiguration Class Reference

Public Member Functions
	__construct ()
	setName (string $name)
	getName ()
	setAtomicityMode (int $atomicityMode)
	getAtomicityMode ()
	setBackups (int $backups)
	getBackups ()
	setCacheMode (int $cacheMode)
	getCacheMode ()
	setCopyOnRead (bool $copyOnRead)
	getCopyOnRead ()
	setDataRegionName (?string $dataRegionName)
	getDataRegionName ()
	setEagerTtl (bool $eagerTtl)
	getEagerTtl ()
	setStatisticsEnabled (bool $statisticsEnabled)
	getStatisticsEnabled ()
	setGroupName (?string $groupName)
	getGroupName ()
	setDefaultLockTimeout (float $lockTimeout)
	getDefaultLockTimeout ()
	setMaxConcurrentAsyncOperations (int $maxConcurrentAsyncOperations)
	getMaxConcurrentAsyncOperations ()
	setMaxQueryIterators (int $maxQueryIterators)
	getMaxQueryIterators ()
	setIsOnheapCacheEnabled (bool $isOnheapCacheEnabled)
	getIsOnheapCacheEnabled ()
	setPartitionLossPolicy (int $partitionLossPolicy)
	getPartitionLossPolicy ()
	setQueryDetailMetricsSize (int $queryDetailMetricsSize)
	getQueryDetailMetricsSize ()
	setQueryParallelism (int $queryParallelism)
	getQueryParallelism ()
	setReadFromBackup (bool $readFromBackup)
	getReadFromBackup ()
	setRebalanceBatchSize (int $rebalanceBatchSize)
	getRebalanceBatchSize ()
	setRebalanceBatchesPrefetchCount (float $rebalanceBatchesPrefetchCount)
	getRebalanceBatchesPrefetchCount ()
	setRebalanceDelay (float $rebalanceDelay)
	getRebalanceDelay ()
	setRebalanceMode (int $rebalanceMode)
	getRebalanceMode ()
	setRebalanceOrder (int $rebalanceOrder)
	getRebalanceOrder ()
	setRebalanceThrottle (float $rebalanceThrottle)
	getRebalanceThrottle ()
	setRebalanceTimeout (float $rebalanceTimeout)
	getRebalanceTimeout ()
	setSqlEscapeAll (bool $sqlEscapeAll)
	getSqlEscapeAll ()
	setSqlIndexInlineMaxSize (int $sqlIndexInlineMaxSize)
	getSqlIndexInlineMaxSize ()
	setSqlSchema (?string $sqlSchema)
	getSqlSchema ()
	setWriteSynchronizationMode (int $writeSynchronizationMode)
	getWriteSynchronizationMode ()
	setKeyConfigurations (CacheKeyConfiguration ... $keyConfigurations)
	getKeyConfigurations ()
	setQueryEntities (QueryEntity ... $queryEntities)
	getQueryEntities ()

Public Attributes
AtomicityMode
const	ATOMICITY_MODE_TRANSACTIONAL = 0
const	ATOMICITY_MODE_ATOMIC = 1
CacheMode
const	CACHE_MODE_LOCAL = 0
const	CACHE_MODE_REPLICATED = 1
const	CACHE_MODE_PARTITIONED = 2
PartitionLossPolicy
const	PARTITION_LOSS_POLICY_READ_ONLY_SAFE = 0
const	PARTITION_LOSS_POLICY_READ_ONLY_ALL = 1
const	PARTITION_LOSS_POLICY_READ_WRITE_SAFE = 2
const	PARTITION_LOSS_POLICY_READ_WRITE_ALL = 3
const	PARTITION_LOSS_POLICY_IGNORE = 4
RebalanceMode
const	REABALANCE_MODE_SYNC = 0
const	REABALANCE_MODE_ASYNC = 1
const	REABALANCE_MODE_NONE = 2
WriteSynchronizationMode
const	WRITE_SYNC_MODE_FULL_SYNC = 0
const	WRITE_SYNC_MODE_FULL_ASYNC = 1
const	WRITE_SYNC_MODE_PRIMARY_SYNC = 2

Detailed Description

Class representing Ignite cache configuration on a server.

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\CacheConfiguration::__construct

(

)

Public CacheConfiguration constructor.

Member Function Documentation

getAtomicityMode()

Apache\Ignite\Cache\CacheConfiguration::getAtomicityMode

(

)

Returns

int|null

getBackups()

Apache\Ignite\Cache\CacheConfiguration::getBackups

(

)

Returns

int|null

getCacheMode()

Apache\Ignite\Cache\CacheConfiguration::getCacheMode

(

)

Returns

int|null

getCopyOnRead()

Apache\Ignite\Cache\CacheConfiguration::getCopyOnRead

(

)

Returns

bool|null

getDataRegionName()

Apache\Ignite\Cache\CacheConfiguration::getDataRegionName

(

)

Returns

string|null

getDefaultLockTimeout()

Apache\Ignite\Cache\CacheConfiguration::getDefaultLockTimeout

(

)

Returns

float|null

getEagerTtl()

Apache\Ignite\Cache\CacheConfiguration::getEagerTtl

(

)

Returns

bool|null

getGroupName()

Apache\Ignite\Cache\CacheConfiguration::getGroupName

(

)

Returns

string|null

getIsOnheapCacheEnabled()

Apache\Ignite\Cache\CacheConfiguration::getIsOnheapCacheEnabled

(

)

Returns

bool|null

getKeyConfigurations()

Apache\Ignite\Cache\CacheConfiguration::getKeyConfigurations

(

)

Returns

CacheKeyConfiguration[]|null

getMaxConcurrentAsyncOperations()

Apache\Ignite\Cache\CacheConfiguration::getMaxConcurrentAsyncOperations

(

)

Returns

int|null

getMaxQueryIterators()

Apache\Ignite\Cache\CacheConfiguration::getMaxQueryIterators

(

)

Returns

int|null

getName()

Apache\Ignite\Cache\CacheConfiguration::getName

(

)

Returns

string|null

getPartitionLossPolicy()

Apache\Ignite\Cache\CacheConfiguration::getPartitionLossPolicy

(

)

Returns

int|null

getQueryDetailMetricsSize()

Apache\Ignite\Cache\CacheConfiguration::getQueryDetailMetricsSize

(

)

Returns

int|null

getQueryEntities()

Apache\Ignite\Cache\CacheConfiguration::getQueryEntities

(

)

Returns

QueryEntity[]|null

getQueryParallelism()

Apache\Ignite\Cache\CacheConfiguration::getQueryParallelism

(

)

Returns

int|null

getReadFromBackup()

Apache\Ignite\Cache\CacheConfiguration::getReadFromBackup

(

)

Returns

bool|null

getRebalanceBatchesPrefetchCount()

Apache\Ignite\Cache\CacheConfiguration::getRebalanceBatchesPrefetchCount

(

)

Returns

float|null

getRebalanceBatchSize()

Apache\Ignite\Cache\CacheConfiguration::getRebalanceBatchSize

(

)

Returns

int|null

getRebalanceDelay()

Apache\Ignite\Cache\CacheConfiguration::getRebalanceDelay

(

)

Returns

float|null

getRebalanceMode()

Apache\Ignite\Cache\CacheConfiguration::getRebalanceMode

(

)

Returns

int|null

getRebalanceOrder()

Apache\Ignite\Cache\CacheConfiguration::getRebalanceOrder

(

)

Returns

int|null

getRebalanceThrottle()

Apache\Ignite\Cache\CacheConfiguration::getRebalanceThrottle

(

)

Returns

float|null

getRebalanceTimeout()

Apache\Ignite\Cache\CacheConfiguration::getRebalanceTimeout

(

)

Returns

float|null

getSqlEscapeAll()

Apache\Ignite\Cache\CacheConfiguration::getSqlEscapeAll

(

)

Returns

bool|null

getSqlIndexInlineMaxSize()

Apache\Ignite\Cache\CacheConfiguration::getSqlIndexInlineMaxSize

(

)

Returns

int|null

getSqlSchema()

Apache\Ignite\Cache\CacheConfiguration::getSqlSchema

(

)

Returns

string|null

getStatisticsEnabled()

Apache\Ignite\Cache\CacheConfiguration::getStatisticsEnabled

(

)

Returns

bool|null

getWriteSynchronizationMode()

Apache\Ignite\Cache\CacheConfiguration::getWriteSynchronizationMode

(

)

Returns

int|null

setAtomicityMode()

Apache\Ignite\Cache\CacheConfiguration::setAtomicityMode

(

int

$atomicityMode

)

Parameters

int

$atomicityMode

one of AtomicityMode constants.

Returns

CacheConfiguration the same instance of the CacheConfiguration.

Exceptions

ClientException

if error.

setBackups()

Apache\Ignite\Cache\CacheConfiguration::setBackups

(

int

$backups

)

Parameters

int

$backups

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setCacheMode()

Apache\Ignite\Cache\CacheConfiguration::setCacheMode

(

int

$cacheMode

)

Parameters

int

$cacheMode

one of CacheMode constants.

Returns

CacheConfiguration the same instance of the CacheConfiguration.

Exceptions

ClientException

if error.

setCopyOnRead()

Apache\Ignite\Cache\CacheConfiguration::setCopyOnRead

(

bool

$copyOnRead

)

Parameters

bool

$copyOnRead

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setDataRegionName()

Apache\Ignite\Cache\CacheConfiguration::setDataRegionName

(

?string

$dataRegionName

)

Parameters

string | null

$dataRegionName

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setDefaultLockTimeout()

Apache\Ignite\Cache\CacheConfiguration::setDefaultLockTimeout

(

float

$lockTimeout

)

Parameters

float

$lockTimeout

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setEagerTtl()

Apache\Ignite\Cache\CacheConfiguration::setEagerTtl

(

bool

$eagerTtl

)

Parameters

bool

$eagerTtl

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setGroupName()

Apache\Ignite\Cache\CacheConfiguration::setGroupName

(

?string

$groupName

)

Parameters

string | null

$groupName

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setIsOnheapCacheEnabled()

Apache\Ignite\Cache\CacheConfiguration::setIsOnheapCacheEnabled

(

bool

$isOnheapCacheEnabled

)

Parameters

bool

$isOnheapCacheEnabled

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setKeyConfigurations()

Apache\Ignite\Cache\CacheConfiguration::setKeyConfigurations

(

CacheKeyConfiguration ...

$keyConfigurations

)

Parameters

CacheKeyConfiguration

...$keyConfigurations

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setMaxConcurrentAsyncOperations()

Apache\Ignite\Cache\CacheConfiguration::setMaxConcurrentAsyncOperations

(

int

$maxConcurrentAsyncOperations

)

Parameters

int

$maxConcurrentAsyncOperations

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setMaxQueryIterators()

Apache\Ignite\Cache\CacheConfiguration::setMaxQueryIterators

(

int

$maxQueryIterators

)

Parameters

int

$maxQueryIterators

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setName()

Apache\Ignite\Cache\CacheConfiguration::setName

(

string

$name

)

Parameters

string

$name

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setPartitionLossPolicy()

Apache\Ignite\Cache\CacheConfiguration::setPartitionLossPolicy

(

int

$partitionLossPolicy

)

Parameters

int

$partitionLossPolicy

one of PartitionLossPolicy constants.

Returns

CacheConfiguration the same instance of the CacheConfiguration.

Exceptions

ClientException

if error.

setQueryDetailMetricsSize()

Apache\Ignite\Cache\CacheConfiguration::setQueryDetailMetricsSize

(

int

$queryDetailMetricsSize

)

Parameters

int

$queryDetailMetricsSize

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setQueryEntities()

Apache\Ignite\Cache\CacheConfiguration::setQueryEntities

(

QueryEntity ...

$queryEntities

)

Parameters

QueryEntity

...$queryEntities

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setQueryParallelism()

Apache\Ignite\Cache\CacheConfiguration::setQueryParallelism

(

int

$queryParallelism

)

Parameters

int

$queryParallelism

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setReadFromBackup()

Apache\Ignite\Cache\CacheConfiguration::setReadFromBackup

(

bool

$readFromBackup

)

Parameters

bool

$readFromBackup

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setRebalanceBatchesPrefetchCount()

Apache\Ignite\Cache\CacheConfiguration::setRebalanceBatchesPrefetchCount

(

float

$rebalanceBatchesPrefetchCount

)

Parameters

float

$rebalanceBatchesPrefetchCount

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setRebalanceBatchSize()

Apache\Ignite\Cache\CacheConfiguration::setRebalanceBatchSize

(

int

$rebalanceBatchSize

)

Parameters

int

$rebalanceBatchSize

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setRebalanceDelay()

Apache\Ignite\Cache\CacheConfiguration::setRebalanceDelay

(

float

$rebalanceDelay

)

Parameters

float

$rebalanceDelay

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setRebalanceMode()

Apache\Ignite\Cache\CacheConfiguration::setRebalanceMode

(

int

$rebalanceMode

)

Parameters

int

$rebalanceMode

one of RebalanceMode constants.

Returns

CacheConfiguration the same instance of the CacheConfiguration.

Exceptions

ClientException

if error.

setRebalanceOrder()

Apache\Ignite\Cache\CacheConfiguration::setRebalanceOrder

(

int

$rebalanceOrder

)

Parameters

int

$rebalanceOrder

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setRebalanceThrottle()

Apache\Ignite\Cache\CacheConfiguration::setRebalanceThrottle

(

float

$rebalanceThrottle

)

Parameters

float

$rebalanceThrottle

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setRebalanceTimeout()

Apache\Ignite\Cache\CacheConfiguration::setRebalanceTimeout

(

float

$rebalanceTimeout

)

Parameters

float

$rebalanceTimeout

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setSqlEscapeAll()

Apache\Ignite\Cache\CacheConfiguration::setSqlEscapeAll

(

bool

$sqlEscapeAll

)

Parameters

bool

$sqlEscapeAll

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setSqlIndexInlineMaxSize()

Apache\Ignite\Cache\CacheConfiguration::setSqlIndexInlineMaxSize

(

int

$sqlIndexInlineMaxSize

)

Parameters

int

$sqlIndexInlineMaxSize

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setSqlSchema()

Apache\Ignite\Cache\CacheConfiguration::setSqlSchema

(

?string

$sqlSchema

)

Parameters

string | null

$sqlSchema

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setStatisticsEnabled()

Apache\Ignite\Cache\CacheConfiguration::setStatisticsEnabled

(

bool

$statisticsEnabled

)

Parameters

bool

$statisticsEnabled

Returns

CacheConfiguration the same instance of the CacheConfiguration.

setWriteSynchronizationMode()

Apache\Ignite\Cache\CacheConfiguration::setWriteSynchronizationMode

(

int

$writeSynchronizationMode

)

Parameters

int

$writeSynchronizationMode

one of WriteSynchronizationMode constants.

Returns

CacheConfiguration the same instance of the CacheConfiguration.

Exceptions

ClientException

if error.

---

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

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