org.gridgain.grid.cache.store.jdbc

Class GridCacheJdbcBlobStore<K,V>

java.lang.Object

org.gridgain.grid.cache.store.GridCacheStoreAdapter<K,V>

org.gridgain.grid.cache.store.jdbc.GridCacheJdbcBlobStore<K,V>

All Implemented Interfaces:

GridCacheStore<K,V>

public class GridCacheJdbcBlobStore<K,V>
extends GridCacheStoreAdapter<K,V>

GridCacheStore implementation backed by JDBC. This implementation stores objects in underlying database in BLOB format.

Store will create table ENTRIES in the database to store data. Table will have key and val fields.

If custom DDL and DML statements are provided, table and field names have to be consistent for all statements and sequence of parameters have to be preserved.

Configuration

Sections below describe mandatory and optional configuration settings as well as providing example using Java and Spring XML.

Mandatory

There are no mandatory configuration parameters.

Optional

• Data source (see setDataSource(DataSource)
• Connection URL (see setConnectionUrl(String))
• User name (see setUser(String))
• Password (see setPassword(String))
• Create table query (see setConnectionUrl(String))
• Load entry query (see setLoadQuery(String))
• Update entry query (see setUpdateQuery(String))
• Insert entry query (see setInsertQuery(String))
• Delete entry query (see setDeleteQuery(String))

Java Example

     ...
     GridCacheJdbcBlobStore<String, String> store = new GridCacheJdbcBlobStore<String, String>();
     ...
 

Spring Example

     ...
     <bean id="cache.jdbc.store"
         class="org.gridgain.grid.cache.store.jdbc.GridCacheJdbcBlobStore">
         <property name="connectionUrl" value="jdbc:h2:mem:"/>
         <property name="createTableQuery"
             value="create table if not exists ENTRIES (key other, val other)"/>
     </bean>
     ...
 

For information about Spring framework visit www.springframework.org

Field Summary

Fields

Modifier and Type	Field and Description
static String	DFLT_CONN_URL Default connection URL (value is jdbc:h2:mem:jdbcCacheStore;DB_CLOSE_DELAY=-1).
static String	DFLT_CREATE_TBL_QRY Default create table query (value is create table if not exists ENTRIES (key other primary key, val other)).
static String	DFLT_DEL_QRY Default delete entry query (value is delete from ENTRIES where key=?).
static String	DFLT_INSERT_QRY Default insert entry query (value is insert into ENTRIES (key, val) values (?, ?)).
static String	DFLT_LOAD_QRY Default load entry query (value is select * from ENTRIES where key=?).
static String	DFLT_UPDATE_QRY Default update entry query (value is select * from ENTRIES where key=?).

Constructor Summary

Constructors

Constructor and Description
GridCacheJdbcBlobStore()

Method Summary

Methods

Modifier and Type	Method and Description
protected <X> X	fromBytes(byte[] bytes) Deserialize object from byte array using marshaller.
V	load(GridCacheTx tx, K key) Loads value for the key from underlying persistent storage.
void	put(GridCacheTx tx, K key, V val) Stores a given value in persistent storage.
void	remove(GridCacheTx tx, K key) Removes the value identified by given key from persistent storage.
void	setConnectionUrl(String connUrl) Sets connection URL.
void	setCreateTableQuery(String createTblQry) Sets create table query.
void	setDataSource(DataSource dataSrc) Sets data source.
void	setDeleteQuery(String delQry) Sets delete entry query.
void	setInsertQuery(String insertQry) Sets insert entry query.
void	setLoadQuery(String loadQry) Sets load query.
void	setPassword(String passwd) Sets password for database access.
void	setUpdateQuery(String updateQry) Sets update entry query.
void	setUser(String user) Sets user name for database access.
protected byte[]	toBytes(Object obj) Serialize object to byte array using marshaller.
String	toString()
void	txEnd(GridCacheTx tx, boolean commit) Default empty implementation for ending transactions.

Methods inherited from class org.gridgain.grid.cache.store.GridCacheStoreAdapter

loadAll, loadCache, putAll, removeAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DFLT_CONN_URL

public static final String DFLT_CONN_URL

Default connection URL (value is jdbc:h2:mem:jdbcCacheStore;DB_CLOSE_DELAY=-1).

See Also:

Constant Field Values

DFLT_CREATE_TBL_QRY

public static final String DFLT_CREATE_TBL_QRY

Default create table query (value is create table if not exists ENTRIES (key other primary key, val other)).

See Also:

Constant Field Values

DFLT_LOAD_QRY

public static final String DFLT_LOAD_QRY

Default load entry query (value is select * from ENTRIES where key=?).

See Also:

Constant Field Values

DFLT_UPDATE_QRY

public static final String DFLT_UPDATE_QRY

Default update entry query (value is select * from ENTRIES where key=?).

See Also:

Constant Field Values

DFLT_INSERT_QRY

public static final String DFLT_INSERT_QRY

Default insert entry query (value is insert into ENTRIES (key, val) values (?, ?)).

See Also:

Constant Field Values

DFLT_DEL_QRY

public static final String DFLT_DEL_QRY

Default delete entry query (value is delete from ENTRIES where key=?).

See Also:

Constant Field Values

Constructor Detail

GridCacheJdbcBlobStore

public GridCacheJdbcBlobStore()

Method Detail

txEnd

public void txEnd(GridCacheTx tx,
         boolean commit)
           throws GridException

Default empty implementation for ending transactions. Note that if explicit cache transactions are not used, then transactions do not have to be explicitly ended - for all other cases this method should be overridden with custom commit/rollback logic.

Specified by:

txEnd in interface GridCacheStore<K,V>

Overrides:

txEnd in class GridCacheStoreAdapter<K,V>

Parameters:

tx - Cache transaction being ended.

commit - True if transaction should commit, false for rollback.

Throws:

GridException - If commit or rollback failed. Note that commit failure in some cases may bring cache transaction into GridCacheTxState.UNKNOWN which will consequently cause all transacted entries to be invalidated.

load

public V load(@Nullable
     GridCacheTx tx,
     K key)
       throws GridException

Loads value for the key from underlying persistent storage.

Parameters:

tx - Cache transaction.

key - Key to load.

Returns:

Loaded value or null if value was not found.

Throws:

GridException - If load failed.

put

public void put(@Nullable
       GridCacheTx tx,
       K key,
       V val)
         throws GridException

Stores a given value in persistent storage. Note that cache transaction is implicitly created even for a single put. However, if write-behind is configured for a particular cache, transaction object passed in the cache store will be always null.

Parameters:

tx - Cache transaction, if write-behind is not enabled, null otherwise.

key - Key to put.

val - Value to put.

Throws:

GridException - If put failed.

remove

public void remove(@Nullable
          GridCacheTx tx,
          K key)
            throws GridException

Removes the value identified by given key from persistent storage. Note that cache transaction is implicitly created even for a single put. However, if write-behind is configured for a particular cache, transaction object passed in the cache store will be always null.

Parameters:

tx - Cache transaction, if write-behind is not enabled, null otherwise.

key - Key to remove.

Throws:

GridException - If remove failed.

setConnectionUrl

public void setConnectionUrl(String connUrl)

Sets connection URL.

Parameters:

connUrl - Connection URL.

setCreateTableQuery

public void setCreateTableQuery(String createTblQry)

Sets create table query.

Parameters:

createTblQry - Create table query.

setLoadQuery

public void setLoadQuery(String loadQry)

Sets load query.

Parameters:

loadQry - Load query

setUpdateQuery

public void setUpdateQuery(String updateQry)

Sets update entry query.

Parameters:

updateQry - Update entry query.

setInsertQuery

public void setInsertQuery(String insertQry)

Sets insert entry query.

Parameters:

insertQry - Insert entry query.

setDeleteQuery

public void setDeleteQuery(String delQry)

Sets delete entry query.

Parameters:

delQry - Delete entry query.

setUser

public void setUser(String user)

Sets user name for database access.

Parameters:

user - User name.

setPassword

public void setPassword(String passwd)

Sets password for database access.

Parameters:

passwd - Password.

setDataSource

public void setDataSource(DataSource dataSrc)

Sets data source. Data source should be fully configured and ready-to-use.

Note that if data source is provided, all connections will be acquired via this data source. If data source is not provided, a new connection will be created for each store call (connectionUrl, user and password parameters will be used).

Parameters:

dataSrc - Data source.

toString

public String toString()

Overrides:

toString in class Object

toBytes

protected byte[] toBytes(Object obj)
                  throws GridException

Serialize object to byte array using marshaller.

Parameters:

obj - Object to convert to byte array.

Returns:

Byte array.

Throws:

GridException - If failed to convert.

fromBytes

protected <X> X fromBytes(byte[] bytes)
               throws GridException

Deserialize object from byte array using marshaller.

Type Parameters:

X - Result object type.

Parameters:

bytes - Bytes to deserialize.

Returns:

Deserialized object.

Throws:

GridException - If failed.