org.gridgain.grid.spi.indexing

Interface GridIndexingSpi

All Superinterfaces:

GridSpi

All Known Implementing Classes:

GridNoopIndexingSpi

public interface GridIndexingSpi
extends GridSpi

Indexing SPI allows user to index cache content. Using indexing SPI user can index data in cache and run SQL, TEXT or individual field queries against these indexes. Usually indexing SPI is used by caches by name (see GridCacheConfiguration.getIndexingSpiName()). Logically storage is organized into separate spaces. Usually cache name will be used as space name, so multiple caches can write to single indexing SPI instance.

Functionality of this SPI is exposed to GridCacheQueries interface:

• GridCacheQueries.createSqlQuery(Class, String)
• GridCacheQueries.createSqlFieldsQuery(String)
• GridCacheQueries.createFullTextQuery(Class, String)

The default indexing SPI implementation is GridH2IndexingSpi which uses H2 database engine for data indexing and querying. User can implement his own indexing SPI and use his own data structures and query language instead of SQL. SPI can be configured for grid using GridConfiguration.getIndexingSpi().

GridGain comes with following built-in indexing SPI implementations:

• GridH2IndexingSpi

NOTE: this SPI (i.e. methods in this interface) should never be used directly. SPIs provide internal view on the subsystem and is used internally by GridGain kernal. In rare use cases when access to a specific implementation of this SPI is required - an instance of this SPI can be obtained via Grid.configuration() method to check its configuration properties or call other non-SPI methods. Note again that calling methods from this interface on the obtained instance can lead to undefined behavior and explicitly not supported.

Method Summary

Methods

Modifier and Type	Method and Description
<K> void	onSwap(String spaceName, String swapSpaceName, K key) Will be called when entry with given key is swapped.
<K,V> void	onUnswap(String spaceName, K key, V val, byte[] valBytes) Will be called when entry with given key is unswapped.
<K,V> GridSpiCloseableIterator<GridIndexingKeyValueRow<K,V>>	query(String spaceName, String qry, Collection<Object> params, GridIndexingTypeDescriptor type, GridIndexingQueryFilter<K,V>... filters) Executes regular query.
<K,V> GridIndexingFieldsResult	queryFields(String spaceName, String qry, Collection<Object> params, GridIndexingQueryFilter<K,V>... filters) Queries individual fields (generally used by JDBC drivers).
<K,V> GridSpiCloseableIterator<GridIndexingKeyValueRow<K,V>>	queryText(String spaceName, String qry, GridIndexingTypeDescriptor type, GridIndexingQueryFilter<K,V>... filters) Executes text query.
void	rebuildIndexes(String spaceName, GridIndexingTypeDescriptor type) Rebuilds all indexes of given type.
void	registerMarshaller(GridIndexingMarshaller marshaller) Marshaller to be used by SPI.
void	registerSpace(String spaceName) Registers space in this SPI.
boolean	registerType(String spaceName, GridIndexingTypeDescriptor desc) Registers type if it was not known before or updates it otherwise.
<K> boolean	remove(String spaceName, GridIndexingEntity<K> key) Removes index entry by key.
long	size(String spaceName, GridIndexingTypeDescriptor desc) Gets size of index for given type or -1 if it is a unknown type.
<K,V> void	store(String spaceName, GridIndexingTypeDescriptor type, GridIndexingEntity<K> key, GridIndexingEntity<V> val, byte[] ver, long expirationTime) Updates index.
void	unregisterType(String spaceName, GridIndexingTypeDescriptor type) Unregisters type and removes all corresponding data.

Methods inherited from interface org.gridgain.grid.spi.GridSpi

getName, getNodeAttributes, onContextDestroyed, onContextInitialized, spiStart, spiStop

Method Detail

queryFields

<K,V> GridIndexingFieldsResult queryFields(@Nullable
                                         String spaceName,
                                         String qry,
                                         Collection<Object> params,
                                         GridIndexingQueryFilter<K,V>... filters)
                                     throws GridSpiException

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:

GridSpiException - If failed.

query

<K,V> GridSpiCloseableIterator<GridIndexingKeyValueRow<K,V>> query(@Nullable
                                                                 String spaceName,
                                                                 String qry,
                                                                 Collection<Object> params,
                                                                 GridIndexingTypeDescriptor type,
                                                                 GridIndexingQueryFilter<K,V>... filters)
                                                             throws GridSpiException

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:

GridSpiException - If failed.

queryText

<K,V> GridSpiCloseableIterator<GridIndexingKeyValueRow<K,V>> queryText(@Nullable
                                                                     String spaceName,
                                                                     String qry,
                                                                     GridIndexingTypeDescriptor type,
                                                                     GridIndexingQueryFilter<K,V>... filters)
                                                                 throws GridSpiException

Executes text query.

Parameters:

spaceName - Space name.

qry - Text query.

type - Query return type.

filters - Space name and key filter.

Returns:

Queried rows.

Throws:

GridSpiException - If failed.

size

long size(@Nullable
        String spaceName,
        GridIndexingTypeDescriptor desc)
          throws GridSpiException

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

Parameters:

spaceName - Space name.

desc - Type descriptor.

Returns:

Objects number.

Throws:

GridSpiException - If failed.

registerType

boolean registerType(@Nullable
                   String spaceName,
                   GridIndexingTypeDescriptor desc)
                     throws GridSpiException

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:

GridSpiException - If failed.

unregisterType

void unregisterType(@Nullable
                  String spaceName,
                  GridIndexingTypeDescriptor type)
                    throws GridSpiException

Unregisters type and removes all corresponding data.

Parameters:

spaceName - Space name.

type - Type descriptor.

Throws:

GridSpiException - If failed.

store

<K,V> void store(@Nullable
               String spaceName,
               GridIndexingTypeDescriptor type,
               GridIndexingEntity<K> key,
               GridIndexingEntity<V> val,
               byte[] ver,
               long expirationTime)
           throws GridSpiException

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:

GridSpiException - If failed.

remove

<K> boolean remove(@Nullable
                 String spaceName,
                 GridIndexingEntity<K> key)
               throws GridSpiException

Removes index entry by key.

Parameters:

spaceName - Space name.

key - Key.

Returns:

True if removed by this operation, false otherwise.

Throws:

GridSpiException - If failed.

onSwap

<K> void onSwap(@Nullable
              String spaceName,
              String swapSpaceName,
              K key)
            throws GridSpiException

Will be called when entry with given key is swapped.

Parameters:

spaceName - Space name.

swapSpaceName - Swap space name.

key - Key.

Throws:

GridSpiException - If failed.

onUnswap

<K,V> void onUnswap(@Nullable
                  String spaceName,
                  K key,
                  V val,
                  byte[] valBytes)
              throws GridSpiException

Will be called when entry with given key is unswapped.

Parameters:

spaceName - Space name.

key - Key.

val - Value.

valBytes - Value bytes.

Throws:

GridSpiException - If failed.

registerMarshaller

void registerMarshaller(GridIndexingMarshaller marshaller)

Marshaller to be used by SPI.

Parameters:

marshaller - Marshaller.

registerSpace

void registerSpace(String spaceName)
                   throws GridSpiException

Registers space in this SPI.

Parameters:

spaceName - Space name.

Throws:

GridSpiException - If failed.

rebuildIndexes

void rebuildIndexes(@Nullable
                  String spaceName,
                  GridIndexingTypeDescriptor type)

Rebuilds all indexes of given type.

Parameters:

spaceName - Space name.

type - Type descriptor.