urn:infinispan:config:jdbc:6.0

stringKeyedJdbcStore

Name Type Default Description
key2StringMapper string The class name of a Key2StringMapper to use when mapping keys to strings to be used in the database tables

stringKeyedTable

Defines the table used to store cache entries

Name Type Default Description
prefix string ispn_entry Defines the prefix prepended to the cache name used when composing the name of the cache entry table.
Name Type Default Description
createOnStart boolean false Determines whether database tables should be created by the store on startup.
dropOnExit boolean false Determines whether database tables should be dropped by the store on shutdown.
fetchSize int 100 The fetch size used when querying from this table. Used to avoid heap memory exhaustion when query is large.
batchSize int 100 The statement batch size used when modifying this table.

idColumn?

Defines the column in which to store the cache key or bucket id.

Name Type Default Description
name string id The name of the column used to store the cache key or bucket id.
type string VARCHAR The type of the column used to store the cache key or bucket id.

dataColumn?

Defines the column in which to store the cache entry or bucket.

Name Type Default Description
name string datum The name of the column used to store the cache entry or bucket.
type string BINARY The type of the column used to store the cache entry or bucket.

timestampColumn?

Defines the column in which to store the timestamp of the cache entry or bucket.

Name Type Default Description
name string version The name of the column used to store the cache entry or bucket timestamp.
type string BIGINT The type of the column used to store the cache entry or bucket timestamp.
Name Type Default Description
lockAcquisitionTimeout long 60000 Maximum time to attempt a particular lock acquisition
concurrencyLevel int 2048 Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan. Similar to the concurrencyLevel tuning parameter seen in the JDK's ConcurrentHashMap.
Name Type Default Description
fetchPersistentState boolean false If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled. Persistent state transfer with a shared cache store does not make sense, as the same persistent store that provides the data will just end up receiving it. Therefore, if a shared cache store is used, the cache will not allow a persistent state transfer even if a cache store has this property set to true. Finally, setting it to true only makes sense if in a clustered environment, and only 'replication' and 'invalidation' cluster modes are supported. Defaults to false.
ignoreModifications boolean false If true, any operation that modifies the cache (put, remove, clear, store...etc) won't be applied to the cache store. This means that the cache store could become out of sync with the cache. Defaults to false.
purgeOnStartup boolean false If true, purges this cache store when it starts up. Defaults to false.
purgeSynchronously boolean false If true, CacheStore#purgeExpired() call will be done synchronously. Defaults to false.
purgerThreads int 1 The number of threads to use when purging asynchronously. Defaults to 1 thread.

async?

Configuration for the async cache loader. If enabled, this provides you with asynchronous writes to the cache store, giving you 'write-behind' caching.

Name Type Default Description
enabled boolean false If true, all modifications to this cache store happen asynchronously, on a separate thread.
flushLockTimeout long 1 Timeout to acquire the lock which guards the state to be flushed to the cache store periodically. Defaults to 1.
modificationQueueSize int 1024 Sets the size of the modification queue for the async store. If updates are made at a rate that is faster than the underlying cache store can process this queue, then the async store behaves like a synchronous store for that period, blocking until the queue can accept more elements. Defaults to 1024 elements.
shutdownTimeout long 25000 Timeout to stop the cache store. When the store is stopped it's possible that some modifications still need to be applied; you likely want to set a very large timeout to make sure to not loose data. Defaults to 25 seconds.
threadPoolSize int 1 Size of the thread pool whose threads are responsible for applying the modifications. Defaults to 1.

singletonStore?

SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. The coordinator of the cluster will be responsible for the underlying CacheStore. SingletonStore is a simply facade to a real CacheStore implementation. It always delegates reads to the real CacheStore.

Name Type Default Description
pushStateTimeout long 10000 If pushStateWhenCoordinator is true, this property sets the maximum number of milliseconds that the process of pushing the in-memory state to the underlying cache loader should take. Defaults to 10 seconds.
pushStateWhenCoordinator boolean true If true, when a node becomes the coordinator, it will transfer in-memory state to the underlying cache store. This can be very useful in situations where the coordinator crashes and there's a gap in time until the new coordinator is elected. Defaults to true.
enabled boolean false If true, the singleton store cache store is enabled. Defaults to false.

properties?

Properties passed to the cache store or loader

property*

Name Type Default Description
name string The property name or key
value string The property value

binaryKeyedJdbcStore

binaryKeyedTable

Defines the table used to store cache entries

Name Type Default Description
prefix string Defines the prefix prepended to the cache name used when composing the name of the cache bucket table.
Name Type Default Description
createOnStart boolean false Determines whether database tables should be created by the store on startup.
dropOnExit boolean false Determines whether database tables should be dropped by the store on shutdown.
fetchSize int 100 The fetch size used when querying from this table. Used to avoid heap memory exhaustion when query is large.
batchSize int 100 The statement batch size used when modifying this table.

