JBoss EAP 7.1 Model Reference

Deprecated Since 5.0.0

Deprecated. Will be removed without replacement in a future release. Use store=jdbc instead.

The cache JDBC store configuration.

Children (3)

property A cache store property with name and value.
table Defines a table used to store persistent cache data.

binary Defines a table used to store cache entries whose keys cannot be expressed as strings.
string Defines a table used to store cache entries whose keys can be expressed as strings.

write The write behavior of the cache store.

behind Configures a cache store as write-behind instead of write-through.
through Configures a cache store as write-through.

Provided capabilities(1)

Name	Dynamic	Other provider points
org.wildfly.clustering.infinispan.cache.store	true	/subsystem=infinispan/cache-container=/invalidation-cache=/store=remote /subsystem=infinispan/cache-container=/invalidation-cache=/store=file /subsystem=infinispan/cache-container=/replicated-cache=/store=binary-jdbc /subsystem=infinispan/cache-container=/replicated-cache=/store=file /subsystem=infinispan/cache-container=/invalidation-cache=/store=custom /subsystem=infinispan/cache-container=/local-cache=/store=binary-jdbc /subsystem=infinispan/cache-container=/local-cache=/store=mixed-jdbc /subsystem=infinispan/cache-container=/local-cache=/store=custom /subsystem=infinispan/cache-container=/distributed-cache=/store=mixed-jdbc /subsystem=infinispan/cache-container=/replicated-cache=/store=custom /subsystem=infinispan/cache-container=/local-cache=/store=remote /subsystem=infinispan/cache-container=/distributed-cache=/store=remote /subsystem=infinispan/cache-container=/invalidation-cache=/store=jdbc /subsystem=infinispan/cache-container=/distributed-cache=/store=binary-jdbc /subsystem=infinispan/cache-container=/invalidation-cache=/store=binary-jdbc /subsystem=infinispan/cache-container=/distributed-cache=/store=jdbc /subsystem=infinispan/cache-container=/distributed-cache=/store=custom /subsystem=infinispan/cache-container=/distributed-cache=/store=file /subsystem=infinispan/cache-container=/replicated-cache=/store=jdbc /subsystem=infinispan/cache-container=/local-cache=/store=file /subsystem=infinispan/cache-container=/replicated-cache=/store=mixed-jdbc /subsystem=infinispan/cache-container=/replicated-cache=/store=remote /subsystem=infinispan/cache-container=/local-cache=/store=jdbc

Attributes (14)

binary-keyed-table Defines a table used to store cache entries whose keys cannot be expressed as strings.

Deprecated Since 4.0.0

Deprecated. Use table=binary child resource.

Attribute	Value
Type	OBJECT
Nillable	true
Expressions Allowed	false
Storage	configuration
Access Type	read-write
Restart Required	no-services

cache-loader-loads The number of cache loader node loads. May return null if the cache is not started.

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

cache-loader-misses The number of cache loader node misses. May return null if the cache is not started.

Attribute	Value
Type	LONG
Nillable	true
Expressions Allowed	false
Storage	runtime
Access Type	read-only

data-source References the data source used to connect to this store.

Attribute	Value
Capability reference	/subsystem=datasources/xa-data-source=* /subsystem=datasources/data-source=*
Type	STRING
Nillable	true
Expressions Allowed	false
Storage	configuration
Access Type	read-write
Restart Required	resource-services

datasource The jndi name of the data source used to connect to this store.

Deprecated Since 4.0.0

Deprecated. Replaced by data-source.

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services

dialect The dialect of this datastore.

Attribute	Value
Type	STRING
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services
Allowed Values	MARIA_DB MYSQL POSTGRES DERBY HSQL H2 SQLITE DB2 DB2_390 INFORMIX INTERBASE FIREBIRD SQL_SERVER ACCESS ORACLE SYBASE

fetch-state If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.

Attribute	Value
Default Value	true
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services

passivation If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.

Attribute	Value
Default Value	true
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services

preload If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.

Attribute	Value
Default Value	false
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services

properties A list of cache store properties.

Attribute	Value
Type	OBJECT
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services

purge If true, purges this cache store when it starts up.

Attribute	Value
Default Value	true
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services

shared This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.

Attribute	Value
Default Value	false
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services

singleton If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.

Deprecated Since 5.0.0

Deprecated. Consider using a shared store instead, where writes are only performed by primary owners.

Attribute	Value
Default Value	false
Type	BOOLEAN
Nillable	true
Expressions Allowed	true
Storage	configuration
Access Type	read-write
Restart Required	resource-services

string-keyed-table Defines a table used to store persistent cache entries.

Deprecated Since 4.0.0

Deprecated. Use table=string child resource.

Attribute	Value
Type	OBJECT
Nillable	true
Expressions Allowed	false
Storage	configuration
Access Type	read-write
Restart Required	no-services

Operations (2)

add Adds a JDBC cache store configuration element to the cache.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
data-source	STRING	true	false		References the data source used to connect to this store.
dialect	STRING	false	true		The dialect of this datastore.
fetch-state	BOOLEAN	false	true	true	If true, fetch persistent state when joining a cluster. If multiple cache stores are chained, only one of them can have this property enabled.
passivation	BOOLEAN	false	true	true	If true, data is only written to the cache store when it is evicted from memory, a phenomenon known as 'passivation'. Next time the data is requested, it will be 'activated' which means that data will be brought back to memory and removed from the persistent store. If false, the cache store contains a copy of the contents in memory, so writes to cache result in cache store writes. This essentially gives you a 'write-through' configuration.
preload	BOOLEAN	false	true	false	If true, when the cache starts, data stored in the cache store will be pre-loaded into memory. This is particularly useful when data in the cache store will be needed immediately after startup and you want to avoid cache operations being delayed as a result of loading this data lazily. Can be used to provide a 'warm-cache' on startup, however there is a performance penalty as startup time is affected by this process.
purge	BOOLEAN	false	true	true	If true, purges this cache store when it starts up.
shared	BOOLEAN	false	true	false	This setting should be set to true when multiple cache instances share the same cache store (e.g., multiple nodes in a cluster using a JDBC-based CacheStore pointing to the same, shared database.) Setting this to true avoids multiple cache instances writing the same modification multiple times. If enabled, only the node where the modification originated will write to the cache store. If disabled, each individual cache reacts to a potential remote update by storing the data to the cache store.
singleton	BOOLEAN	false	true	false	If true, the singleton store cache store is enabled. SingletonStore is a delegating cache store used for situations when only one instance in a cluster should interact with the underlying store.
properties	OBJECT	false	true		A list of cache store properties.
binary-keyed-table	OBJECT	false	false		Defines a table used to store cache entries whose keys cannot be expressed as strings.
string-keyed-table	OBJECT	false	false		Defines a table used to store persistent cache entries.
datasource	STRING	false	true		The jndi name of the data source used to connect to this store.

remove Removes a JDBC cache store configuration element to the cache.