org.apache.ignite.internal.processors.cache

Interface IgniteCacheOffheapManager.CacheDataStore

All Known Implementing Classes:

GridCacheOffheapManager.GridCacheDataStore, IgniteCacheOffheapManagerImpl.CacheDataStoreImpl

Enclosing interface:

IgniteCacheOffheapManager

public static interface IgniteCacheOffheapManager.CacheDataStore

Method Summary

Modifier and Type	Method and Description
long	cacheSize(int cacheId)
Map<Integer,Long>	cacheSizes()
int	cleanup(GridCacheContext cctx, @Nullable List<MvccLinkAwareSearchRow> cleanupRows)
void	clear(int cacheId) Clears all the records associated with logical cache with given ID.
CacheDataRow	createRow(GridCacheContext cctx, KeyCacheObject key, CacheObject val, GridCacheVersion ver, long expireTime, @Nullable CacheDataRow oldRow)
GridCursor<? extends CacheDataRow>	cursor()
GridCursor<? extends CacheDataRow>	cursor(int cacheId)
GridCursor<? extends CacheDataRow>	cursor(int cacheId, KeyCacheObject lower, KeyCacheObject upper)
GridCursor<? extends CacheDataRow>	cursor(int cacheId, KeyCacheObject lower, KeyCacheObject upper, Object x)
GridCursor<? extends CacheDataRow>	cursor(int cacheId, KeyCacheObject lower, KeyCacheObject upper, Object x, MvccSnapshot snapshot)
GridCursor<? extends CacheDataRow>	cursor(int cacheId, MvccSnapshot mvccSnapshot)
GridCursor<? extends CacheDataRow>	cursor(MvccSnapshot mvccSnapshot)
GridCursor<? extends CacheDataRow>	cursor(Object x)
void	destroy() Destroys the tree associated with the store.
GridLongList	finalizeUpdateCounters() Flushes pending update counters closing all possible gaps.
CacheDataRow	find(GridCacheContext cctx, KeyCacheObject key)
long	fullSize()
long	getAndIncrementUpdateCounter(long delta) Returns current value and updates counter by delta.
boolean	init() Initialize data store if it exists.
long	initialUpdateCounter()
void	insertRows(Collection<DataRowCacheAware> rows, IgnitePredicateX<CacheDataRow> initPred) Insert rows into page memory.
void	invoke(GridCacheContext cctx, KeyCacheObject key, IgniteCacheOffheapManager.OffheapInvokeClosure c)
boolean	isEmpty()
void	markDestroyed() Mark store as destroyed.
GridCursor<CacheDataRow>	mvccAllVersionsCursor(GridCacheContext cctx, KeyCacheObject key, Object x) Returns iterator over the all row versions for the given key.
boolean	mvccApplyHistoryIfAbsent(GridCacheContext cctx, KeyCacheObject key, List<GridCacheMvccEntryInfo> hist) Tries to apply entry history.
void	mvccApplyUpdate(GridCacheContext cctx, KeyCacheObject key, CacheObject val, GridCacheVersion ver, long expireTime, MvccVersion mvccVer)
CacheDataRow	mvccFind(GridCacheContext cctx, KeyCacheObject key, MvccSnapshot snapshot)
List<IgniteBiTuple<Object,MvccVersion>>	mvccFindAllVersions(GridCacheContext cctx, KeyCacheObject key) For testing only.
boolean	mvccInitialValue(GridCacheContext cctx, KeyCacheObject key, @Nullable CacheObject val, GridCacheVersion ver, long expireTime, MvccVersion mvccVer, MvccVersion newMvccVer)
MvccUpdateResult	mvccLock(GridCacheContext cctx, KeyCacheObject key, MvccSnapshot mvccSnapshot)
MvccUpdateResult	mvccRemove(GridCacheContext cctx, KeyCacheObject key, MvccSnapshot mvccSnapshot, @Nullable CacheEntryPredicate filter, boolean primary, boolean needHistory, boolean needOldVal, boolean retVal)
void	mvccRemoveAll(GridCacheContext cctx, KeyCacheObject key)
MvccUpdateResult	mvccUpdate(GridCacheContext cctx, KeyCacheObject key, CacheObject val, GridCacheVersion ver, long expireTime, MvccSnapshot mvccSnapshot, @Nullable CacheEntryPredicate filter, javax.cache.processor.EntryProcessor entryProc, Object[] invokeArgs, boolean primary, boolean needHist, boolean noCreate, boolean needOldVal, boolean retVal, boolean keepBinary)
boolean	mvccUpdateRowWithPreloadInfo(GridCacheContext cctx, KeyCacheObject key, @Nullable CacheObject val, GridCacheVersion ver, long expireTime, MvccVersion mvccVer, MvccVersion newMvccVer, byte mvccTxState, byte newMvccTxState) Apply update with full history.
long	nextUpdateCounter()
int	partId()
PartitionMetaStorage<SimpleDataRow>	partStorage() Partition storage.
@Nullable PartitionUpdateCounter	partUpdateCounter()
PendingEntriesTree	pendingTree() Return PendingTree for data store.
void	preload() Preload a store into page memory.
void	remove(GridCacheContext cctx, KeyCacheObject key, int partId)
long	reserve(long delta)
long	reservedCounter()
void	resetInitialUpdateCounter() Reset the initial value of the partition counter.
void	resetUpdateCounter() Reset counter for partition.
RowStore	rowStore()
void	setRowCacheCleaner(GridQueryRowCacheCleaner rowCacheCleaner) Inject rows cache cleaner.
CacheDataTree	tree()
void	update(GridCacheContext cctx, KeyCacheObject key, CacheObject val, GridCacheVersion ver, long expireTime, @Nullable CacheDataRow oldRow)
long	updateCounter()
void	updateCounter(long val)
boolean	updateCounter(long start, long delta) Updates counters from start value by delta value.
void	updateInitialCounter(long start, long delta)
void	updateSize(int cacheId, long delta) Updates size metric for particular cache.
void	updateTxState(GridCacheContext cctx, CacheSearchRow row)