idColumn?

Defines the column in which to store the cache key or bucket id.

Name Type Default Description
name string id The name of the column used to store the cache key or bucket id.
type string VARCHAR The type of the column used to store the cache key or bucket id.

dataColumn?

Defines the column in which to store the cache entry or bucket.

Name Type Default Description
name string datum The name of the column used to store the cache entry or bucket.
type string BINARY The type of the column used to store the cache entry or bucket.

timestampColumn?

Defines the column in which to store the timestamp of the cache entry or bucket.

Name Type Default Description
name string version The name of the column used to store the cache entry or bucket timestamp.
type string BIGINT The type of the column used to store the cache entry or bucket timestamp.
Name Type Default Description
lockAcquisitionTimeout long 60000 Maximum time to attempt a particular lock acquisition
concurrencyLevel int 2048 Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan. Similar to the concurrencyLevel tuning parameter seen in the JDK's ConcurrentHashMap.
Name Type Default Description
fetchPersistentState boolean false If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled. Persistent state transfer with a shared cache store does not make sense, as the same persistent store that provides the data will just end up receiving it. Therefore, if a shared cache store is used, the cache will not allow a persistent state transfer even if a cache store has this property set to true. Finally, setting it to true only makes sense if in a clustered environment, and only 'replication' and 'invalidation' cluster modes are supported. Defaults to false.
ignoreModifications boolean false If true, any operation that modifies the cache (put, remove, clear, store...etc) won't be applied to the cache store. This means that the cache store could become out of sync with the cache. Defaults to false.
purgeOnStartup boolean false If true, purges this cache store when it starts up. Defaults to false.
purgeSynchronously boolean false If true, CacheStore#purgeExpired() call will be done synchronously. Defaults to false.
purgerThreads int 1 The number of threads to use when purging asynchronously. Defaults to 1 thread.

async?

Configuration for the async cache loader. If enabled, this provides you with asynchronous writes to the cache store, giving you 'write-behind' caching.

Name Type Default Description
enabled boolean false If true, all modifications to this cache store happen asynchronously, on a separate thread.
flushLockTimeout long 1 Timeout to acquire the lock which guards the state to be flushed to the cache store periodically. Defaults to 1.
modificationQueueSize int 1024 Sets the size of the modification queue for the async store. If updates are made at a rate that is faster than the underlying cache store can process this queue, then the async store behaves like a synchronous store for that period, blocking until the queue can accept more elements. Defaults to 1024 elements.
shutdownTimeout long 25000 Timeout to stop the cache store. When the store is stopped it's possible that some modifications still need to be applied; you likely want to set a very large timeout to make sure to not loose data. Defaults to 25 seconds.
threadPoolSize int 1 Size of the thread pool whose threads are responsible for applying the modifications. Defaults to 1.

singletonStore?

SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. The coordinator of the cluster will be responsible for the underlying CacheStore. SingletonStore is a simply facade to a real CacheStore implementation. It always delegates reads to the real CacheStore.

Name Type Default Description
pushStateTimeout long 10000 If pushStateWhenCoordinator is true, this property sets the maximum number of milliseconds that the process of pushing the in-memory state to the underlying cache loader should take. Defaults to 10 seconds.
pushStateWhenCoordinator boolean true If true, when a node becomes the coordinator, it will transfer in-memory state to the underlying cache store. This can be very useful in situations where the coordinator crashes and there's a gap in time until the new coordinator is elected. Defaults to true.
enabled boolean false If true, the singleton store cache store is enabled. Defaults to false.

properties?

Properties passed to the cache store or loader

property*

Name Type Default Description
name string The property name or key
value string The property value

mixedKeyedJdbcStore

Name Type Default Description
key2StringMapper string The class name of a Key2StringMapper to use when mapping keys to strings to be used in the database tables

binaryKeyedTable?

Defines the table used to store cache buckets.

Name Type Default Description
prefix string Defines the prefix prepended to the cache name used when composing the name of the cache bucket table.
Name Type Default Description
createOnStart boolean false Determines whether database tables should be created by the store on startup.
dropOnExit boolean false Determines whether database tables should be dropped by the store on shutdown.
fetchSize int 100 The fetch size used when querying from this table. Used to avoid heap memory exhaustion when query is large.
batchSize int 100 The statement batch size used when modifying this table.

idColumn?

Defines the column in which to store the cache key or bucket id.

Name Type Default Description
name string id The name of the column used to store the cache key or bucket id.
type string VARCHAR The type of the column used to store the cache key or bucket id.

dataColumn?

