org.apache.ignite.internal.processors.query

Interface GridQueryIndexing

public interface GridQueryIndexing

Abstraction for internal indexing implementation.

Method Summary

Methods

Modifier and Type	Method and Description
IndexingQueryFilter	backupFilter() Returns backup filter.
void	onSwap(String spaceName, Object key) Will be called when entry with given key is swapped.
void	onUnswap(String spaceName, Object key, Object val, byte[] valBytes) Will be called when entry with given key is unswapped.
<K,V> GridCloseableIterator<IgniteBiTuple<K,V>>	query(String spaceName, String qry, Collection<Object> params, GridQueryTypeDescriptor type, IndexingQueryFilter filters) Executes regular query.
GridQueryFieldsResult	queryFields(String spaceName, String qry, Collection<Object> params, IndexingQueryFilter filters) Queries individual fields (generally used by JDBC drivers).
<K,V> GridCloseableIterator<IgniteBiTuple<K,V>>	queryText(String spaceName, String qry, GridQueryTypeDescriptor type, IndexingQueryFilter filters) Executes text query.
QueryCursor<List<?>>	queryTwoStep(GridCacheContext<?,?> cctx, GridCacheTwoStepQuery qry) Runs two step query.
QueryCursor<List<?>>	queryTwoStep(GridCacheContext<?,?> cctx, SqlFieldsQuery qry) Parses SQL query into two step query and executes it.
<K,V> QueryCursor<javax.cache.Cache.Entry<K,V>>	queryTwoStep(GridCacheContext<?,?> cctx, SqlQuery qry) Parses SQL query into two step query and executes it.
void	rebuildIndexes(String spaceName, GridQueryTypeDescriptor type) Rebuilds all indexes of given type.
void	registerCache(CacheConfiguration<?,?> ccfg) Registers cache.
boolean	registerType(String spaceName, GridQueryTypeDescriptor desc) Registers type if it was not known before or updates it otherwise.
void	remove(String spaceName, Object key, Object val) Removes index entry by key.
long	size(String spaceName, GridQueryTypeDescriptor desc, IndexingQueryFilter filters) Gets size of index for given type or -1 if it is a unknown type.
void	start(GridKernalContext ctx) Starts indexing.
void	stop() Stops indexing.
void	store(String spaceName, GridQueryTypeDescriptor type, Object key, Object val, byte[] ver, long expirationTime) Updates index.
void	unregisterCache(CacheConfiguration<?,?> ccfg) Deregisters cache.
void	unregisterType(String spaceName, GridQueryTypeDescriptor type) Unregisters type and removes all corresponding data.

Method Detail

start

void start(GridKernalContext ctx)
           throws IgniteCheckedException

Starts indexing.

Parameters:

ctx - Context.

Throws:

IgniteCheckedException - If failed.

stop

void stop()
          throws IgniteCheckedException

Stops indexing.

Throws:

IgniteCheckedException - If failed.

queryTwoStep

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

Runs two step query.

Parameters:

cctx - Cache context.

qry - Query.

Returns:

Cursor.

queryTwoStep

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

Parses SQL query into two step query and executes it.

Parameters:

cctx - Cache context.

qry - Query.

Returns:

Cursor.

queryTwoStep

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

Parses SQL query into two step query and executes it.

Parameters:

cctx - Cache context.

qry - Query.

Returns:

Cursor.

queryFields

GridQueryFieldsResult queryFields(@Nullable
                                String spaceName,
                                String qry,
                                Collection<Object> params,
                                IndexingQueryFilter filters)
                                  throws IgniteCheckedException

Queries individual fields (generally used by JDBC drivers).

Parameters:

spaceName - Space name.

qry - Query.

params - Query parameters.

filters - Space name and key filters.

Returns:

Query result.

Throws:

IgniteCheckedException - If failed.

query

<K,V> GridCloseableIterator<IgniteBiTuple<K,V>> query(@Nullable
                                                    String spaceName,
                                                    String qry,
                                                    Collection<Object> params,
                                                    GridQueryTypeDescriptor type,
                                                    IndexingQueryFilter filters)
                                                throws IgniteCheckedException