Method Detail

tree

CacheDataTree tree()

Returns:

Cache data tree object.

init

boolean init()

Initialize data store if it exists.

Returns:

True if initialized.

partId

int partId()

Returns:

Partition ID.

cacheSize

long cacheSize(int cacheId)

Parameters:

cacheId - Cache ID.

Returns:

Size.

cacheSizes

Map<Integer,Long> cacheSizes()

Returns:

Cache sizes if store belongs to group containing multiple caches.

fullSize

long fullSize()

Returns:

Total size.

isEmpty

boolean isEmpty()

Returns:

True if there are no items in the store.

updateSize

void updateSize(int cacheId,
                long delta)

Updates size metric for particular cache.

Parameters:

cacheId - Cache ID.

delta - Size delta.

updateCounter

long updateCounter()

Returns:

Update counter (LWM).

reservedCounter

long reservedCounter()

Returns:

Reserved counter (HWM).

partUpdateCounter

@Nullable
@Nullable PartitionUpdateCounter partUpdateCounter()

Returns:

Update counter or null if store is not yet created.

reserve

long reserve(long delta)

Parameters:

delta - Delta.

updateCounter

void updateCounter(long val)

Parameters:

val - Update counter.

updateCounter

boolean updateCounter(long start,
                      long delta)

Updates counters from start value by delta value.

Parameters:

start - Start.

delta - Delta.

nextUpdateCounter

long nextUpdateCounter()

Returns:

Next update counter.

getAndIncrementUpdateCounter

long getAndIncrementUpdateCounter(long delta)

Returns current value and updates counter by delta.

Parameters:

delta - Delta.

Returns:

Current value.

initialUpdateCounter

long initialUpdateCounter()

Returns:

Initial update counter.

createRow

CacheDataRow createRow(GridCacheContext cctx,
                       KeyCacheObject key,
                       CacheObject val,
                       GridCacheVersion ver,
                       long expireTime,
                       @Nullable
                       @Nullable CacheDataRow oldRow)
                throws IgniteCheckedException

Parameters:

cctx - Cache context.

key - Key.

val - Value.

ver - Version.

expireTime - Expire time.

oldRow - Old row.

Returns:

New row.

Throws:

IgniteCheckedException - If failed.

insertRows

