org.gridgain.grid.kernal.processors.cache.query

Class GridCacheQueryManager<K,V>

java.lang.Object

org.gridgain.grid.kernal.processors.cache.GridCacheManagerAdapter<K,V>

org.gridgain.grid.kernal.processors.cache.query.GridCacheQueryManager<K,V>

All Implemented Interfaces:

GridCacheManager<K,V>

Direct Known Subclasses:

GridCacheDistributedQueryManager, GridCacheLocalQueryManager

public abstract class GridCacheQueryManager<K,V>
extends GridCacheManagerAdapter<K,V>

Query and index manager.

Field Summary

Fields inherited from class org.gridgain.grid.kernal.processors.cache.GridCacheManagerAdapter

cctx, log

Constructor Summary

Constructors

Constructor and Description
GridCacheQueryManager()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	loadPage(long id, GridCacheQueryAdapter<?> qry, Collection<GridNode> nodes, boolean all) Loads page.
GridCacheQueryMetrics	metrics() Gets cache queries metrics.
protected abstract boolean	onFieldsPageReady(boolean loc, org.gridgain.grid.kernal.processors.cache.query.GridCacheQueryInfo qryInfo, List<GridIndexingFieldMetadata> metaData, Collection<List<GridIndexingEntity<?>>> entities, Collection<?> data, boolean finished, Throwable e)
protected void	onKernalStop0(boolean cancel)
void	onMetricsUpdate(long duration, boolean fail)
protected abstract boolean	onPageReady(boolean loc, org.gridgain.grid.kernal.processors.cache.query.GridCacheQueryInfo qryInfo, Collection<?> data, boolean finished, Throwable e) Called when data for page is ready.
void	onSwap(String swapSpaceName, K key) Entry for given key unswapped.
void	onUndeploy(ClassLoader ldr) Undeploys given class loader.
void	onUnswap(K key, V val, byte[] valBytes) Entry for given key unswapped.
void	printMemoryStats() Prints memory statistics for debugging purposes.
abstract GridCacheQueryFuture<?>	queryDistributed(GridCacheQueryBean qry, Collection<GridNode> nodes) Executes distributed query.
abstract GridCacheQueryFuture<?>	queryFieldsDistributed(GridCacheQueryBean qry, Collection<GridNode> nodes) Executes distributed fields query.
abstract GridCacheQueryFuture<?>	queryFieldsLocal(GridCacheQueryBean qry) Executes distributed fields query.
abstract GridCacheQueryFuture<?>	queryLocal(GridCacheQueryBean qry) Executes local query.
GridFuture<?>	rebuildAllIndexes() Rebuilds all search indexes of all types.
GridFuture<?>	rebuildIndexes(Class<?> valType) Rebuilds all search indexes of given value type.
boolean	remove(K key, byte[] keyBytes)
protected void	removeFieldsQueryResult(UUID sndId, long reqId)
protected void	removeQueryIterator(UUID sndId, long reqId)
void	resetMetrics() Resets metrics.
protected void	runFieldsQuery(org.gridgain.grid.kernal.processors.cache.query.GridCacheQueryInfo qryInfo) Processes fields query request.
protected <R> void	runQuery(org.gridgain.grid.kernal.processors.cache.query.GridCacheQueryInfo qryInfo) Processes cache query request.
long	size(Class<?> valType) Gets number of objects of given type in index.
String	space() FOR TESTING ONLY
Collection<GridCacheSqlMetadata>	sqlMetadata() Gets SQL metadata.
void	start0()
void	stop0(boolean cancel) Stops query manager.
void	store(K key, byte[] keyBytes, V val, byte[] valBytes, GridCacheVersion ver, long expirationTime) Writes key-value pair to index.

Methods inherited from class org.gridgain.grid.kernal.processors.cache.GridCacheManagerAdapter

context, kernalStartInfo, kernalStopInfo, log, onKernalStart, onKernalStart0, onKernalStop, start, startInfo, stop, stopInfo, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

GridCacheQueryManager

public GridCacheQueryManager()

Method Detail

start0

public void start0()
            throws GridException

Overrides:

start0 in class GridCacheManagerAdapter<K,V>

Throws:

GridException - If failed.

onKernalStop0

protected void onKernalStop0(boolean cancel)

Overrides:

onKernalStop0 in class GridCacheManagerAdapter<K,V>

Parameters:

cancel - Cancel flag.

stop0

public final void stop0(boolean cancel)

Stops query manager.

Overrides:

stop0 in class GridCacheManagerAdapter<K,V>

Parameters:

cancel - Cancel queries.

size

public long size(Class<?> valType)
          throws GridException

Gets number of objects of given type in index.

Parameters:

valType - Value type.

Returns:

Number of objects or -1 if type was not indexed at all.

Throws:

GridException - If failed.

rebuildIndexes

public GridFuture<?> rebuildIndexes(Class<?> valType)

Rebuilds all search indexes of given value type.

Parameters:

valType - Value type.

Returns:

Future that will be completed when rebuilding of all indexes is finished.

rebuildAllIndexes

public GridFuture<?> rebuildAllIndexes()

Rebuilds all search indexes of all types.

Returns:

Future that will be completed when rebuilding of all indexes is finished.

onSwap

public void onSwap(String swapSpaceName,
          K key)
            throws GridSpiException

Entry for given key unswapped.

Parameters:

