public abstract class CacheAbstractJdbcStore<K,V> extends Object implements CacheStore<K,V>, LifecycleAware
CacheStore
backed by JDBC.
Store works with database via SQL dialect. Ignite ships with dialects for most popular databases:
DB2Dialect
- dialect for IBM DB2 database.OracleDialect
- dialect for Oracle database.SQLServerDialect
- dialect for Microsoft SQL Server database.MySQLDialect
- dialect for Oracle MySQL database.H2Dialect
- dialect for H2 database.BasicJdbcDialect
- dialect for any database via plain JDBC.
setDataSource(DataSource)
setDialect(JdbcDialect)
setBatchSize(int)
)setMaximumPoolSize(int)
)setParallelLoadCacheMinimumThreshold(int)
)... CacheConfiguration ccfg = new CacheConfiguration<>(); // Configure cache store. ccfg.setCacheStoreFactory(new FactoryBuilder.SingletonFactory(ConfigurationSnippet.store())); ccfg.setReadThrough(true); ccfg.setWriteThrough(true); // Configure cache types metadata. ccfg.setTypeMetadata(ConfigurationSnippet.typeMetadata()); cfg.setCacheConfiguration(ccfg); ...
Modifier and Type | Class and Description |
---|---|
protected static class |
CacheAbstractJdbcStore.EntryMapping
Entry mapping description.
|
Modifier and Type | Field and Description |
---|---|
protected static String |
ATTR_CONN_PROP
Connection attribute property name.
|
protected Map<String,Map<Object,CacheAbstractJdbcStore.EntryMapping>> |
cacheMappings
Cache with entry mapping description.
|
protected DataSource |
dataSrc
Data source.
|
protected static int |
DFLT_BATCH_SIZE
Default batch size for put and remove operations.
|
protected static int |
DFLT_PARALLEL_LOAD_CACHE_MINIMUM_THRESHOLD
Default batch size for put and remove operations.
|
protected JdbcDialect |
dialect
Database dialect.
|
protected static Object[] |
EMPTY_COLUMN_VALUE
Empty column value.
|
protected IgniteLogger |
log
Auto-injected logger instance.
|
protected static int |
MAX_ATTEMPT_WRITE_COUNT
Max attempt write count.
|
Constructor and Description |
---|
CacheAbstractJdbcStore() |
Modifier and Type | Method and Description |
---|---|
protected abstract <R> R |
buildObject(String cacheName,
String typeName,
Collection<CacheTypeFieldMetadata> fields,
Map<String,Integer> loadColIdxs,
ResultSet rs)
Construct object from query result.
|
protected void |
closeConnection(Connection conn)
Closes connection.
|
protected Connection |
connection() |
void |
delete(Object key) |
void |
deleteAll(Collection<?> keys) |
protected void |
end(Connection conn,
Statement st)
Closes allocated resources depending on transaction status.
|
protected abstract Object |
extractParameter(String cacheName,
String typeName,
String fieldName,
Object obj)
Get field value from object for use as query parameter.
|
protected int |
fillKeyParameters(PreparedStatement stmt,
CacheAbstractJdbcStore.EntryMapping m,
Object key) |
protected int |
fillKeyParameters(PreparedStatement stmt,
int idx,
CacheAbstractJdbcStore.EntryMapping em,
Object key) |
protected void |
fillParameter(PreparedStatement stmt,
int i,
CacheTypeFieldMetadata field,
Object fieldVal)
Sets the value of the designated parameter using the given object.
|
protected int |
fillValueParameters(PreparedStatement stmt,
int idx,
CacheAbstractJdbcStore.EntryMapping em,
Object val) |
int |
getBatchSize()
Get maximum batch size for delete and delete operations.
|
protected Object |
getColumnValue(ResultSet rs,
int colIdx,
Class<?> type)
Retrieves the value of the designated column in the current row of this
ResultSet object and
will convert to the requested Java data type. |
DataSource |
getDataSource() |
JdbcDialect |
getDialect()
Get database dialect.
|
int |
getMaximumPoolSize()
Get Max workers thread count.
|
int |
getParallelLoadCacheMinimumThreshold()
Parallel load cache minimum row count threshold.
|
protected Ignite |
ignite() |
protected abstract Object |
keyTypeId(Object key)
Extract key type id from key object.
|
protected abstract Object |
keyTypeId(String type)
Extract key type id from key class name.
|
V |
load(K key) |
Map<K,V> |
loadAll(Iterable<? extends K> keys) |
void |
loadCache(IgniteBiInClosure<K,V> clo,
Object... args)
Loads all values from underlying persistent storage.
|
protected Connection |
openConnection(boolean autocommit)
Gets connection from a pool.
|
protected abstract void |
prepareBuilders(String cacheName,
Collection<CacheTypeMetadata> types)
Prepare internal store specific builders for provided types metadata.
|
protected JdbcDialect |
resolveDialect()
Perform dialect resolution.
|
protected CacheStoreSession |
session() |
void |
sessionEnd(boolean commit)
Tells store to commit or rollback a transaction depending on the value of the
'commit'
parameter. |
void |
setBatchSize(int batchSz)
Set maximum batch size for write and delete operations.
|
void |
setDataSource(DataSource dataSrc) |
void |
setDialect(JdbcDialect dialect)
Set database dialect.
|
void |
setMaximumPoolSize(int maxPoolSz)
Set Max workers thread count.
|
void |
setParallelLoadCacheMinimumThreshold(int parallelLoadCacheMinThreshold)
Parallel load cache minimum row count threshold.
|
protected static boolean |
simpleType(Class<?> cls)
Object is a simple type.
|
void |
start()
Starts grid component, called on grid start.
|
void |
stop()
Stops grid component, called on grid shutdown.
|
void |
write(javax.cache.Cache.Entry<? extends K,? extends V> entry) |
void |
writeAll(Collection<javax.cache.Cache.Entry<? extends K,? extends V>> entries) |
protected static final int MAX_ATTEMPT_WRITE_COUNT
protected static final int DFLT_BATCH_SIZE
protected static final int DFLT_PARALLEL_LOAD_CACHE_MINIMUM_THRESHOLD
protected static final String ATTR_CONN_PROP
protected static final Object[] EMPTY_COLUMN_VALUE
@LoggerResource protected IgniteLogger log
protected DataSource dataSrc
protected volatile Map<String,Map<Object,CacheAbstractJdbcStore.EntryMapping>> cacheMappings
protected JdbcDialect dialect
@Nullable protected abstract Object extractParameter(@Nullable String cacheName, String typeName, String fieldName, Object obj) throws javax.cache.CacheException
cacheName
- Cache name.typeName
- Type name.fieldName
- Field name.obj
- Cache object.javax.cache.CacheException
protected abstract <R> R buildObject(@Nullable String cacheName, String typeName, Collection<CacheTypeFieldMetadata> fields, Map<String,Integer> loadColIdxs, ResultSet rs) throws javax.cache.integration.CacheLoaderException
R
- Type of result object.cacheName
- Cache name.typeName
- Type name.fields
- Fields descriptors.loadColIdxs
- Select query columns index.rs
- ResultSet.javax.cache.integration.CacheLoaderException
- If failed to construct cache object.protected abstract Object keyTypeId(Object key) throws javax.cache.CacheException
key
- Key object.javax.cache.CacheException
- If failed to get type key id from object.protected abstract Object keyTypeId(String type) throws javax.cache.CacheException
type
- String description of key type.javax.cache.CacheException
- If failed to get type key id from object.protected abstract void prepareBuilders(@Nullable String cacheName, Collection<CacheTypeMetadata> types) throws javax.cache.CacheException
types
- Collection of types.javax.cache.CacheException
- If failed to prepare internal builders for types.protected JdbcDialect resolveDialect() throws javax.cache.CacheException
javax.cache.CacheException
- Indicates problems accessing the metadata.public void start() throws IgniteException
start
in interface LifecycleAware
IgniteException
- If failed.public void stop() throws IgniteException
stop
in interface LifecycleAware
IgniteException
- If failed.protected Connection openConnection(boolean autocommit) throws SQLException
autocommit
- true
If connection should use autocommit mode.SQLException
- In case of error.protected Connection connection() throws SQLException
SQLException
- In case of error.protected void closeConnection(@Nullable Connection conn)
conn
- Connection to close.protected void end(@Nullable Connection conn, @Nullable Statement st)
conn
- Allocated connection.st
- Created statement,public void sessionEnd(boolean commit) throws javax.cache.integration.CacheWriterException
'commit'
parameter.sessionEnd
in interface CacheStore<K,V>
commit
- True
if transaction should commit, false
for rollback.javax.cache.integration.CacheWriterException
- If commit or rollback failed. Note that commit failure in some cases
may bring cache transaction into TransactionState.UNKNOWN
which will
consequently cause all transacted entries to be invalidated.protected Object getColumnValue(ResultSet rs, int colIdx, Class<?> type) throws SQLException
ResultSet
object and
will convert to the requested Java data type.rs
- Result set.colIdx
- Column index in result set.type
- Class representing the Java data type to convert the designated column to.SQLException
- If a database access error occurs or this method is called.protected static boolean simpleType(Class<?> cls)
cls
- Class.True
if object is a simple type.public void loadCache(IgniteBiInClosure<K,V> clo, @Nullable Object... args) throws javax.cache.integration.CacheLoaderException
IgniteCache.loadCache(IgniteBiPredicate, Object...)
method is invoked which is usually to preload the cache from persistent storage.
This method is optional, and cache implementation does not depend on this
method to do anything. Default implementation of this method in
CacheStoreAdapter
does nothing.
For every loaded value method IgniteBiInClosure.apply(Object, Object)
should be called on the passed in closure. The closure will then make sure
that the loaded value is stored in cache.
loadCache
in interface CacheStore<K,V>
clo
- Closure for loaded values.args
- Arguments passes into
IgniteCache.loadCache(IgniteBiPredicate, Object...)
method.javax.cache.integration.CacheLoaderException
- If loading failed.public Map<K,V> loadAll(Iterable<? extends K> keys) throws javax.cache.integration.CacheLoaderException
public void write(javax.cache.Cache.Entry<? extends K,? extends V> entry) throws javax.cache.integration.CacheWriterException
public void writeAll(Collection<javax.cache.Cache.Entry<? extends K,? extends V>> entries) throws javax.cache.integration.CacheWriterException
public void delete(Object key) throws javax.cache.integration.CacheWriterException
public void deleteAll(Collection<?> keys) throws javax.cache.integration.CacheWriterException
protected void fillParameter(PreparedStatement stmt, int i, CacheTypeFieldMetadata field, @Nullable Object fieldVal) throws javax.cache.CacheException
stmt
- Prepare statement.i
- Index for parameters.field
- Field descriptor.fieldVal
- Field value.javax.cache.CacheException
- If failed to set statement parameter.protected int fillKeyParameters(PreparedStatement stmt, int idx, CacheAbstractJdbcStore.EntryMapping em, Object key) throws javax.cache.CacheException
stmt
- Prepare statement.idx
- Start index for parameters.em
- Entry mapping.key
- Key object.javax.cache.CacheException
- If failed to set statement parameters.protected int fillKeyParameters(PreparedStatement stmt, CacheAbstractJdbcStore.EntryMapping m, Object key) throws javax.cache.CacheException
stmt
- Prepare statement.m
- Type mapping description.key
- Key object.javax.cache.CacheException
- If failed to set statement parameters.protected int fillValueParameters(PreparedStatement stmt, int idx, CacheAbstractJdbcStore.EntryMapping em, Object val) throws javax.cache.integration.CacheWriterException
stmt
- Prepare statement.idx
- Start index for parameters.em
- Type mapping description.val
- Value object.javax.cache.CacheException
- If failed to set statement parameters.javax.cache.integration.CacheWriterException
public DataSource getDataSource()
public void setDataSource(DataSource dataSrc)
dataSrc
- Data source.public JdbcDialect getDialect()
public void setDialect(JdbcDialect dialect)
dialect
- Database dialect.public int getMaximumPoolSize()
public void setMaximumPoolSize(int maxPoolSz)
maxPoolSz
- Max workers thread count.public int getBatchSize()
public void setBatchSize(int batchSz)
batchSz
- Maximum batch size.public int getParallelLoadCacheMinimumThreshold()
0
then load sequentially.public void setParallelLoadCacheMinimumThreshold(int parallelLoadCacheMinThreshold)
parallelLoadCacheMinThreshold
- Minimum row count threshold. If 0
then load sequentially.protected Ignite ignite()
protected CacheStoreSession session()
Follow @ApacheIgnite
Apache Ignite Fabric : ver. 1.0.0 Release Date : March 31 2015