void insertRows(Collection<DataRowCacheAware> rows,
                IgnitePredicateX<CacheDataRow> initPred)
         throws IgniteCheckedException

Insert rows into page memory.

Parameters:

rows - Rows.

initPred - Applied to all rows. Each row that not matches the predicate is removed.

Throws:

IgniteCheckedException - If failed.

cleanup

int cleanup(GridCacheContext cctx,
            @Nullable
            @Nullable List<MvccLinkAwareSearchRow> cleanupRows)
     throws IgniteCheckedException

Parameters:

cctx - Cache context.

cleanupRows - Rows to cleanup.

Returns:

Cleaned rows count.

Throws:

IgniteCheckedException - If failed.

updateTxState

void updateTxState(GridCacheContext cctx,
                   CacheSearchRow row)
            throws IgniteCheckedException

Parameters:

cctx - Cache context.

row - Row.

Throws:

IgniteCheckedException

update

void update(GridCacheContext cctx,
            KeyCacheObject key,
            CacheObject val,
            GridCacheVersion ver,
            long expireTime,
            @Nullable
            @Nullable CacheDataRow oldRow)
     throws IgniteCheckedException

Parameters:

cctx - Cache context.

key - Key.

val - Value.

ver - Version.

expireTime - Expire time.

oldRow - Old row if available.

Throws:

IgniteCheckedException - If failed.

mvccInitialValue

boolean mvccInitialValue(GridCacheContext cctx,
                         KeyCacheObject key,
                         @Nullable
                         @Nullable CacheObject val,
                         GridCacheVersion ver,
                         long expireTime,
                         MvccVersion mvccVer,
                         MvccVersion newMvccVer)
                  throws IgniteCheckedException

Parameters:

cctx - Cache context.

key - Key.

val - Value.

ver - Version.

mvccVer - MVCC version.

newMvccVer - New MVCC version.

Returns:

True if new value was inserted.

Throws:

IgniteCheckedException - If failed.

mvccApplyHistoryIfAbsent

boolean mvccApplyHistoryIfAbsent(GridCacheContext cctx,
                                 KeyCacheObject key,
                                 List<GridCacheMvccEntryInfo> hist)
                          throws IgniteCheckedException

Tries to apply entry history. Either applies full entry history or do nothing.

Parameters:

cctx - Cache context.

key - Key.

hist - Full entry history.

Returns:

True if entry history applied successfully, False otherwise.

Throws:

IgniteCheckedException

mvccUpdateRowWithPreloadInfo

boolean mvccUpdateRowWithPreloadInfo(GridCacheContext cctx,
                                     KeyCacheObject key,
                                     @Nullable
                                     @Nullable CacheObject val,
                                     GridCacheVersion ver,
                                     long expireTime,
                                     MvccVersion mvccVer,
                                     MvccVersion newMvccVer,
                                     byte mvccTxState,
                                     byte newMvccTxState)
                              throws IgniteCheckedException

Apply update with full history. Note: History version may be skipped if it have already been actualized with previous update operation.

Parameters:

cctx - Grid cache context.

key - Key.

val - Value.

ver - Version.

expireTime - Expiration time.

mvccVer - Mvcc version.

newMvccVer - New mvcc version.

Returns:

true on success.

Throws:

IgniteCheckedException, - if failed.

IgniteCheckedException

mvccUpdate

MvccUpdateResult mvccUpdate(GridCacheContext cctx,
                            KeyCacheObject key,
                            CacheObject val,
                            GridCacheVersion ver,
                            long expireTime,
                            MvccSnapshot mvccSnapshot,
                            @Nullable
                            @Nullable CacheEntryPredicate filter,
                            javax.cache.processor.EntryProcessor entryProc,
                            Object[] invokeArgs,
                            boolean primary,
                            boolean needHist,
                            boolean noCreate,
                            boolean needOldVal,
                            boolean retVal,
                            boolean keepBinary)
                     throws IgniteCheckedException

Parameters:

cctx - Cache context.

key - Key.

val - Value.

ver - Version.

expireTime - Expire time.

mvccSnapshot - MVCC snapshot.

filter - Filter.

entryProc - Entry processor.

invokeArgs - Entry processor invoke arguments.

primary - True if update is executed on primary node.

needHist - Flag to collect history.