Executes regular query.

Parameters:

spaceName - Space name.

qry - Query.

params - Query parameters.

type - Query return type.

filters - Space name and key filters.

Returns:

Queried rows.

Throws:

IgniteCheckedException - If failed.

queryText

<K,V> GridCloseableIterator<IgniteBiTuple<K,V>> queryText(@Nullable
                                                        String spaceName,
                                                        String qry,
                                                        GridQueryTypeDescriptor type,
                                                        IndexingQueryFilter filters)
                                                    throws IgniteCheckedException

Executes text query.

Parameters:

spaceName - Space name.

qry - Text query.

type - Query return type.

filters - Space name and key filter.

Returns:

Queried rows.

Throws:

IgniteCheckedException - If failed.

size

long size(@Nullable
        String spaceName,
        GridQueryTypeDescriptor desc,
        IndexingQueryFilter filters)
          throws IgniteCheckedException

Gets size of index for given type or -1 if it is a unknown type.

Parameters:

spaceName - Space name.

desc - Type descriptor.

filters - Filters.

Returns:

Objects number.

Throws:

IgniteCheckedException - If failed.

registerCache

void registerCache(CacheConfiguration<?,?> ccfg)
                   throws IgniteCheckedException

Registers cache.

Parameters:

ccfg - Cache configuration.

Throws:

IgniteCheckedException - If failed.

unregisterCache

void unregisterCache(CacheConfiguration<?,?> ccfg)
                     throws IgniteCheckedException

Deregisters cache.

Parameters:

ccfg - Cache configuration.

Throws:

IgniteCheckedException - If failed to drop cache schema.

registerType

boolean registerType(@Nullable
                   String spaceName,
                   GridQueryTypeDescriptor desc)
                     throws IgniteCheckedException

Registers type if it was not known before or updates it otherwise.

Parameters:

spaceName - Space name.

desc - Type descriptor.

Returns:

True if type was registered, false if for some reason it was rejected.

Throws:

IgniteCheckedException - If failed.

unregisterType

void unregisterType(@Nullable
                  String spaceName,
                  GridQueryTypeDescriptor type)
                    throws IgniteCheckedException

Unregisters type and removes all corresponding data.

Parameters:

spaceName - Space name.

type - Type descriptor.

Throws:

IgniteCheckedException - If failed.

store

void store(@Nullable
         String spaceName,
         GridQueryTypeDescriptor type,
         Object key,
         Object val,
         byte[] ver,
         long expirationTime)
           throws IgniteCheckedException

Updates index. Note that key is unique for space, so if space contains multiple indexes the key should be removed from indexes other than one being updated.

Parameters:

spaceName - Space name.

type - Value type.

key - Key.

val - Value.

ver - Version.

expirationTime - Expiration time or 0 if never expires.

Throws:

IgniteCheckedException - If failed.

remove

void remove(@Nullable
          String spaceName,
          Object key,
          Object val)
            throws IgniteCheckedException

Removes index entry by key.

Parameters:

spaceName - Space name.

key - Key.

val - Value.

Throws:

IgniteCheckedException - If failed.

onSwap

void onSwap(@Nullable
          String spaceName,
          Object key)
            throws IgniteCheckedException

Will be called when entry with given key is swapped.

Parameters:

spaceName - Space name.

key - Key.

Throws:

IgniteCheckedException - If failed.

onUnswap

void onUnswap(@Nullable
            String spaceName,
            Object key,
            Object val,
            byte[] valBytes)
              throws IgniteCheckedException

Will be called when entry with given key is unswapped.

Parameters:

spaceName - Space name.

key - Key.

val - Value.

valBytes - Value bytes.

Throws:

IgniteCheckedException - If failed.

rebuildIndexes

void rebuildIndexes(@Nullable
                  String spaceName,
                  GridQueryTypeDescriptor type)

Rebuilds all indexes of given type.

Parameters:

spaceName - Space name.

type - Type descriptor.

backupFilter

IndexingQueryFilter backupFilter()

Returns backup filter.

Returns:

Backup filter.