org.apache.ignite.internal.processors.query

Class GridQueryProcessor

java.lang.Object

org.apache.ignite.internal.processors.GridProcessorAdapter

org.apache.ignite.internal.processors.query.GridQueryProcessor

All Implemented Interfaces:

GridComponent, GridProcessor

public class GridQueryProcessor
extends GridProcessorAdapter

Indexing processor.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.ignite.internal.GridComponent

GridComponent.DiscoveryDataExchangeType

Field Summary

Fields

Modifier and Type	Field and Description
static Class<? extends GridQueryIndexing>	idxCls For tests.

Fields inherited from class org.apache.ignite.internal.processors.GridProcessorAdapter

ctx, log

Constructor Summary

Constructors

Constructor and Description
GridQueryProcessor(GridKernalContext ctx)

Method Summary

Methods

Modifier and Type	Method and Description
void	initializeCache(CacheConfiguration<?,?> ccfg)
static boolean	isEnabled(CacheConfiguration<?,?> ccfg)
MessageFactory	messageFactory()
void	onCacheStart(GridCacheContext cctx)
void	onCacheStop(GridCacheContext cctx)
void	onKernalStop(boolean cancel) Callback to notify that kernal is about to stop.
void	onSwap(String spaceName, CacheObject key) Will be called when entry for key will be swapped.
void	onUndeploy(String space, ClassLoader ldr) Removes index tables for all classes belonging to given class loader.
void	onUnswap(String spaceName, CacheObject key, CacheObject val) Will be called when entry for key will be unswapped.
<K,V> GridCloseableIterator<IgniteBiTuple<K,V>>	query(String space, String clause, Collection<Object> params, String resType, IndexingQueryFilter filters)
<K,V> GridQueryFieldsResult	queryFields(String space, String clause, Collection<Object> params, IndexingQueryFilter filters)
<K,V> Iterator<javax.cache.Cache.Entry<K,V>>	queryLocal(GridCacheContext<?,?> cctx, SqlQuery qry)
QueryCursor<List<?>>	queryLocalFields(GridCacheContext<?,?> cctx, SqlFieldsQuery qry)
<K,V> GridCloseableIterator<IgniteBiTuple<K,V>>	queryText(String space, String clause, String resType, IndexingQueryFilter filters)
QueryCursor<List<?>>	queryTwoStep(GridCacheContext<?,?> cctx, SqlFieldsQuery qry)
<K,V> QueryCursor<javax.cache.Cache.Entry<K,V>>	queryTwoStep(GridCacheContext<?,?> cctx, SqlQuery qry)
QueryCursor<List<?>>	queryTwoStep(String space, GridCacheTwoStepQuery qry)
IgniteInternalFuture<?>	rebuildAllIndexes() Rebuilds all search indexes for given spi.
IgniteInternalFuture<?>	rebuildIndexes(String space, String valTypeName) Rebuilds all search indexes of given value type for given space of spi.
void	remove(String space, CacheObject key, CacheObject val)
long	size(String space, Class<?> valType) Returns number of objects of given type for given space of spi.
void	start() Starts grid component.
void	stop(boolean cancel) Stops grid component.
void	store(String space, CacheObject key, CacheObject val, byte[] ver, long expirationTime) Writes key-value pair to index.
GridQueryTypeDescriptor	type(String space, String typeName) Gets type descriptor for space and type name.
static String	typeName(Class<?> cls) Gets type name by class.
Collection<GridQueryTypeDescriptor>	types(String space) Gets types for space.

Methods inherited from class org.apache.ignite.internal.processors.GridProcessorAdapter

assertParameter, collectDiscoveryData, discoveryDataType, onDiscoveryDataReceived, onKernalStart, printMemoryStats, toString, validateNode

Methods inherited from class java.lang.Object

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

Field Detail

idxCls

public static Class<? extends GridQueryIndexing> idxCls

For tests.

Constructor Detail

GridQueryProcessor

public GridQueryProcessor(GridKernalContext ctx)
                   throws IgniteCheckedException

Parameters:

ctx - Kernal context.

Throws:

IgniteCheckedException

Method Detail

start

public void start()
           throws IgniteCheckedException

Starts grid component.

Specified by:

start in interface GridComponent

Overrides:

start in class GridProcessorAdapter

Throws:

IgniteCheckedException - Throws in case of any errors.

isEnabled

public static boolean isEnabled(CacheConfiguration<?,?> ccfg)

Parameters:

ccfg - Cache configuration.

Returns:

true If query index must be enabled for this cache.

initializeCache

public void initializeCache(CacheConfiguration<?,?> ccfg)
                     throws IgniteCheckedException

Parameters:

ccfg - Cache configuration.

Throws:

IgniteCheckedException - If failed.

onKernalStop

public void onKernalStop(boolean cancel)

Callback to notify that kernal is about to stop.

Specified by:

onKernalStop in interface GridComponent

Overrides:

onKernalStop in class GridProcessorAdapter

Parameters:

cancel - Flag indicating whether jobs should be canceled.

stop

public void stop(boolean cancel)
          throws IgniteCheckedException

Stops grid component.

Specified by:

stop in interface GridComponent

Overrides:

stop in class GridProcessorAdapter

Parameters:

cancel - If true, then all ongoing tasks or jobs for relevant components need to be cancelled.

Throws:

IgniteCheckedException - Thrown in case of any errors.

onCacheStart

public void onCacheStart(GridCacheContext cctx)
                  throws IgniteCheckedException

Parameters:

cctx - Cache context.

Throws:

IgniteCheckedException - If failed.

onCacheStop