noCreate - Flag indicating that row should not be created if absent.

needOldVal - True if need old value.

retVal - Flag to return previous value.

keepBinary - Keep binary flag.

Returns:

Update result.

Throws:

IgniteCheckedException - If failed.

mvccRemove

MvccUpdateResult mvccRemove(GridCacheContext cctx,
                            KeyCacheObject key,
                            MvccSnapshot mvccSnapshot,
                            @Nullable
                            @Nullable CacheEntryPredicate filter,
                            boolean primary,
                            boolean needHistory,
                            boolean needOldVal,
                            boolean retVal)
                     throws IgniteCheckedException

Parameters:

cctx - Cache context.

key - Key.

mvccSnapshot - MVCC snapshot.

filter - Filter.

primary - True if update is executed on primary node.

needHistory - Flag to collect history.

needOldVal - True if need old value.

retVal - Flag to return previous value.

Returns:

List of transactions to wait for.

Throws:

IgniteCheckedException - If failed.

mvccLock

MvccUpdateResult mvccLock(GridCacheContext cctx,
                          KeyCacheObject key,
                          MvccSnapshot mvccSnapshot)
                   throws IgniteCheckedException

Parameters:

cctx - Cache context.

key - Key.

mvccSnapshot - MVCC snapshot.

Returns:

List of transactions to wait for.

Throws:

IgniteCheckedException - If failed.

mvccRemoveAll

void mvccRemoveAll(GridCacheContext cctx,
                   KeyCacheObject key)
            throws IgniteCheckedException

Parameters:

cctx - Cache context.

key - Key.

Throws:

IgniteCheckedException - If failed.

invoke

void invoke(GridCacheContext cctx,
            KeyCacheObject key,
            IgniteCacheOffheapManager.OffheapInvokeClosure c)
     throws IgniteCheckedException

Parameters:

cctx - Cache context.

key - Key.

c - Closure.

Throws:

IgniteCheckedException - If failed.

mvccApplyUpdate

void mvccApplyUpdate(GridCacheContext cctx,
                     KeyCacheObject key,
                     CacheObject val,
                     GridCacheVersion ver,
                     long expireTime,
                     MvccVersion mvccVer)
              throws IgniteCheckedException

Parameters:

cctx - Cache context.

key - Key.

val - Value.

ver - Version.

expireTime - Expire time.

mvccVer - Mvcc version.

Throws:

IgniteCheckedException

remove

void remove(GridCacheContext cctx,
            KeyCacheObject key,
            int partId)
     throws IgniteCheckedException

Parameters:

cctx - Cache context.

key - Key.

partId - Partition number.

Throws:

IgniteCheckedException - If failed.

find

CacheDataRow find(GridCacheContext cctx,
                  KeyCacheObject key)
           throws IgniteCheckedException

Parameters:

cctx - Cache context.

key - Key.

Returns:

Data row.

Throws:

IgniteCheckedException - If failed.

mvccAllVersionsCursor

GridCursor<CacheDataRow> mvccAllVersionsCursor(GridCacheContext cctx,
                                               KeyCacheObject key,
                                               Object x)
                                        throws IgniteCheckedException

Returns iterator over the all row versions for the given key.

Parameters:

cctx - Cache context.

key - Key.

x - Implementation specific argument, null always means that we need to return full detached data row.

Returns:

Iterator over all versions.

Throws:

IgniteCheckedException - If failed.

mvccFind

CacheDataRow mvccFind(GridCacheContext cctx,
                      KeyCacheObject key,
                      MvccSnapshot snapshot)
               throws IgniteCheckedException

Parameters:

cctx - Cache context.

key - Key.

Returns:

Data row.

Throws:

IgniteCheckedException - If failed.

mvccFindAllVersions

List<IgniteBiTuple<Object,MvccVersion>> mvccFindAllVersions(GridCacheContext cctx,
                                                            KeyCacheObject key)
                                                     throws IgniteCheckedException

For testing only.

Parameters:

cctx - Cache context.

key - Key.

Returns:

All stored versions for given key.

Throws:

IgniteCheckedException - If failed.

cursor

GridCursor<? extends CacheDataRow> cursor()
                                   throws IgniteCheckedException

Returns:

Data cursor.