swapSpaceName - Swap space name.

key - Key.

Throws:

GridSpiException - If failed.

onUnswap

public void onUnswap(K key,
            V val,
            byte[] valBytes)
              throws GridSpiException

Entry for given key unswapped.

Parameters:

key - Key.

val - Value

valBytes - Value bytes.

Throws:

GridSpiException - If failed.

store

public void store(K key,
         @Nullable
         byte[] keyBytes,
         @Nullable
         V val,
         @Nullable
         byte[] valBytes,
         GridCacheVersion ver,
         long expirationTime)
           throws GridException

Writes key-value pair to index.

Parameters:

key - Key.

keyBytes - Byte array with key data.

val - Value.

valBytes - Value bytes.

ver - Cache entry version.

expirationTime - Expiration time or 0 if never expires.

Throws:

GridException - In case of error.

remove

public boolean remove(K key,
             @Nullable
             byte[] keyBytes)
               throws GridException

Parameters:

key - Key.

keyBytes - Byte array with key value.

Returns:

true if key was found and removed, otherwise false.

Throws:

GridException - Thrown in case of any errors.

onUndeploy

public void onUndeploy(ClassLoader ldr)

Undeploys given class loader.

Parameters:

ldr - Class loader to undeploy.

queryLocal

public abstract GridCacheQueryFuture<?> queryLocal(GridCacheQueryBean qry)

Executes local query.

Parameters:

qry - Query.

Returns:

Query future.

queryDistributed

public abstract GridCacheQueryFuture<?> queryDistributed(GridCacheQueryBean qry,
                                       Collection<GridNode> nodes)

Executes distributed query.

Parameters:

qry - Query.

nodes - Nodes.

Returns:

Query future.

loadPage

public abstract void loadPage(long id,
            GridCacheQueryAdapter<?> qry,
            Collection<GridNode> nodes,
            boolean all)

Loads page.

Parameters:

id - Query ID.

qry - Query.

nodes - Nodes.

all - Whether to load all pages.

queryFieldsLocal

public abstract GridCacheQueryFuture<?> queryFieldsLocal(GridCacheQueryBean qry)

Executes distributed fields query.

Parameters:

qry - Query.

Returns:

Query future.

queryFieldsDistributed

public abstract GridCacheQueryFuture<?> queryFieldsDistributed(GridCacheQueryBean qry,
                                             Collection<GridNode> nodes)

Executes distributed fields query.

Parameters:

qry - Query.

nodes - Nodes.

Returns:

Query future.

runFieldsQuery

protected void runFieldsQuery(org.gridgain.grid.kernal.processors.cache.query.GridCacheQueryInfo qryInfo)

Processes fields query request.

Parameters:

qryInfo - Query info.

runQuery

protected <R> void runQuery(org.gridgain.grid.kernal.processors.cache.query.GridCacheQueryInfo qryInfo)

Processes cache query request.

Parameters:

qryInfo - Query info.

removeQueryIterator

protected void removeQueryIterator(@Nullable
                       UUID sndId,
                       long reqId)

Parameters:

sndId - Sender node ID.

reqId - Request ID.

removeFieldsQueryResult

protected void removeFieldsQueryResult(@Nullable
                           UUID sndId,
                           long reqId)

Parameters:

sndId - Sender node ID.

reqId - Request ID.

onPageReady

protected abstract boolean onPageReady(boolean loc,
                  org.gridgain.grid.kernal.processors.cache.query.GridCacheQueryInfo qryInfo,
                  @Nullable
                  Collection<?> data,
                  boolean finished,
                  @Nullable
                  Throwable e)

Called when data for page is ready.

Parameters:

loc - Local query or not.

qryInfo - Query info.

data - Result data.

finished - Last page or not.

e - Exception in case of error.

Returns:

true if page was processed right.

onFieldsPageReady

protected abstract boolean onFieldsPageReady(boolean loc,
                        org.gridgain.grid.kernal.processors.cache.query.GridCacheQueryInfo qryInfo,
                        @Nullable
                        List<GridIndexingFieldMetadata> metaData,
                        @Nullable
                        Collection<List<GridIndexingEntity<?>>> entities,
                        @Nullable
                        Collection<?> data,
                        boolean finished,
                        @Nullable
                        Throwable e)

Parameters:

loc - Local query or not.

qryInfo - Query info.

metaData - Meta data.

entities - Indexing entities.

data - Data.

finished - Last page or not.

e - Exception in case of error.

Returns:

true if page was processed right.

metrics

public GridCacheQueryMetrics metrics()

Gets cache queries metrics.

Returns:

Cache queries metrics.

resetMetrics

public void resetMetrics()

Resets metrics.

onMetricsUpdate

public void onMetricsUpdate(long duration,
                   boolean fail)

Parameters:

duration - Execution duration.

fail - true if execution failed.

sqlMetadata

public Collection<GridCacheSqlMetadata> sqlMetadata()
                                             throws GridException

Gets SQL metadata.

Returns:

SQL metadata.

Throws:

GridException - In case of error.

printMemoryStats

public void printMemoryStats()

Prints memory statistics for debugging purposes.

Specified by:

printMemoryStats in interface GridCacheManager<K,V>

Overrides:

printMemoryStats in class GridCacheManagerAdapter<K,V>

space

public String space()

FOR TESTING ONLY

Returns:

Indexing space for this query manager.