org.gridgain.grid.cache.query

Interface GridCacheQueries<K,V>

All Known Subinterfaces:

GridCacheQueriesEx<K,V>

All Known Implementing Classes:

GridCacheQueriesImpl, GridCacheQueriesProxy

public interface GridCacheQueries<K,V>

Facade for creating distributed queries. It contains various 'createXxxQuery(..)' methods for SQL, TEXT, and SCAN query creation (see GridCacheQuery for more information).

Instance of GridCacheQueries is obtained from cache projection as follows:

 GridCacheQueries q = GridGain.grid().cache("myCache").queries();
 

Method Summary

Methods

Modifier and Type	Method and Description
GridCacheContinuousQuery<K,V>	createContinuousQuery() Creates new continuous query.
GridCacheQuery<Map.Entry<K,V>>	createFullTextQuery(Class<?> cls, String search) Creates user's full text query, queried class, and query clause.
GridCacheQuery<Map.Entry<K,V>>	createScanQuery(GridBiPredicate<K,V> filter) Creates user's predicate based scan query.
GridCacheQuery<List<?>>	createSqlFieldsQuery(String qry) Creates user's SQL fields query for given clause.
GridCacheQuery<Map.Entry<K,V>>	createSqlQuery(Class<?> cls, String clause) Creates user's SQL query, queried class, and query clause which is generally a where clause.
GridCacheQueryMetrics	metrics() Accumulated metrics for all queries executed for this cache.
GridFuture<?>	rebuildAllIndexes() Forces this cache to rebuild search indexes of all types.
GridFuture<?>	rebuildIndexes(Class<?> cls) Forces this cache to rebuild all search indexes of given value type.
void	resetMetrics() Resets accumulated metrics.

Method Detail

createSqlQuery

GridCacheQuery<Map.Entry<K,V>> createSqlQuery(Class<?> cls,
                                            String clause)

Creates user's SQL query, queried class, and query clause which is generally a where clause. For more information refer to GridCacheQuery documentation.

Parameters:

cls - Query class.

clause - Query clause.

Returns:

Created query.

createSqlFieldsQuery

GridCacheQuery<List<?>> createSqlFieldsQuery(String qry)

Creates user's SQL fields query for given clause. For more information refer to GridCacheQuery documentation.

Parameters:

qry - Query.

Returns:

Created query.

createFullTextQuery

GridCacheQuery<Map.Entry<K,V>> createFullTextQuery(Class<?> cls,
                                                 String search)

Creates user's full text query, queried class, and query clause. For more information refer to GridCacheQuery documentation.

Parameters:

cls - Query class.

search - Search clause.

Returns:

Created query.

createScanQuery

GridCacheQuery<Map.Entry<K,V>> createScanQuery(@Nullable
                                             GridBiPredicate<K,V> filter)

Creates user's predicate based scan query.

Parameters:

filter - Scan filter.

Returns:

Created query.

createContinuousQuery

GridCacheContinuousQuery<K,V> createContinuousQuery()

Creates new continuous query.

For more information refer to GridCacheContinuousQuery documentation.

Returns:

Created continuous query.

See Also:

GridCacheContinuousQuery

rebuildIndexes

GridFuture<?> rebuildIndexes(Class<?> cls)

Forces this cache to rebuild all search indexes of given value type. Sometimes indexes may hold references to objects that have already been removed from cache. Although not affecting query results, these objects may consume extra memory. Rebuilding indexes will remove any redundant references that may have temporarily got stuck inside in-memory index.

Parameters:

cls - Value type to rebuild indexes for.

Returns:

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

rebuildAllIndexes

GridFuture<?> rebuildAllIndexes()

Forces this cache to rebuild search indexes of all types. Sometimes indexes may hold references to objects that have already been removed from cache. Although not affecting query results, these objects may consume extra memory. Rebuilding indexes will remove any redundant references that may have temporarily got stuck inside in-memory index.

Returns:

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

metrics

GridCacheQueryMetrics metrics()

Accumulated metrics for all queries executed for this cache.

Returns:

Cache query metrics.

resetMetrics

void resetMetrics()

Resets accumulated metrics.