org.apache.ignite.internal.processors.query.aware

Class IndexRebuildStateStorage

java.lang.Object

org.apache.ignite.internal.processors.query.aware.IndexRebuildStateStorage

All Implemented Interfaces:

CheckpointListener, MetastorageLifecycleListener

public class IndexRebuildStateStorage
extends Object
implements MetastorageLifecycleListener, CheckpointListener

Holder of up-to-date information about rebuilding cache indexes. Helps to avoid the situation when the index rebuilding process is interrupted and after a node restart/reactivation the indexes will become inconsistent.

To do this, before rebuilding the indexes, call onStartRebuildIndexes(org.apache.ignite.internal.processors.cache.GridCacheContext) and after it onFinishRebuildIndexes(java.lang.String). Use completed(java.lang.String) to check if the index rebuild has completed.

To prevent leaks, it is necessary to use onFinishRebuildIndexes(java.lang.String) when detecting the fact of destroying the cache.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.ignite.internal.processors.cache.persistence.checkpoint.CheckpointListener

CheckpointListener.Context

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_PREFIX Key prefix for the MetaStorage.

Constructor Summary

Constructors

Constructor and Description
IndexRebuildStateStorage(GridKernalContext ctx) Constructor.

Method Summary

Modifier and Type	Method and Description
void	afterCheckpointEnd(CheckpointListener.Context ctx) Do some actions after checkpoint end.
void	beforeCheckpointBegin(CheckpointListener.Context ctx) Do some actions before checkpoint write lock.
boolean	completed(String cacheName) Check if rebuilding of indexes for the cache has been completed.
void	onCacheKernalStart() Callback on start of GridCacheProcessor.
void	onCheckpointBegin(CheckpointListener.Context ctx)
void	onFinishRebuildIndexes(String cacheName) Callback on finish of rebuild cache indexes.
void	onMarkCheckpointBegin(CheckpointListener.Context ctx)
void	onReadyForRead(ReadOnlyMetastorage metastorage) Is called when metastorage is made ready for read-only operations very early on node startup phase.
void	onReadyForReadWrite(ReadWriteMetastorage metastorage) Fully functional metastore capable of performing reading and writing operations.
void	onStartRebuildIndexes(GridCacheContext cacheCtx) Callback on start of rebuild cache indexes.
void	start() Callback on start of GridQueryProcessor.
void	stop() Callback on kernel stop.

Methods inherited from class java.lang.Object

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

Field Detail

KEY_PREFIX

public static final String KEY_PREFIX

Key prefix for the MetaStorage.

See Also:

Constant Field Values

Constructor Detail

IndexRebuildStateStorage

public IndexRebuildStateStorage(GridKernalContext ctx)

Constructor.

Parameters:

ctx - Kernal context.

Method Detail

start

public void start()

Callback on start of GridQueryProcessor.

onCacheKernalStart

public void onCacheKernalStart()

Callback on start of GridCacheProcessor.

stop

public void stop()

Callback on kernel stop.

onStartRebuildIndexes

public void onStartRebuildIndexes(GridCacheContext cacheCtx)

Callback on start of rebuild cache indexes.

Adding an entry that rebuilding the cache indexes in progress. If the cache is persistent, then add this entry to the MetaStorage.

Parameters:

cacheCtx - Cache context.

See Also:

onFinishRebuildIndexes(java.lang.String)

onFinishRebuildIndexes

public void onFinishRebuildIndexes(String cacheName)

Callback on finish of rebuild cache indexes.

If the cache is persistent, then we mark that the rebuilding of the indexes is completed and the entry will be deleted from the MetaStorage at the end of the checkpoint. Otherwise, delete the index rebuild entry.

Parameters:

cacheName - Cache name.

See Also:

onStartRebuildIndexes(org.apache.ignite.internal.processors.cache.GridCacheContext)

completed

public boolean completed(String cacheName)

Check if rebuilding of indexes for the cache has been completed.

Parameters:

cacheName - Cache name.

Returns:

True if completed.

onReadyForReadWrite

public void onReadyForReadWrite(ReadWriteMetastorage metastorage)

Fully functional metastore capable of performing reading and writing operations. Components interested in using metastore are allowed to keep reference passed into the method in their fields.

Specified by:

onReadyForReadWrite in interface MetastorageLifecycleListener

Parameters:

metastorage - Fully functional meta storage.

onReadyForRead

public void onReadyForRead(ReadOnlyMetastorage metastorage)

Is called when metastorage is made ready for read-only operations very early on node startup phase. Reference for read-only metastorage should be used only within this method and shouldn't be stored to any field.

Specified by:

onReadyForRead in interface MetastorageLifecycleListener

Parameters:

metastorage - Read-only meta storage.

onMarkCheckpointBegin

public void onMarkCheckpointBegin(CheckpointListener.Context ctx)

Specified by:

onMarkCheckpointBegin in interface CheckpointListener

onCheckpointBegin

public void onCheckpointBegin(CheckpointListener.Context ctx)

Specified by:

onCheckpointBegin in interface CheckpointListener

beforeCheckpointBegin

public void beforeCheckpointBegin(CheckpointListener.Context ctx)

Do some actions before checkpoint write lock.

Specified by:

beforeCheckpointBegin in interface CheckpointListener

afterCheckpointEnd

public void afterCheckpointEnd(CheckpointListener.Context ctx)

Do some actions after checkpoint end.

Specified by:

afterCheckpointEnd in interface CheckpointListener