Skip to end of metadata
Go to start of metadata

Infinispan Cache Translator

The Infinispan translator, known by the name of infinispan-cache, is a bridge for reading and writing java objects to/from an Infinispan/JDG Cache.  This translator extends the Object Translator and uses it for the core processing of reading and writing objects. The Infinispan Cache Translator is written so that it can control how the cache is searched and any capabilities that are needed to control that behavior.

Searching Capabilities

Supports the options for using either DSL searching (JDG 6.3+), Hibernate/Lucene searching (now deprecated), or Key searching (when no indexing is used). See the jdg-local-cache quick start for an example. Note, this assumes you will be installing JDG into the same server installation, running in library mode.


The infinispan-cache translator is not configured, out-of-the-box, in the standalone-teiid.xml configuration. To configure the translator, run the add-infinispan-cache-translator.cli script. This script can also be found in the kit, under docs/teiid/datasources/infinispan.

Execution Properties

Name Description Required Default
SupportsLuceneSearching Setting to true assumes your objects are annotated and Hibernate/Lucene will be used to search the cache No false
SupportsDSLSearching Setting to true assumes your are using JDG v6.3 or better and your cache has indexing enabled No false
SupportsIsNullCriteria Setting to true assumes has been resolved No false
SupportsCompareCriteriaOrdered Setting to true assumes has been resolved No false
SupportsNotCriteria Setting to true assumes has been resolved No false

SupportsNotCriteria defaults to false because the testing of column <> 1 returns true when the column is null, which isn't correct by SQL standards - see There is an enhancement coming that will enable adding "column IS NOT NULL" when column <> 1 type criteria is detected.

SupportsIsNullCriteria defaults to false because Infinispan/JDG has an issue with issuing a IS NULL check on a numeric type attribute - see Set this to true if you need this check and can control which non-numeric columns that this will be issued against.

SupportsCompareCriteriaOrdered defaults to false because the Infinispan/JDG has an issue with string comparisons - see

Supported Capabilities

The following are the connector capabilities when Key Searching is used:

  • SELECT command
  • CompareCriteria - only EQ
  • InCriteria

The following are the connector capabilities when DSL Searching is enabled:

  • SELECT command
  • CompareCriteria - EQ, NE
  • CompareCriteria - GT, LT, GE, and LE can be enabled, see Execution Properties
  • And/Or Criteria
  • In Criteria
  • Like Criteria
  • Or Criteria
  • IsNull check - see Execution Properties
  • Not (negation) - example: Not In, Not Like


  • Retrieve objects from a cache and transform into rows and columns.
  • Perform writes to the cache


Definition Requirements
  • The table for the root class, must have a primary key defined, which must map to an attribute in the class.
  • The table "name in source" (NIS) will be the name of the cache this table/class is stored
  • The primary object that represents the cached object should have a name in source of 'this'.  All other columns will have their name in source (which defaults to the column name) interpreted as the path to the column value from the primary object.
  • All columns that are not the primary key nor covered by a lucene index should be marked as SEARCHABLE 'Unsearchable'.
  • Attributes defined as repeatable (i.e., collections, arrays, etc.) or a container class, will be supported as 1-to-* relationships, and will have corresponding registered class (if they are to be searched).
  • A 1-to-* relationship class must have a foreign key to map to the root class/table, where the name in source for the foreign key is the name of the root class method to access those child objects. Note, this is the class method, not a reference in the google protobuf definition.
  • Dynamic VDBs using metadata import will automatically build the physical table for the root object and will have each top level member represented as a column.
Options for Defining

The following is an example of a key search and a view that associated player names with their team. It uses a dynamic vdb to define the physical source and views using DDL.   It uses a TeamObject class, shown below, with a teamName field that is used as its cache key and a String list of players. 

Note that by just using a dynamic vdb, the native import logic will provide you with a TeamObject physical table that can be queried. An equivalent Team table is shown here for demonstration purposes.

Notice the use of the [OBJECTABLE] function to parse the object from Team and transform into rows and column. This is only for demonstration purposes, and is not required in order to parse the object into rows and columns.

This metadata could also be defined by using the Teiid Designer Teiid Connection Importer.

JCA Resource Adapter

See the Infinispan Datasources resource adapter for this translator.   It can be configured to lookup the cache container via JNDI or created (i.e., ConfigurationFileName (deprecated) or RemoteServerList). 

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.