Defines the column in which to store the cache entry or bucket.

Name Type Default Description
name string datum The name of the column used to store the cache entry or bucket.
type string BINARY The type of the column used to store the cache entry or bucket.

timestampColumn?

Defines the column in which to store the timestamp of the cache entry or bucket.

Name Type Default Description
name string version The name of the column used to store the cache entry or bucket timestamp.
type string BIGINT The type of the column used to store the cache entry or bucket timestamp.

stringKeyedTable?

Defines the table used to store cache entries.

Name Type Default Description
prefix string ispn_entry Defines the prefix prepended to the cache name used when composing the name of the cache entry table.
Name Type Default Description
createOnStart boolean false Determines whether database tables should be created by the store on startup.
dropOnExit boolean false Determines whether database tables should be dropped by the store on shutdown.
fetchSize int 100 The fetch size used when querying from this table. Used to avoid heap memory exhaustion when query is large.
batchSize int 100 The statement batch size used when modifying this table.

idColumn?

Defines the column in which to store the cache key or bucket id.

Name Type Default Description
name string id The name of the column used to store the cache key or bucket id.
type string VARCHAR The type of the column used to store the cache key or bucket id.

dataColumn?

Defines the column in which to store the cache entry or bucket.

Name Type Default Description
name string datum The name of the column used to store the cache entry or bucket.
type string BINARY The type of the column used to store the cache entry or bucket.

timestampColumn?

Defines the column in which to store the timestamp of the cache entry or bucket.

Name Type Default Description
name string version The name of the column used to store the cache entry or bucket timestamp.
type string BIGINT The type of the column used to store the cache entry or bucket timestamp.
Name Type Default Description
lockAcquisitionTimeout long 60000 Maximum time to attempt a particular lock acquisition
concurrencyLevel int 2048 Concurrency level for lock containers. Adjust this value according to the number of concurrent threads interacting with Infinispan. Similar to the concurrencyLevel tuning parameter seen in the JDK's ConcurrentHashMap.
Name Type Default Description
fetchPersistentState boolean false If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled. Persistent state transfer with a shared cache store does not make sense, as the same persistent store that provides the data will just end up receiving it. Therefore, if a shared cache store is used, the cache will not allow a persistent state transfer even if a cache store has this property set to true. Finally, setting it to true only makes sense if in a clustered environment, and only 'replication' and 'invalidation' cluster modes are supported. Defaults to false.
ignoreModifications boolean false If true, any operation that modifies the cache (put, remove, clear, store...etc) won't be applied to the cache store. This means that the cache store could become out of sync with the cache. Defaults to false.
purgeOnStartup boolean false If true, purges this cache store when it starts up. Defaults to false.
purgeSynchronously boolean false If true, CacheStore#purgeExpired() call will be done synchronously. Defaults to false.
purgerThreads int 1 The number of threads to use when purging asynchronously. Defaults to 1 thread.

async?

Configuration for the async cache loader. If enabled, this provides you with asynchronous writes to the cache store, giving you 'write-behind' caching.

Name Type Default Description
enabled boolean false If true, all modifications to this cache store happen asynchronously, on a separate thread.
flushLockTimeout long 1 Timeout to acquire the lock which guards the state to be flushed to the cache store periodically. Defaults to 1.
modificationQueueSize int 1024 Sets the size of the modification queue for the async store. If updates are made at a rate that is faster than the underlying cache store can process this queue, then the async store behaves like a synchronous store for that period, blocking until the queue can accept more elements. Defaults to 1024 elements.
shutdownTimeout long 25000 Timeout to stop the cache store. When the store is stopped it's possible that some modifications still need to be applied; you likely want to set a very large timeout to make sure to not loose data. Defaults to 25 seconds.
threadPoolSize int 1 Size of the thread pool whose threads are responsible for applying the modifications. Defaults to 1.

singletonStore?

SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store. The coordinator of the cluster will be responsible for the underlying CacheStore. SingletonStore is a simply facade to a real CacheStore implementation. It always delegates reads to the real CacheStore.

Name Type Default Description
pushStateTimeout long 10000 If pushStateWhenCoordinator is true, this property sets the maximum number of milliseconds that the process of pushing the in-memory state to the underlying cache loader should take. Defaults to 10 seconds.
pushStateWhenCoordinator boolean true If true, when a node becomes the coordinator, it will transfer in-memory state to the underlying cache store. This can be very useful in situations where the coordinator crashes and there's a gap in time until the new coordinator is elected. Defaults to true.
enabled boolean false If true, the singleton store cache store is enabled. Defaults to false.

properties?

Properties passed to the cache store or loader

property*

Name Type Default Description
name string The property name or key
value string The property value
Expand/Collapse All