Cache storage adapter with parallel loading in LoadAll method. More...

Inheritance diagram for Apache.Ignite.Core.Cache.Store.CacheParallelLoadStoreAdapter< TK, TV, TData >:

Public Member Functions
virtual void	LoadCache (Action< TK, TV > act, params object[] args)
	Loads all values from underlying persistent storage. Note that keys are not passed, so it is up to implementation to figure out what to load. This method is called whenever ICache<K,V>.LocalLoadCache method is invoked which is usually to preload the cache from persistent storage. More...

virtual TV	Load (TK key)
	Loads an object. Application developers should implement this method to customize the loading of a value for a cache entry. This method is called by a cache when a requested entry is not in the cache. If the object can't be loaded `null` should be returned. More...

virtual IEnumerable< KeyValuePair< TK, TV > >	LoadAll (IEnumerable< TK > keys)
	Loads multiple objects. Application developers should implement this method to customize the loading of cache entries. This method is called when the requested object is not in the cache. If an object can't be loaded, it is not returned in the resulting map. More...

virtual void	Write (TK key, TV val)
	Write the specified value under the specified key to the external resource. More...

virtual void	WriteAll (IEnumerable< KeyValuePair< TK, TV >> entries)
	Write the specified entries to the external resource. This method is intended to support both insert and update. More...

virtual void	Delete (TK key)
	Delete the cache entry from the external resource. More...

virtual void	DeleteAll (IEnumerable< TK > keys)
	Remove data and keys from the external resource for the given collection of keys, if present. More...

virtual void	SessionEnd (bool commit)
	Tells store to commit or rollback a transaction depending on the value of the `commit` parameter. More...

Protected Member Functions
	CacheParallelLoadStoreAdapter ()
	Constructor. More...

abstract IEnumerable< TData >	GetInputData ()
	Gets the input data sequence to be used in LoadCache. More...

abstract KeyValuePair< TK, TV >	Parse (TData inputRecord, params object[] args)
	This method should transform raw data records from GetInputData into valid key-value pairs to be stored into cache. More...

Properties
int	MaxDegreeOfParallelism `[get, set]`
	Gets or sets the maximum degree of parallelism to use in LoadCache. Must be either positive or -1 for unlimited amount of threads. More...

Detailed Description

LoadCache calls GetInputData() and iterates over it in parallel. GetInputData().GetEnumerator() result will be disposed if it implements IDisposable. Any additional post-LoadCache steps can be performed by overriding LoadCache method.

Template Parameters

TK	Key type.
TV	Value type.
TData	Custom data entry type.

Constructor & Destructor Documentation

Apache.Ignite.Core.Cache.Store.CacheParallelLoadStoreAdapter< TK, TV, TData >.CacheParallelLoadStoreAdapter ( )

protected

Member Function Documentation

virtual void Apache.Ignite.Core.Cache.Store.CacheParallelLoadStoreAdapter< TK, TV, TData >.Delete ( TK key )

virtual

Expiry of a cache entry is not a delete hence will not cause this method to be invoked.

This method is invoked even if no mapping for the key exists.

Parameters

key	The key that is used for the delete operation.

Implements Apache.Ignite.Core.Cache.Store.ICacheStore< TK, TV >.

virtual void Apache.Ignite.Core.Cache.Store.CacheParallelLoadStoreAdapter< TK, TV, TData >.DeleteAll ( IEnumerable< TK > keys )

virtual

The order that individual deletes occur is undefined.

If this operation fails (by throwing an exception) after a partial success, the writer must remove any successfully written entries from the entries collection so that the caching implementation knows what succeeded and can mutate the cache.

Expiry of a cache entry is not a delete hence will not cause this method to be invoked.

This method may include keys even if there is no mapping for that key, in which case the data represented by that key should be removed from the underlying resource.

Parameters

keys	a mutable collection of keys for entries to delete. Upon invocation, it contains the keys to delete for write-through. Upon return the collection must only contain the keys that were not successfully deleted.

Implements Apache.Ignite.Core.Cache.Store.ICacheStore< TK, TV >.

abstract IEnumerable<TData> Apache.Ignite.Core.Cache.Store.CacheParallelLoadStoreAdapter< TK, TV, TData >.GetInputData ( )

protectedpure virtual

virtual TV Apache.Ignite.Core.Cache.Store.CacheParallelLoadStoreAdapter< TK, TV, TData >.Load ( TK key )

virtual

Parameters

key	The key identifying the object being loaded.

Returns: The value for the entry that is to be stored in the cache or null if the object can't be loaded

Implements Apache.Ignite.Core.Cache.Store.ICacheStore< TK, TV >.

virtual IEnumerable<KeyValuePair<TK, TV> > Apache.Ignite.Core.Cache.Store.CacheParallelLoadStoreAdapter< TK, TV, TData >.LoadAll ( IEnumerable< TK > keys )

virtual

Parameters

keys	Keys identifying the values to be loaded.

Returns: A map of key, values to be stored in the cache.

Implements Apache.Ignite.Core.Cache.Store.ICacheStore< TK, TV >.

virtual void Apache.Ignite.Core.Cache.Store.CacheParallelLoadStoreAdapter< TK, TV, TData >.LoadCache	(	Action< TK, TV >	act,
		params object[]	args
	)

virtual

This method is optional, and cache implementation does not depend on this method to do anything.

For every loaded value method provided action should be called. The action will then make sure that the loaded value is stored in cache.

Parameters

act	Action for loaded values.
args	Optional arguemnts passed to ICache<K,V>.LocalLoadCache method.

Exceptions

CacheStoreException

Implements Apache.Ignite.Core.Cache.Store.ICacheStore< TK, TV >.

abstract KeyValuePair<TK, TV> Apache.Ignite.Core.Cache.Store.CacheParallelLoadStoreAdapter< TK, TV, TData >.Parse	(	TData	inputRecord,
		params object[]	args
	)

protectedpure virtual

virtual void Apache.Ignite.Core.Cache.Store.CacheParallelLoadStoreAdapter< TK, TV, TData >.SessionEnd ( bool commit )

virtual

Parameters

commit True if transaction should commit, false for rollback.

Implements Apache.Ignite.Core.Cache.Store.ICacheStore< TK, TV >.

virtual void Apache.Ignite.Core.Cache.Store.CacheParallelLoadStoreAdapter< TK, TV, TData >.Write	(	TK	key,
		TV	val
	)

virtual

This method is intended to support both key/value creation and value update.

Parameters

key	Key to write.
val	Value to write.

Implements Apache.Ignite.Core.Cache.Store.ICacheStore< TK, TV >.

virtual void Apache.Ignite.Core.Cache.Store.CacheParallelLoadStoreAdapter< TK, TV, TData >.WriteAll ( IEnumerable< KeyValuePair< TK, TV >> entries )

virtual

The order that individual writes occur is undefined.

If this operation fails (by throwing an exception) after a partial success, the writer must remove any successfully written entries from the entries collection so that the caching implementation knows what succeeded and can mutate the cache.

Parameters

entries a mutable collection to write. Upon invocation, it contains the entries to write for write-through. Upon return the collection must only contain entries that were not successfully written. (see partial success above).

Implements Apache.Ignite.Core.Cache.Store.ICacheStore< TK, TV >.

Property Documentation

int Apache.Ignite.Core.Cache.Store.CacheParallelLoadStoreAdapter< TK, TV, TData >.MaxDegreeOfParallelism

getset

Defaults to Environment.ProcessorCount.

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation