org.gridgain.grid.spi.indexing.h2

Class GridH2IndexingSpi

java.lang.Object

org.gridgain.grid.spi.GridSpiAdapter

org.gridgain.grid.spi.indexing.h2.GridH2IndexingSpi

All Implemented Interfaces:

org.gridgain.grid.spi.GridSpi, org.gridgain.grid.spi.GridSpiManagementMBean, org.gridgain.grid.spi.indexing.GridIndexingSpi, GridH2IndexingSpiMBean

@GridSpiMultipleInstancesSupport(value=true)
public class GridH2IndexingSpi
extends org.gridgain.grid.spi.GridSpiAdapter
implements org.gridgain.grid.spi.indexing.GridIndexingSpi, GridH2IndexingSpiMBean

Indexing SPI implementation based on H2 database engine. In this implementation main query language is SQL, fulltext indexing can be performed using Lucene or using embedded H2 mechanism. For each registered space the SPI will create respective schema, for default space (where space name is null) schema with name PUBLIC will be used. To avoid name conflicts user should not explicitly name a schema PUBLIC.

For each registered GridIndexingTypeDescriptor this SPI will create respective SQL table with '_key' and '_val' fields for key and value, and fields from GridIndexingTypeDescriptor.keyFields() and GridIndexingTypeDescriptor.valueFields(). For each table it will create indexes declared in GridIndexingTypeDescriptor.indexes().

Note that you can monitor longer queries by setting setLongQueryExplain(boolean) to true. In this case a warning and execution plan are printed out if query exceeds certain time threshold. The time threshold for long queries is configured via setLongQueryExecutionTimeout(long) parameter.

Configuration

Mandatory

This SPI has no mandatory configuration parameters.

Optional

The following configuration parameters are optional:

• Whether SPI will convert key type to SQL type or store keys in binary form (see setDefaultIndexFixedTyping(boolean))
• Whether SPI will create tables for each primitive key-value pair (see setDefaultIndexPrimitiveKey(boolean))
• Whether SPI will create indexes for each primitive value (see setDefaultIndexPrimitiveValue(boolean))
• Search path for SQL objects (see setSearchPath(String...))
• Off-heap memory (see setMaxOffHeapMemory(long))
• Deserialized off-heap rows cache size (see setMaxOffheapRowsCacheSize(int))
• Name (see GridSpiAdapter.setName(String))
• SPI will issue a warning if query execution takes longer than specified period in milliseconds (see setLongQueryExecutionTimeout(long))
• Whether SPI will print execution plan for slow queries (see setLongQueryExplain(boolean))
• Classes containing user defined functions (see setIndexCustomFunctionClasses(Class[]))
• Per-space configurations (see setSpaceConfigurations(GridH2IndexingSpaceConfiguration...))

Some important defaults.

• All the data will be kept in memory
• Primitive types will not be indexed (e.g. java types which can be directly converted to SQL types)
• Key types will be converted to SQL types, so it is impossible to store one value type with different key types

Here is a Java example on how to configure grid with GridH2IndexingSpi.

 GridH2IndexingSpi spi = new GridH2IndexingSpi();

 // Set SPI name.
 spi.setName(name);

 spi.setDefaultIndexPrimitiveKey(true);
 spi.setDefaultIndexPrimitiveValue(true);

 GridConfiguration cfg = new GridConfiguration();

 // Overrides default indexing SPI.
 cfg.setIndexingSpi(spi);

 // Starts grid.
 G.start(cfg);
 

Here is an example of how to configure GridH2IndexingSpi from Spring XML configuration file.

 <property name="indexingSpi">
     <list>
         <bean class="org.gridgain.grid.spi.indexing.h2.GridH2IndexingSpi">
             <!-- Index primitives. -->
             <property name="defaultIndexPrimitiveKey" value="true"/>

             <!-- Allow different key types for one value type. -->
             <property name="defaultIndexFixedTyping" value="false"/>
         </bean>
     </list>
 </property>
 

For information about Spring framework visit www.springframework.org

See Also:

GridIndexingSpi

Field Summary

Fields