public void onCacheStop(GridCacheContext cctx)

Parameters:

cctx - Cache context.

size

public long size(@Nullable
        String space,
        Class<?> valType)
          throws IgniteCheckedException

Returns number of objects of given type for given space of spi.

Parameters:

space - Space.

valType - Value type.

Returns:

Objects number or -1 if this type is unknown for given SPI and space.

Throws:

IgniteCheckedException - If failed.

rebuildIndexes

public IgniteInternalFuture<?> rebuildIndexes(@Nullable
                                     String space,
                                     String valTypeName)

Rebuilds all search indexes of given value type for given space of spi.

Parameters:

space - Space.

valTypeName - Value type name.

Returns:

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

rebuildAllIndexes

public IgniteInternalFuture<?> rebuildAllIndexes()

Rebuilds all search indexes for given spi.

Returns:

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

store

public void store(String space,
         CacheObject key,
         CacheObject val,
         byte[] ver,
         long expirationTime)
           throws IgniteCheckedException

Writes key-value pair to index.

Parameters:

space - Space.

key - Key.

val - Value.

ver - Cache entry version.

expirationTime - Expiration time or 0 if never expires.

Throws:

IgniteCheckedException - In case of error.

query

public <K,V> GridCloseableIterator<IgniteBiTuple<K,V>> query(String space,
                                                    String clause,
                                                    Collection<Object> params,
                                                    String resType,
                                                    IndexingQueryFilter filters)
                                                throws IgniteCheckedException

Parameters:

space - Space.

clause - Clause.

params - Parameters collection.

resType - Result type.

filters - Filters.

Returns:

Key/value rows.

Throws:

IgniteCheckedException - If failed.

queryTwoStep

public QueryCursor<List<?>> queryTwoStep(String space,
                                GridCacheTwoStepQuery qry)

Parameters:

space - Space name.

qry - Query.

Returns:

Cursor.

queryTwoStep

public QueryCursor<List<?>> queryTwoStep(GridCacheContext<?,?> cctx,
                                SqlFieldsQuery qry)

Parameters:

cctx - Cache context.

qry - Query.

Returns:

Cursor.

queryTwoStep

public <K,V> QueryCursor<javax.cache.Cache.Entry<K,V>> queryTwoStep(GridCacheContext<?,?> cctx,
                                                           SqlQuery qry)

Parameters:

cctx - Cache context.

qry - Query.

Returns:

Cursor.

queryLocal

public <K,V> Iterator<javax.cache.Cache.Entry<K,V>> queryLocal(GridCacheContext<?,?> cctx,
                                                      SqlQuery qry)

Parameters:

cctx - Cache context.

qry - Query.

Returns:

Cursor.

messageFactory

public MessageFactory messageFactory()

Returns:

Message factory for GridIoManager.

queryLocalFields

public QueryCursor<List<?>> queryLocalFields(GridCacheContext<?,?> cctx,
                                    SqlFieldsQuery qry)

Parameters:

cctx - Cache context.

qry - Query.

Returns:

Iterator.

remove

public void remove(String space,
          CacheObject key,
          CacheObject val)
            throws IgniteCheckedException

Parameters:

space - Space.

key - Key.

Throws:

IgniteCheckedException - Thrown in case of any errors.

typeName

public static String typeName(Class<?> cls)

Gets type name by class.

Parameters:

cls - Class.

Returns:

Type name.

queryText

public <K,V> GridCloseableIterator<IgniteBiTuple<K,V>> queryText(String space,
                                                        String clause,
                                                        String resType,
                                                        IndexingQueryFilter filters)
                                                    throws IgniteCheckedException

Type Parameters:

K - Key type.

V - Value type.

Parameters:

space - Space.

clause - Clause.

resType - Result type.

filters - Key and value filters.

Returns:

Key/value rows.

Throws:

IgniteCheckedException - If failed.

queryFields

public <K,V> GridQueryFieldsResult queryFields(@Nullable
                                      String space,
                                      String clause,
                                      Collection<Object> params,
                                      IndexingQueryFilter filters)
                                  throws IgniteCheckedException

Parameters:

space - Space name.

clause - Clause.

params - Parameters collection.

filters - Key and value filters.

Returns:

Field rows.

Throws:

IgniteCheckedException - If failed.

onSwap

public void onSwap(String spaceName,
          CacheObject key)
            throws IgniteCheckedException

Will be called when entry for key will be swapped.

Parameters:

spaceName - Space name.

key - key.

Throws:

IgniteCheckedException - If failed.

onUnswap

public void onUnswap(String spaceName,
            CacheObject key,
            CacheObject val)
              throws IgniteCheckedException

Will be called when entry for key will be unswapped.

Parameters:

spaceName - Space name.

key - Key.

val - Value.

Throws:

IgniteCheckedException - If failed.

onUndeploy

public void onUndeploy(@Nullable
              String space,
              ClassLoader ldr)
                throws IgniteCheckedException

Removes index tables for all classes belonging to given class loader.

Parameters:

space - Space name.

ldr - Class loader to undeploy.

Throws:

IgniteCheckedException - If undeploy failed.

types

public Collection<GridQueryTypeDescriptor> types(@Nullable
                                        String space)

Gets types for space.

Parameters:

space - Space name.

Returns:

Descriptors.

type

public GridQueryTypeDescriptor type(@Nullable
                           String space,
                           String typeName)
                             throws IgniteCheckedException

Gets type descriptor for space and type name.

Parameters:

space - Space name.

typeName - Type name.

Returns:

Type descriptor.

Throws:

IgniteCheckedException - If failed.