Class: CacheConfiguration

CacheConfiguration()

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

new CacheConfiguration()

Public constructor.

Source:

Members

(static, readonly) CACHE_ATOMICITY_MODE

Properties:
Name Type Description
TRANSACTIONAL

0

ATOMIC

1

Source:

(static, readonly) CACHE_MODE

Properties:
Name Type Description
LOCAL

0

REPLICATED

1

PARTITIONED

2

Source:

(static, readonly) PARTITION_LOSS_POLICY

Properties:
Name Type Description
READ_ONLY_SAFE

0

READ_ONLY_ALL

1

READ_WRITE_SAFE

2

READ_WRITE_ALL

3

IGNORE

4

Source:

(static, readonly) REABALANCE_MODE

Properties:
Name Type Description
SYNC

0

ASYNC

1

NONE

2

Source:

(static, readonly) WRITE_SYNCHRONIZATION_MODE

Properties:
Name Type Description
FULL_SYNC

0

FULL_ASYNC

1

PRIMARY_SYNC

2

Source:

Methods

getAtomicityMode() → {CacheConfiguration.CACHE_ATOMICITY_MODE}

Source:
Returns:
Type
CacheConfiguration.CACHE_ATOMICITY_MODE

getBackups() → {number}

Source:
Returns:
Type
number

getCacheMode() → {CacheConfiguration.CACHE_MODE}

Source:
Returns:
Type
CacheConfiguration.CACHE_MODE

getCopyOnRead() → {boolean}

Source:
Returns:
Type
boolean

getDataRegionName() → {string}

Source:
Returns:
Type
string

getDefaultLockTimeout() → {number}

Source:
Returns:
Type
number

getEagerTtl() → {boolean}

Source:
Returns:
Type
boolean

getGroupName() → {string}

Source:
Returns:
Type
string

getIsOnheapCacheEnabled() → {boolean}

Source:
Returns:
Type
boolean

getKeyConfigurations() → {Array.<CacheKeyConfiguration>}

Source:
Returns:
Type
Array.<CacheKeyConfiguration>

getMaxConcurrentAsyncOperations() → {number}

Source:
Returns:
Type
number

getMaxQueryIterators() → {number}

Source:
Returns:
Type
number

getPartitionLossPolicy() → {CacheConfiguration.PARTITION_LOSS_POLICY}

Source:
Returns:
Type
CacheConfiguration.PARTITION_LOSS_POLICY

getQueryDetailMetricsSize() → {number}

Source:
Returns:
Type
number

getQueryEntities() → {Array.<QueryEntity>}

Source:
Returns:
Type
Array.<QueryEntity>

getQueryParallelism() → {number}

Source:
Returns:
Type
number

getReadFromBackup() → {boolean}

Source:
Returns:
Type
boolean

getRebalanceBatchesPrefetchCount() → {number}

Source:
Returns:
Type
number

getRebalanceBatchSize() → {number}

Source:
Returns:
Type
number

getRebalanceDelay() → {number}

Source:
Returns:
Type
number

getRebalanceMode() → {CacheConfiguration.REABALANCE_MODE}

Source:
Returns:
Type
CacheConfiguration.REABALANCE_MODE

getRebalanceOrder() → {number}

Source:
Returns:
Type
number

getRebalanceThrottle() → {number}

Source:
Returns:
Type
number

getRebalanceTimeout() → {number}

Source:
Returns:
Type
number

getSqlEscapeAll() → {boolean}

Source:
Returns:
Type
boolean

getSqlIndexInlineMaxSize() → {number}

Source:
Returns:
Type
number

getSqlSchema() → {string}

Source:
Returns:
Type
string

getStatisticsEnabled() → {boolean}

Source:
Returns:
Type
boolean

getWriteSynchronizationMode() → {CacheConfiguration.WRITE_SYNCHRONIZATION_MODE}

Source:
Returns:
Type
CacheConfiguration.WRITE_SYNCHRONIZATION_MODE

setAtomicityMode(atomicityMode) → {CacheConfiguration}

Parameters:
Name Type Description
atomicityMode CacheConfiguration.CACHE_ATOMICITY_MODE
Source:
Throws:

if error.

Type
IgniteClientError
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setBackups(backups) → {CacheConfiguration}

Parameters:
Name Type Description
backups number
Source:
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setCacheMode(cacheMode) → {CacheConfiguration}

Parameters:
Name Type Description
cacheMode CacheConfiguration.CACHE_MODE
Source:
Throws:

if error.

Type
IgniteClientError
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setCopyOnRead(copyOnRead) → {CacheConfiguration}

