urn:infinispan:config:store:sql:13.0

table-jdbc-store

NameTypeDefaultDescription
table-namestring Specifies a database table that loads entries to the cache and stores data from the cache. The SQL cache store automatically generates statements based on the database dialect to perform all operations. Every field in the schema must be readable from the columns in the database table. If the SQL cache store does not allow modifications to the database, is read only, then tables can have more columns than the schema defines.

schema

NameTypeDefaultDescription
message-namestring Specifies the Protobuf message name to use for the value of the cache entry. If the database table contains only one column for the value, you do not need to specify a message name and an appropriate data type is automatically used.
key-message-namestring Specifies the Protobuf message name to use for the key of the cache entry. If the database table contains only one column for the key, you do not need to specify a message name and an appropriate data type is automatically used.
packagestring Specifies the package for key and value message names. You must specify a package if you set the 'key-message-name' or 'message-name' attributes.
embedded-keybooleanfalse Specifies if key field(s) are also part of the value schema.
NameTypeDefaultDescription
dialect
ACCESS
DB2
DB2_390
DERBY
FIREBIRD
H2
HSQL
INFORMIX
INTERBASE
MARIA_DB
MYSQL
ORACLE
POSTGRES
SQL_SERVER
SQLITE
SYBASE
Specifies the JDBC dialect of the database.
db-major-versionnonNegativeIntegerSpecifies the major version of the database.
db-minor-versionnonNegativeIntegerSpecifies the minor version of the database.
read-query-timeoutnonNegativeIntegerDefines the timeout, in seconds, for read queries. The default is 0 which indicates no timeout.
write-query-timeoutnonNegativeIntegerDefines the timeout, in seconds, for write queries. The default is 0 which indicates no timeout.

connection-pool

NameTypeDefaultDescription
properties-filestring Sets the path of a properties file that provides additional configuration for the connection pool.
connection-urlstring Sets a connection url specific to a JDBC driver.
driverstring Specifies the class name of the driver that connects to the database.
passwordstring Specifies the password for the database connection.
usernamestring Specifies the username for the database connection.

data-source

NameTypeDefaultDescription
jndi-urlstring Specifies the address of a datasource for the JDBC connection.

simple-connection

NameTypeDefaultDescription
connection-urlstring Sets a connection url specific to a JDBC driver.
driverstring Specifies the class name of the driver that connects to the database.
passwordstring Specifies the password for the database connection.
usernamestring Specifies the username for the database connection.

query-jdbc-store

NameTypeDefaultDescription
key-columnsstring Specifies the columns from the database table that correspond to key(s). Use commas (,) to separate multiple columns.

queries

NameTypeDefaultDescription
select-allstring Defines a SQL query that bulk loads cache entries from a database. You can use an asterisk operator in the SELECT clause. You can use parameters only if you explicitly define them in the statement, for example "WHERE FOO = 'BAR'"". Columns that this query returns must match the columns that the 'select-single' query returns. Columns must also match Protobuf schema for composite keys and values exactly.
select-singlestring Defines a SQL query that loads cache entries from a database. You can use an asterisk operator in the SELECT clause. You must include every field from the key schema as a named parameter, for example "FOO = :bar". Columns that this query returns must match the columns that the 'select-all' query returns. Columns must also match Protobuf schema for composite keys and values exactly.
delete-allstring Defines a SQL query to clear the cache. This attribute is required if you configure the SQL cache store to allow modifications to the database. You can use parameters only if you explicitly define them in the statement, for example "WHERE FOO = 'BAR'"".
delete-singlestring Defines a SQL query to delete specific entries from the cache. This attribute is required if you configure the SQL cache store to allow modifications to the database. You must include every field from the key schema as a named parameter, for example "FOO = :bar".
upsertstring Defines a SQL query to modify entries in the cache. This attribute is required if you configure the SQL cache store to allow modifications to the database. You must include every field from the key and value schema as a named parameter, for example "FOO = :bar".
sizestring Defines a SQL query to count the number of entries in the cache. You can use parameters only if you explicitly define them in the statement, for example "WHERE FOO = 'BAR'"".

schema

NameTypeDefaultDescription
message-namestring Specifies the Protobuf message name to use for the value of the cache entry. If the database table contains only one column for the value, you do not need to specify a message name and an appropriate data type is automatically used.
key-message-namestring Specifies the Protobuf message name to use for the key of the cache entry. If the database table contains only one column for the key, you do not need to specify a message name and an appropriate data type is automatically used.
packagestring Specifies the package for key and value message names. You must specify a package if you set the 'key-message-name' or 'message-name' attributes.
embedded-keybooleanfalse Specifies if key field(s) are also part of the value schema.
NameTypeDefaultDescription
dialect
ACCESS
DB2
DB2_390
DERBY
FIREBIRD
H2
HSQL
INFORMIX
INTERBASE
MARIA_DB
MYSQL
ORACLE
POSTGRES
SQL_SERVER
SQLITE
SYBASE
Specifies the JDBC dialect of the database.
db-major-versionnonNegativeIntegerSpecifies the major version of the database.
db-minor-versionnonNegativeIntegerSpecifies the minor version of the database.
read-query-timeoutnonNegativeIntegerDefines the timeout, in seconds, for read queries. The default is 0 which indicates no timeout.
write-query-timeoutnonNegativeIntegerDefines the timeout, in seconds, for write queries. The default is 0 which indicates no timeout.

connection-pool

NameTypeDefaultDescription
properties-filestring Sets the path of a properties file that provides additional configuration for the connection pool.
connection-urlstring Sets a connection url specific to a JDBC driver.
driverstring Specifies the class name of the driver that connects to the database.
passwordstring Specifies the password for the database connection.
usernamestring Specifies the username for the database connection.

data-source

NameTypeDefaultDescription
jndi-urlstring Specifies the address of a datasource for the JDBC connection.

simple-connection

NameTypeDefaultDescription
connection-urlstring Sets a connection url specific to a JDBC driver.
driverstring Specifies the class name of the driver that connects to the database.
passwordstring Specifies the password for the database connection.
usernamestring Specifies the username for the database connection.
Expand/Collapse All