K
- public class GenericMapStore<K> extends GenericMapLoader<K> implements MapStore<K,GenericRecord>, MapLoaderLifecycleSupport
MapStore
built
on top of Hazelcast SQL engine.
It works with any SQL connector supporting SELECT, INSERT, UPDATE and DELETE statements.
Usage:
First define data connection, e.g. for JDBC use JdbcDataConnection
:
Config config = new Config();
config.addDataConnectionConfig(
new DataConnectionConnection("mysql-ref")
.setType("Jdbc")
.setProperty("jdbcUrl", dbConnectionUrl)
);
Then create a Map with MapStore
using the GenericMapStore implementation:
MapConfig mapConfig = new MapConfig(mapName);
MapStoreConfig mapStoreConfig = new MapStoreConfig();
mapStoreConfig.setClassName(GenericMapStore.class.getName());
mapStoreConfig.setProperty(GenericMapStore.DATA_CONNECTION_REF_PROPERTY, "mysql-name");
mapConfig.setMapStoreConfig(mapStoreConfig);
instance().getConfig().addMapConfig(mapConfig);
The GenericMapStore creates a SQL mapping with name "__map-store." + mapName. This mapping is removed when the map is destroyed.
Note : When GenericMapStore uses GenericRecord as value, even if the GenericRecord contains the primary key as a field,
the primary key is still received from @{link IMap
method call
columnMetadataList, COLUMNS_PROPERTY, DATA_CONNECTION_REF_PROPERTY, EXTERNAL_NAME_PROPERTY, genericMapStoreProperties, ID_COLUMN_PROPERTY, LOAD_ALL_KEYS_PROPERTY, MAPSTORE_INIT_TIMEOUT, queries, sqlService, TYPE_NAME_PROPERTY
Constructor and Description |
---|
GenericMapStore() |
Modifier and Type | Method and Description |
---|---|
void |
delete(K key)
Deletes the entry with a given key from the store.
|
void |
deleteAll(Collection<K> keys)
Deletes multiple entries from the store.
|
void |
store(K key,
GenericRecord record)
Stores the key-value pair.
|
void |
storeAll(Map<K,GenericRecord> map)
Stores multiple entries.
|
awaitSuccessfulInit, destroy, init, load, loadAll, loadAllKeys
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
load, loadAll, loadAllKeys
destroy, init
public void store(K key, GenericRecord record)
MapStore
If an exception is thrown then the put operation will fail.
store
in interface MapStore<K,GenericRecord>
key
- key of the entry to storerecord
- value of the entry to storepublic void storeAll(Map<K,GenericRecord> map)
MapStore
Implementation of this method can optimize the store operation by storing all entries in one database connection. storeAll() is used when writeDelaySeconds is positive (write-behind).If an exception is thrown, the entries will try to be stored one by one using the store() method.
Note: on the retry phase only entries left in the map will be stored one-by-one. In this way a MapStore implementation can handle partial storeAll() cases when some entries were stored successfully before a failure happens. Entries removed from the map will be not passed to subsequent call to store() method any more.
storeAll
in interface MapStore<K,GenericRecord>
map
- map of entries to storepublic void delete(K key)
MapStore
If an exception is thrown the remove operation will fail.
delete
in interface MapStore<K,GenericRecord>
key
- the key to delete from the storepublic void deleteAll(Collection<K> keys)
MapStore
If an exception is thrown the entries will try to be deleted one by one using the delete() method.
Note: on the retry phase only entries left in the keys will be deleted one-by-one. In this way a MapStore implementation can handle partial deleteAll() cases when some entries were deleted successfully before a failure happens. Entries removed from the keys will be not passed to subsequent call to delete() method any more. The intended usage is to delete items from the provided collection as they are deleted from the store.
deleteAll
in interface MapStore<K,GenericRecord>
keys
- the keys of the entries to delete.Copyright © 2024 Hazelcast, Inc.. All rights reserved.