Modifier and Type	Field and Description
static long	DFLT_LONG_QRY_EXEC_TIMEOUT Default query execution time interpreted as long query (3 seconds).
static String	EXPIRATION_TIME_FIELD_NAME Field name for value expiration time.
static String	KEY_FIELD_NAME Field name for key.
static String	VAL_FIELD_NAME Field name for value.
static String	VAL_STR_FIELD_NAME Field name for string representation of value.
static String	VER_FIELD_NAME Field name for value version.

Constructor Summary

Constructors

Constructor and Description
GridH2IndexingSpi()

Method Summary

Methods

Modifier and Type	Method and Description
long	getAllocatedOffHeapMemory() Gets currently allocated offheap memory.
long	getIndexWriteLockWaitTime() Gets index write lock wait time in milliseconds.
String	getInitialScriptPath() Gets script path to be ran against H2 database after opening.
long	getLongQueryExecutionTimeout() Get query execution time interpreted by SPI as long query for additional handling (e.g.
long	getMaxOffHeapMemory() Gets maximum amount of memory available to off-heap storage.
int	getMaxOffheapRowsCacheSize() Gets maximum allowed off-heap rows cache size in items.
int	getOffheapRowsCacheSize() Gets current off-heap rows cache size in items.
String[]	getSearchPath() Gets the optional search path consisting of space names to search SQL schema objects.
String	getSpaceNames() Gets all registered in this SPI spaces comma separated.
protected org.gridgain.grid.spi.GridSpiContext	getSpiContext()
boolean	isDefaultIndexFixedTyping() If false, SPI will store all keys in BINARY form to make it possible to store the same value type with different key types.
boolean	isDefaultIndexPrimitiveKey() Gets if SPI will index primitive key-value pairs by key.
boolean	isDefaultIndexPrimitiveValue() Gets if SPI will index primitive key-value pairs by value.
boolean	isIndexFixedTyping(String spaceName) If false, SPI will store all keys in BINARY form to make it possible to store the same value type with different key types.
boolean	isIndexPrimitiveKey(String spaceName) Defines whether indexing SPI will index by key entries where key and value are primitive types in given space.
boolean	isIndexPrimitiveValue(String spaceName) Defines whether indexing SPI will index by value entries where key and value are primitive types in given space.
boolean	isLongQueryExplain() If true, SPI prints SQL execution plan for long queries (explain SQL query).
protected void	onContextInitialized0(org.gridgain.grid.spi.GridSpiContext spiCtx)
<K> void	onSwap(String spaceName, String swapSpaceName, K key)
<K,V> void	onUnswap(String spaceName, K key, V val, byte[] valBytes)
<K,V> org.gridgain.grid.spi.GridSpiCloseableIterator<org.gridgain.grid.spi.indexing.GridIndexingKeyValueRow<K,V>>	query(String spaceName, String qry, Collection<Object> params, org.gridgain.grid.spi.indexing.GridIndexingTypeDescriptor type, org.gridgain.grid.spi.indexing.GridIndexingQueryFilter<K,V>... filters) Executes regular query.
<K,V> org.gridgain.grid.spi.indexing.GridIndexingFieldsResult	queryFields(String spaceName, String qry, Collection<Object> params, org.gridgain.grid.spi.indexing.GridIndexingQueryFilter<K,V>... filters)
<K,V> org.gridgain.grid.spi.GridSpiCloseableIterator<org.gridgain.grid.spi.indexing.GridIndexingKeyValueRow<K,V>>	queryText(String spaceName, String qry, org.gridgain.grid.spi.indexing.GridIndexingTypeDescriptor type, org.gridgain.grid.spi.indexing.GridIndexingQueryFilter<K,V>... filters)
void	rebuildIndexes(String spaceName, org.gridgain.grid.spi.indexing.GridIndexingTypeDescriptor type)
void	registerMarshaller(org.gridgain.grid.spi.indexing.GridIndexingMarshaller marshaller)
void	registerSpace(String spaceName)
boolean	registerType(String spaceName, org.gridgain.grid.spi.indexing.GridIndexingTypeDescriptor type) Registers new class description.
<K> boolean	remove(String spaceName, org.gridgain.grid.spi.indexing.GridIndexingEntity<K> k)
void	setDefaultIndexFixedTyping(boolean dfltIdxFixedTyping) This flag essentially controls whether all values of the same type have identical key type.
void	setDefaultIndexPrimitiveKey(boolean dfltIdxPrimitiveKey) Sets if SPI will index primitive key-value pairs by key.
void	setDefaultIndexPrimitiveValue(boolean dfltIdxPrimitiveVal) Sets if SPI will index primitive key-value pairs by value.
void	setIndexCustomFunctionClasses(Class<?>... idxCustomFuncClss) Sets classes with methods annotated by GridCacheQuerySqlFunction to be used as user-defined functions from SQL queries.
void	setIndexWriteLockWaitTime(long idxWriteLockWaitTime) Sets index write lock wait time in milliseconds.
void	setInitialScriptPath(String initScriptPath) Sets script path to be ran against H2 database after opening.
void	setLongQueryExecutionTimeout(long longQryExecTimeout) Set query execution time threshold.
void	setLongQueryExplain(boolean longQryExplain) If true, SPI will print SQL execution plan for long queries (explain SQL query).
void	setMaxOffHeapMemory(long maxOffHeapMemory) Sets maximum amount of memory available to off-heap storage.
void	setMaxOffheapRowsCacheSize(int size) Specifies max allowed size of cache for deserialized offheap rows to avoid deserialization costs for most frequently used ones.
void	setSearchPath(String... searchPath) Sets the optional search path consisting of space names to search SQL schema objects.
void	setSpaceConfigurations(GridH2IndexingSpaceConfiguration... spaceCfgs) Sets per-space configurations.
long	size(String spaceName, org.gridgain.grid.spi.indexing.GridIndexingTypeDescriptor type)
void	spiStart(String gridName)
void	spiStop()
<K,V> void	store(String spaceName, org.gridgain.grid.spi.indexing.GridIndexingTypeDescriptor type, org.gridgain.grid.spi.indexing.GridIndexingEntity<K> k, org.gridgain.grid.spi.indexing.GridIndexingEntity<V> v, byte[] ver, long expirationTime)
void	unregisterType(String spaceName, org.gridgain.grid.spi.indexing.GridIndexingTypeDescriptor type)

Methods inherited from class org.gridgain.grid.spi.GridSpiAdapter

assertParameter, checkConfigurationConsistency0, configInfo, createSpiAttributeName, getConsistentAttributeNames, getGridGainHome, getLocalNodeId, getName, getNodeAttributes, getStartTimestamp, getStartTimestampFormatted, getUpTime, getUpTimeFormatted, injectables, onContextDestroyed, onContextDestroyed0, onContextInitialized, registerMBean, setName, startInfo, startStopwatch, stopInfo, unregisterMBean

Methods inherited from class java.lang.Object

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

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

getName, getNodeAttributes, onContextDestroyed, onContextInitialized

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

getGridGainHome, getLocalNodeId, getName, getStartTimestamp, getStartTimestampFormatted, getUpTime, getUpTimeFormatted

Field Detail

DFLT_LONG_QRY_EXEC_TIMEOUT

public static final long DFLT_LONG_QRY_EXEC_TIMEOUT

Default query execution time interpreted as long query (3 seconds).

See Also:

Constant Field Values

KEY_FIELD_NAME

public static final String KEY_FIELD_NAME

Field name for key.

See Also:

Constant Field Values

VAL_FIELD_NAME

public static final String VAL_FIELD_NAME

Field name for value.

See Also:

Constant Field Values

VAL_STR_FIELD_NAME

public static final String VAL_STR_FIELD_NAME

Field name for string representation of value.

See Also:

Constant Field Values

VER_FIELD_NAME

public static final String VER_FIELD_NAME

Field name for value version.

See Also:

Constant Field Values

EXPIRATION_TIME_FIELD_NAME

public static final String EXPIRATION_TIME_FIELD_NAME

Field name for value expiration time.

See Also:

Constant Field Values

Constructor Detail

GridH2IndexingSpi

public GridH2IndexingSpi()

Method Detail

store

public <K,V> void store(@Nullable
               String spaceName,
               org.gridgain.grid.spi.indexing.GridIndexingTypeDescriptor type,
               org.gridgain.grid.spi.indexing.GridIndexingEntity<K> k,
               org.gridgain.grid.spi.indexing.GridIndexingEntity<V> v,
               byte[] ver,
               long expirationTime)
           throws org.gridgain.grid.spi.GridSpiException

Specified by:

store in interface org.gridgain.grid.spi.indexing.GridIndexingSpi

Throws:

org.gridgain.grid.spi.GridSpiException

remove

public <K> boolean remove(@Nullable
                 String spaceName,
                 org.gridgain.grid.spi.indexing.GridIndexingEntity<K> k)
               throws org.gridgain.grid.spi.GridSpiException

Specified by:

remove in interface org.gridgain.grid.spi.indexing.GridIndexingSpi

Throws:

org.gridgain.grid.spi.GridSpiException

onContextInitialized0

protected void onContextInitialized0(org.gridgain.grid.spi.GridSpiContext spiCtx)
                              throws org.gridgain.grid.spi.GridSpiException

Overrides:

onContextInitialized0 in class org.gridgain.grid.spi.GridSpiAdapter

Throws:

org.gridgain.grid.spi.GridSpiException

getSpiContext

protected org.gridgain.grid.spi.GridSpiContext getSpiContext()

Overrides:

getSpiContext in class org.gridgain.grid.spi.GridSpiAdapter

onSwap

public <K> void onSwap(@Nullable
              String spaceName,
              String swapSpaceName,
              K key)
            throws org.gridgain.grid.spi.GridSpiException

Specified by:

onSwap in interface org.gridgain.grid.spi.indexing.GridIndexingSpi

Throws:

org.gridgain.grid.spi.GridSpiException

onUnswap

public <K,V> void onUnswap(@Nullable
                  String spaceName,
                  K key,
                  V val,
                  byte[] valBytes)
              throws org.gridgain.grid.spi.GridSpiException

Specified by:

onUnswap in interface org.gridgain.grid.spi.indexing.GridIndexingSpi

Throws:

org.gridgain.grid.spi.GridSpiException

queryText

public <K,V> org.gridgain.grid.spi.GridSpiCloseableIterator<org.gridgain.grid.spi.indexing.GridIndexingKeyValueRow<K,V>> queryText(@Nullable
                                                                                                                          String spaceName,
                                                                                                                          String qry,
                                                                                                                          org.gridgain.grid.spi.indexing.GridIndexingTypeDescriptor type,
                                                                                                                          org.gridgain.grid.spi.indexing.GridIndexingQueryFilter<K,V>... filters)
                                                                                                                      throws org.gridgain.grid.spi.GridSpiException

Specified by:

queryText in interface org.gridgain.grid.spi.indexing.GridIndexingSpi

Throws:

org.gridgain.grid.spi.GridSpiException

unregisterType

public void unregisterType(@Nullable
                  String spaceName,
                  org.gridgain.grid.spi.indexing.GridIndexingTypeDescriptor type)
                    throws org.gridgain.grid.spi.GridSpiException

Specified by:

unregisterType in interface org.gridgain.grid.spi.indexing.GridIndexingSpi

Throws:

org.gridgain.grid.spi.GridSpiException

queryFields

public <K,V> org.gridgain.grid.spi.indexing.GridIndexingFieldsResult queryFields(@Nullable
                                                                        String spaceName,
                                                                        String qry,
                                                                        @Nullable
                                                                        Collection<Object> params,
                                                                        org.gridgain.grid.spi.indexing.GridIndexingQueryFilter<K,V>... filters)
                                                                    throws org.gridgain.grid.spi.GridSpiException

Specified by:

queryFields in interface org.gridgain.grid.spi.indexing.GridIndexingSpi

Throws:

org.gridgain.grid.spi.GridSpiException

query

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

Executes regular query. Note that SQL query can not refer to table alias, so use full table name instead.

Specified by:

query in interface org.gridgain.grid.spi.indexing.GridIndexingSpi

Parameters:

spaceName - Space name.

qry - Query.

params - Query parameters.

type - Query return type.

filters - Space name and key filters.

Returns:

Queried rows.

Throws:

org.gridgain.grid.spi.GridSpiException - If failed.

registerType

public boolean registerType(@Nullable
                   String spaceName,
                   org.gridgain.grid.spi.indexing.GridIndexingTypeDescriptor type)
                     throws org.gridgain.grid.spi.GridSpiException

Registers new class description. This implementation doesn't support type reregistration.

Specified by:

registerType in interface org.gridgain.grid.spi.indexing.GridIndexingSpi

Parameters:

type - Type description.

Throws:

org.gridgain.grid.spi.GridSpiException - In case of error.

rebuildIndexes

public void rebuildIndexes(@Nullable
                  String spaceName,
                  org.gridgain.grid.spi.indexing.GridIndexingTypeDescriptor type)

Specified by:

rebuildIndexes in interface org.gridgain.grid.spi.indexing.GridIndexingSpi

size

public long size(@Nullable
        String spaceName,
        org.gridgain.grid.spi.indexing.GridIndexingTypeDescriptor type)
          throws org.gridgain.grid.spi.GridSpiException

Specified by:

size in interface org.gridgain.grid.spi.indexing.GridIndexingSpi

Throws:

org.gridgain.grid.spi.GridSpiException

spiStart

public void spiStart(@Nullable
            String gridName)
              throws org.gridgain.grid.spi.GridSpiException

Specified by:

spiStart in interface org.gridgain.grid.spi.GridSpi

Throws:

org.gridgain.grid.spi.GridSpiException

spiStop

public void spiStop()
             throws org.gridgain.grid.spi.GridSpiException

Specified by:

spiStop in interface org.gridgain.grid.spi.GridSpi

Throws:

org.gridgain.grid.spi.GridSpiException

setIndexCustomFunctionClasses

public void setIndexCustomFunctionClasses(Class<?>... idxCustomFuncClss)

Sets classes with methods annotated by GridCacheQuerySqlFunction to be used as user-defined functions from SQL queries.

Parameters:

idxCustomFuncClss - List of classes.

getSpaceNames

public String getSpaceNames()

Gets all registered in this SPI spaces comma separated.

Specified by:

getSpaceNames in interface GridH2IndexingSpiMBean

Returns:

Collection of space names.

getLongQueryExecutionTimeout

public long getLongQueryExecutionTimeout()

Get query execution time interpreted by SPI as long query for additional handling (e.g. print warning).

Specified by:

getLongQueryExecutionTimeout in interface GridH2IndexingSpiMBean

Returns:

Long query execution time.

See Also:

GridH2IndexingSpiMBean.isLongQueryExplain()

setLongQueryExecutionTimeout

@GridSpiConfiguration(optional=true)
public void setLongQueryExecutionTimeout(long longQryExecTimeout)

Set query execution time threshold. If queries exceed this threshold, then a warning will be printed out. If setLongQueryExplain(boolean) is set to true, then execution plan will be printed out as well.

If not provided, default value is defined by DFLT_LONG_QRY_EXEC_TIMEOUT.

Parameters:

longQryExecTimeout - Long query execution timeout.

See Also:

setLongQueryExplain(boolean)

isLongQueryExplain

public boolean isLongQueryExplain()

If true, SPI prints SQL execution plan for long queries (explain SQL query).

Specified by:

isLongQueryExplain in interface GridH2IndexingSpiMBean

Returns:

Flag marking SPI should print SQL execution plan for long queries (explain SQL query).

See Also:

GridH2IndexingSpiMBean.getLongQueryExecutionTimeout()

setLongQueryExplain

@GridSpiConfiguration(optional=true)
public void setLongQueryExplain(boolean longQryExplain)

If true, SPI will print SQL execution plan for long queries (explain SQL query). The time threshold of long queries is controlled via setLongQueryExecutionTimeout(long) parameter.

If not provided, default value is false.

Parameters:

longQryExplain - Flag marking SPI should print SQL execution plan for long queries (explain SQL query).

See Also:

setLongQueryExecutionTimeout(long)

isIndexPrimitiveKey

public boolean isIndexPrimitiveKey(@Nullable
                          String spaceName)

Defines whether indexing SPI will index by key entries where key and value are primitive types in given space.

Specified by:

isIndexPrimitiveKey in interface GridH2IndexingSpiMBean

Parameters:

spaceName - Space name.

Returns:

Flag value.

isIndexPrimitiveValue

public boolean isIndexPrimitiveValue(String spaceName)

Defines whether indexing SPI will index by value entries where key and value are primitive types in given space.

Specified by:

isIndexPrimitiveValue in interface GridH2IndexingSpiMBean

Parameters:

spaceName - Space name.

Returns:

Flag value.

isIndexFixedTyping

public boolean isIndexFixedTyping(String spaceName)

If false, SPI will store all keys in BINARY form to make it possible to store the same value type with different key types. If true, key type will be converted to respective SQL type if it is possible.

Setting this value to false also means that '_key' column cannot be indexed and cannot participate in query where clauses. The behavior of using '_key' column in where clauses with this flag set to false is undefined.

Specified by:

isIndexFixedTyping in interface GridH2IndexingSpiMBean

Parameters:

spaceName - Space name.

Returns:

Flag value.

setDefaultIndexPrimitiveValue

@GridSpiConfiguration(optional=true)
public void setDefaultIndexPrimitiveValue(boolean dfltIdxPrimitiveVal)

Sets if SPI will index primitive key-value pairs by value. Makes sense only if setDefaultIndexPrimitiveKey(boolean) set to true.

Parameters:

dfltIdxPrimitiveVal - Flag value.

isDefaultIndexPrimitiveValue

public boolean isDefaultIndexPrimitiveValue()

Gets if SPI will index primitive key-value pairs by value. Makes sense only if setDefaultIndexPrimitiveKey(boolean) set to true.

Specified by:

isDefaultIndexPrimitiveValue in interface GridH2IndexingSpiMBean

Returns:

Flag value.

setDefaultIndexPrimitiveKey

@GridSpiConfiguration(optional=true)
public void setDefaultIndexPrimitiveKey(boolean dfltIdxPrimitiveKey)

Sets if SPI will index primitive key-value pairs by key.

Parameters:

dfltIdxPrimitiveKey - Flag value.

isDefaultIndexPrimitiveKey

public boolean isDefaultIndexPrimitiveKey()

Gets if SPI will index primitive key-value pairs by key.

Specified by:

isDefaultIndexPrimitiveKey in interface GridH2IndexingSpiMBean

Returns:

Flag value.

isDefaultIndexFixedTyping

public boolean isDefaultIndexFixedTyping()

If false, SPI will store all keys in BINARY form to make it possible to store the same value type with different key types. If true, key type will be converted to respective SQL type if it is possible.

Specified by:

isDefaultIndexFixedTyping in interface GridH2IndexingSpiMBean

Returns:

Flag value.

setDefaultIndexFixedTyping

@GridSpiConfiguration(optional=true)
public void setDefaultIndexFixedTyping(boolean dfltIdxFixedTyping)

This flag essentially controls whether all values of the same type have identical key type.

If false, SPI will store all keys in BINARY form to make it possible to store the same value type with different key types. If true, key type will be converted to respective SQL type if it is possible, hence, improving performance of queries.

Setting this value to false also means that '_key' column cannot be indexed and cannot participate in query where clauses. The behavior of using '_key' column in where clauses with this flag set to false is undefined.

This property can be overridden on per-space level via GridH2IndexingSpaceConfiguration.

Parameters:

dfltIdxFixedTyping - FLag value.

setMaxOffHeapMemory

@GridSpiConfiguration(optional=true)
public void setMaxOffHeapMemory(long maxOffHeapMemory)

Sets maximum amount of memory available to off-heap storage. Possible values are

• -1 - Means that off-heap storage is disabled.
• 0 - GridGain will not limit off-heap storage (it's up to user to properly add and remove entries from cache to ensure that off-heap storage does not grow indefinitely.
• Any positive value specifies the limit of off-heap storage in bytes.

Default value is -1, which means that off-heap storage is disabled by default.

Use off-heap storage to load gigabytes of data in memory without slowing down Garbage Collection. Essentially in this case you should allocate very small amount of memory to JVM and GridGain will cache most of the data in off-heap space without affecting JVM performance at all.

Parameters:

maxOffHeapMemory - Maximum memory in bytes available to off-heap memory space.

getMaxOffHeapMemory

public long getMaxOffHeapMemory()

Gets maximum amount of memory available to off-heap storage. Possible values are

• -1 - Means that off-heap storage is disabled.
• 0 - GridGain will not limit off-heap storage (it's up to user to properly add and remove entries from cache to ensure that off-heap storage does not grow indefinitely.
• Any positive value specifies the limit of off-heap storage in bytes.

Default value is -1, which means that off-heap storage is disabled by default.

Use off-heap storage to load gigabytes of data in memory without slowing down Garbage Collection. Essentially in this case you should allocate very small amount of memory to JVM and GridGain will cache most of the data in off-heap space without affecting JVM performance at all.

Specified by:

getMaxOffHeapMemory in interface GridH2IndexingSpiMBean

Returns:

Maximum memory in bytes available to off-heap memory space.

setIndexWriteLockWaitTime

public void setIndexWriteLockWaitTime(long idxWriteLockWaitTime)

Sets index write lock wait time in milliseconds. This parameter can affect query performance under high thread contention. Default value is 100.

Parameters:

idxWriteLockWaitTime - Index write lock wait time.

getIndexWriteLockWaitTime

public long getIndexWriteLockWaitTime()

Gets index write lock wait time in milliseconds. This parameter can affect query performance under high thread contention. Default value is 100.

Specified by:

getIndexWriteLockWaitTime in interface GridH2IndexingSpiMBean

Returns:

Index write lock wait time in milliseconds.

setMaxOffheapRowsCacheSize

@GridSpiConfiguration(optional=true)
public void setMaxOffheapRowsCacheSize(int size)

Specifies max allowed size of cache for deserialized offheap rows to avoid deserialization costs for most frequently used ones. In general performance is better with greater cache size. Must be more than 128 items.

Parameters:

size - Cache size in items.

setSearchPath

@GridSpiConfiguration(optional=true)
public void setSearchPath(String... searchPath)

Sets the optional search path consisting of space names to search SQL schema objects. Useful for cross cache queries to avoid writing fully qualified table names.

Parameters:

searchPath - Search path.

getSearchPath

@Nullable
public String[] getSearchPath()

Gets the optional search path consisting of space names to search SQL schema objects. Useful for cross cache queries to avoid writing fully qualified table names.

Specified by:

getSearchPath in interface GridH2IndexingSpiMBean

Returns:

Array of space names.

getInitialScriptPath

@Nullable
public String getInitialScriptPath()

Gets script path to be ran against H2 database after opening.

Specified by:

getInitialScriptPath in interface GridH2IndexingSpiMBean

Returns:

Script path.

setInitialScriptPath

@GridSpiConfiguration(optional=true)
public void setInitialScriptPath(String initScriptPath)

Sets script path to be ran against H2 database after opening. The script must be UTF-8 encoded file.

Parameters:

initScriptPath - Script path.

getMaxOffheapRowsCacheSize

public int getMaxOffheapRowsCacheSize()

Gets maximum allowed off-heap rows cache size in items.

Specified by:

getMaxOffheapRowsCacheSize in interface GridH2IndexingSpiMBean

Returns:

Maximum allowed off-heap rows cache size.

getOffheapRowsCacheSize

public int getOffheapRowsCacheSize()

Gets current off-heap rows cache size in items.

Specified by:

getOffheapRowsCacheSize in interface GridH2IndexingSpiMBean

Returns:

Current off-heap rows cache size.

getAllocatedOffHeapMemory

public long getAllocatedOffHeapMemory()

Gets currently allocated offheap memory.

Specified by:

getAllocatedOffHeapMemory in interface GridH2IndexingSpiMBean

Returns:

Allocated memory in bytes.

registerMarshaller

public void registerMarshaller(org.gridgain.grid.spi.indexing.GridIndexingMarshaller marshaller)

Specified by:

registerMarshaller in interface org.gridgain.grid.spi.indexing.GridIndexingSpi

registerSpace

public void registerSpace(String spaceName)
                   throws org.gridgain.grid.spi.GridSpiException

Specified by:

registerSpace in interface org.gridgain.grid.spi.indexing.GridIndexingSpi

Throws:

org.gridgain.grid.spi.GridSpiException

setSpaceConfigurations

@GridSpiConfiguration(optional=true)
public void setSpaceConfigurations(GridH2IndexingSpaceConfiguration... spaceCfgs)

Sets per-space configurations.

Parameters:

spaceCfgs - Space configurations list.