Caching options:

This is list of options for caching:

These options are inside given virtual database configuration file. For example: postgresTest-vdb_1.conf. The filename depends on the name of the vdb → nameOfVdb.conf.

⚠️ Note: You can use SHIFT with mouse scroll to scroll horizontally!

Key	Requirements	Conf File field	Description	Possible values	Default
Enable Query Caching	- (Unlocks this section)	cacheEnabled	If query caching should be used disable and commit to change cache settings on the fly. Unlocks other options for caching.	Boolean	false
PCI/HIPAA Cache	-	pciHipaaCache	When enabled, no cached objects will actually be transmitted to the grid-cache, but the cache will be used to message invalidation requests. This is to avoid transmitting possible sensitive data across unencrypted connections, while maintaining cache synchronization integrity.	Boolean	false
Cache Type	-	cacheType	Cache subsystem to use	String	Hazelcast
Use soft references	-	cacheSoftValues	Use soft references for caching, highly advised	Boolean	true
Duplicate request tracking	-	preCacheTracking	Require duplicate requests before attempting to cache	Boolean	false
Max Expiry	-	cacheMaxExpiry	Cache Max Expiry (minute)	Long	5
Max Cached Objects	-	cacheObjectCount	Total number of cached objects allowed	Long	100000
Max Cached Size	Access type = Proxy	cacheObjectSize	Largest allowed cached object size in bytes	Long	64000000
Customize Query Cache Key	-	customKey	Customize the data used to build the cache key	Boolean	false
Exclude VDB Name	Customize Query Cache Key	excludeKeyVdb	Should virtual database name be excluded from the hash key?	Boolean	false
Exclude JDBC to DB User	Customize Query Cache Key	excludeKeyUser	Should connected database user be excluded from the hash key?	Boolean	false
Exclude DB Catalog	Customize Query Cache Key	excludeKeyCatalog	Should catalog be excluded from the query cache hash key?	Boolean	false
Exclude DB Schema	Customize Query Cache Key	excludeKeySchema	Should schema be excluded from the query cache hash key?	Boolean	false
Exclude SQL Comments	Customize Query Cache Key	excludeKeySqlComments	Should sql comments be excluded from the query cache hash key?	Boolean	false
Grid Cache Offload	PCI/HIPAA Cache = false	localCacheEnable	Use local heap caching to offload grid cache for optimal performance	Boolean	true
Cluster manager via cache	Cache Type = Hazelcast or Valkey/Redis/KeyDB	clusterCacheManager	Useful to provide a redundant central manager--do not use with only one manager	Boolean	false

Hazelcast

This is a Cache Type option, visible when it is set to Hazelcast, and it has given configuration items:

Key	Requirements	Conf File field	Description	Possible values	Default
API Cache Name	Hazelcast	gridCacheName	For interfaces that utilize a “named” cache interface, this is the name of the cache to use, i.e. Hazelcast.	String	-
Cache Configuration File	Hazelcast	cacheConfig	When supported, this is an external configuration file to configure the cache, i.e. a Hazelcast client or server XML configuration file.	String	-
Group ID	Hazelcast	cacheGroupId	When using a hazelcast, the hazelcast group id (optional).	String	-
Group Password	Hazelcast	cacheGroupPassword	When using a hazelcast, the name of the group password to use (optional).	String	-

Valkey/Redis/KeyDB

This is a Cache Type option, visible when it is set to Valkey/Redis/KeyDB, and it has given configuration items:

Key	Requirements	Conf File field	Description	Possible values	Default
Server	Valkey/Redis/KeyDB	gridServer	Server name/ip to connect to	String	-
Port	Valkey/Redis/KeyDB	gridPort	Server's port to connect to	Integer	0
Database Number	Valkey/Redis/KeyDB	databaseNumber	Redis database number (optional)	Integer	0
Cache Username	Valkey/Redis/KeyDB	gridUsername	If necessary cache username to use	String	-
Cache Password	Valkey/Redis/KeyDB	gridPassword	If necessary cache password to use	String	-