Parameters:
Name Type Description
copyOnRead boolean
Source:
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setDataRegionName(dataRegionName) → {CacheConfiguration}

Parameters:
Name Type Description
dataRegionName string
Source:
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setDefaultLockTimeout(lockTimeout) → {CacheConfiguration}

Parameters:
Name Type Description
lockTimeout number
Source:
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setEagerTtl(eagerTtl) → {CacheConfiguration}

Parameters:
Name Type Description
eagerTtl boolean
Source:
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setGroupName(groupName) → {CacheConfiguration}

Parameters:
Name Type Description
groupName string
Source:
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setIsOnheapCacheEnabled(isOnheapCacheEnabled) → {CacheConfiguration}

Parameters:
Name Type Description
isOnheapCacheEnabled boolean
Source:
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setKeyConfigurations(…keyConfigurations) → {CacheConfiguration}

Parameters:
Name Type Attributes Description
keyConfigurations CacheKeyConfiguration <repeatable>
Source:
Throws:

if error.

Type
IgniteClientError
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setMaxConcurrentAsyncOperations(maxConcurrentAsyncOperations) → {CacheConfiguration}

Parameters:
Name Type Description
maxConcurrentAsyncOperations number
Source:
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setMaxQueryIterators(maxQueryIterators) → {CacheConfiguration}

Parameters:
Name Type Description
maxQueryIterators number
Source:
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setPartitionLossPolicy(partitionLossPolicy) → {CacheConfiguration}

Parameters:
Name Type Description
partitionLossPolicy CacheConfiguration.PARTITION_LOSS_POLICY
Source:
Throws:

if error.

Type
IgniteClientError
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setQueryDetailMetricsSize(queryDetailMetricsSize) → {CacheConfiguration}

Parameters:
Name Type Description
queryDetailMetricsSize number
Source:
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setQueryEntities(…queryEntities) → {CacheConfiguration}

Parameters:
Name Type Attributes Description
queryEntities QueryEntity <repeatable>
Source:
Throws:

if error.

Type
IgniteClientError
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setQueryParallelism(queryParallelism) → {CacheConfiguration}

Parameters:
Name Type Description
queryParallelism number
Source:
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setReadFromBackup(readFromBackup) → {CacheConfiguration}

Parameters:
Name Type Description
readFromBackup boolean
Source:
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setRebalanceBatchesPrefetchCount(rebalanceBatchesPrefetchCount) → {CacheConfiguration}

Parameters:
Name Type Description
rebalanceBatchesPrefetchCount number
Source:
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setRebalanceBatchSize(rebalanceBatchSize) → {CacheConfiguration}

Parameters:
Name Type Description
rebalanceBatchSize number
Source:
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setRebalanceDelay(rebalanceDelay) → {CacheConfiguration}

Parameters:
Name Type Description
rebalanceDelay number
Source:
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setRebalanceMode(rebalanceMode) → {CacheConfiguration}

Parameters:
Name Type Description
rebalanceMode CacheConfiguration.REABALANCE_MODE
Source:
Throws:

if error.

Type
IgniteClientError
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setRebalanceOrder(rebalanceOrder) → {CacheConfiguration}

Parameters:
Name Type Description
rebalanceOrder number
Source:
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setRebalanceThrottle(rebalanceThrottle) → {CacheConfiguration}

Parameters:
Name Type Description
rebalanceThrottle number
Source:
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setRebalanceTimeout(rebalanceTimeout) → {CacheConfiguration}

Parameters:
Name Type Description
rebalanceTimeout number
Source:
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setSqlEscapeAll(sqlEscapeAll) → {CacheConfiguration}

Parameters:
Name Type Description
sqlEscapeAll boolean
Source:
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setSqlIndexInlineMaxSize(sqlIndexInlineMaxSize) → {CacheConfiguration}

Parameters:
Name Type Description
sqlIndexInlineMaxSize number
Source:
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setSqlSchema(sqlSchema) → {CacheConfiguration}

Parameters:
Name Type Description
sqlSchema string
Source:
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setStatisticsEnabled(statisticsEnabled) → {CacheConfiguration}

Parameters:
Name Type Description
statisticsEnabled boolean
Source:
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration

setWriteSynchronizationMode(writeSynchronizationMode) → {CacheConfiguration}

Parameters:
Name Type Description
writeSynchronizationMode CacheConfiguration.WRITE_SYNCHRONIZATION_MODE
Source:
Throws:

if error.

Type
IgniteClientError
Returns:
  • the same instance of the CacheConfiguration.
Type
CacheConfiguration