Throws:

IgniteCheckedException - If failed.

cursor

GridCursor<? extends CacheDataRow> cursor(Object x)
                                   throws IgniteCheckedException

Parameters:

x - Implementation specific argument, null always means that we need to return full detached data row.

Returns:

Data cursor.

Throws:

IgniteCheckedException - If failed.

cursor

GridCursor<? extends CacheDataRow> cursor(MvccSnapshot mvccSnapshot)
                                   throws IgniteCheckedException

Parameters:

mvccSnapshot - MVCC snapshot.

Returns:

Data cursor.

Throws:

IgniteCheckedException - If failed.

cursor

GridCursor<? extends CacheDataRow> cursor(int cacheId)
                                   throws IgniteCheckedException

Parameters:

cacheId - Cache ID.

Returns:

Data cursor.

Throws:

IgniteCheckedException - If failed.

cursor

GridCursor<? extends CacheDataRow> cursor(int cacheId,
                                          MvccSnapshot mvccSnapshot)
                                   throws IgniteCheckedException

Parameters:

cacheId - Cache ID.

mvccSnapshot - Mvcc snapshot.

Returns:

Data cursor.

Throws:

IgniteCheckedException - If failed.

cursor

GridCursor<? extends CacheDataRow> cursor(int cacheId,
                                          KeyCacheObject lower,
                                          KeyCacheObject upper)
                                   throws IgniteCheckedException

Parameters:

cacheId - Cache ID.

lower - Lower bound.

upper - Upper bound.

Returns:

Data cursor.

Throws:

IgniteCheckedException - If failed.

cursor

GridCursor<? extends CacheDataRow> cursor(int cacheId,
                                          KeyCacheObject lower,
                                          KeyCacheObject upper,
                                          Object x)
                                   throws IgniteCheckedException

Parameters:

cacheId - Cache ID.

lower - Lower bound.

upper - Upper bound.

x - Implementation specific argument, null always means that we need to return full detached data row.

Returns:

Data cursor.

Throws:

IgniteCheckedException - If failed.

cursor

GridCursor<? extends CacheDataRow> cursor(int cacheId,
                                          KeyCacheObject lower,
                                          KeyCacheObject upper,
                                          Object x,
                                          MvccSnapshot snapshot)
                                   throws IgniteCheckedException

Parameters:

cacheId - Cache ID.

lower - Lower bound.

upper - Upper bound.

x - Implementation specific argument, null always means that we need to return full detached data row.

snapshot - Mvcc snapshot.

Returns:

Data cursor.

Throws:

IgniteCheckedException - If failed.

destroy

void destroy()
      throws IgniteCheckedException

Destroys the tree associated with the store.

Throws:

IgniteCheckedException - If failed.

markDestroyed

void markDestroyed()
            throws IgniteCheckedException

Mark store as destroyed.

Throws:

IgniteCheckedException

clear

void clear(int cacheId)
    throws IgniteCheckedException

Clears all the records associated with logical cache with given ID.

Parameters:

cacheId - Cache ID.

Throws:

IgniteCheckedException - If failed.

rowStore

RowStore rowStore()

Returns:

Row store.

updateInitialCounter

void updateInitialCounter(long start,
                          long delta)

Parameters:

start - Counter.

delta - Delta.

setRowCacheCleaner

void setRowCacheCleaner(GridQueryRowCacheCleaner rowCacheCleaner)

Inject rows cache cleaner.

Parameters:

rowCacheCleaner - Rows cache cleaner.

pendingTree

PendingEntriesTree pendingTree()

Return PendingTree for data store.

Returns:

PendingTree instance.

finalizeUpdateCounters

GridLongList finalizeUpdateCounters()

Flushes pending update counters closing all possible gaps.

Returns:

Even-length array of pairs [start, end] for each gap.

preload

void preload()
      throws IgniteCheckedException

Preload a store into page memory.

Throws:

IgniteCheckedException - If failed.

resetUpdateCounter

void resetUpdateCounter()

Reset counter for partition.

resetInitialUpdateCounter

void resetInitialUpdateCounter()

Reset the initial value of the partition counter.

partStorage

PartitionMetaStorage<SimpleDataRow> partStorage()

Partition storage.