org.gridgain.grid.spi.indexing.h2

Interface GridH2IndexingSpiMBean

All Superinterfaces:

org.gridgain.grid.spi.GridSpiManagementMBean

All Known Implementing Classes:

GridH2IndexingSpi

@GridMBeanDescription(value="MBean that provides access to H2 indexing SPI configuration.")
public interface GridH2IndexingSpiMBean
extends org.gridgain.grid.spi.GridSpiManagementMBean

Management bean for 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.
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).

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

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

Method Detail

isDefaultIndexPrimitiveKey

@GridMBeanDescription(value="Index primitive key-value pairs by key by default in all schemas.")
boolean isDefaultIndexPrimitiveKey()

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

Returns:

Flag value.

isDefaultIndexPrimitiveValue

@GridMBeanDescription(value="Index primitive key-value pairs by value by default in all schemas.")
boolean isDefaultIndexPrimitiveValue()

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

Returns:

Flag value.

isDefaultIndexFixedTyping

@GridMBeanDescription(value="If false, SPI will store all keys in BINARY form, otherwise it will try to convert key type to respective SQL type.")
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.

Returns:

Flag value.

getMaxOffHeapMemory

@GridMBeanDescription(value="Maximum off-heap memory for indexes.")
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.

Returns:

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

getIndexWriteLockWaitTime

@GridMBeanDescription(value="Index write lock wait time in milliseconds.")
long getIndexWriteLockWaitTime()

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

Returns:

Index write lock wait time in milliseconds.

getMaxOffheapRowsCacheSize

@GridMBeanDescription(value="Maximum allowed off-heap rows cache size.")
int getMaxOffheapRowsCacheSize()

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

Returns:

Maximum allowed off-heap rows cache size.

getOffheapRowsCacheSize

@GridMBeanDescription(value="Current off-heap rows cache size.")
int getOffheapRowsCacheSize()

Gets current off-heap rows cache size in items.

Returns:

Current off-heap rows cache size.

getAllocatedOffHeapMemory

@GridMBeanDescription(value="Allocated off-heap memory for indexes.")
long getAllocatedOffHeapMemory()

Gets currently allocated offheap memory.

Returns:

Allocated memory in bytes.

getSpaceNames

@GridMBeanDescription(value="All registered in this SPI spaces.")
String getSpaceNames()

Gets all registered in this SPI spaces comma separated.

Returns:

Collection of space names.

getSearchPath

@Nullable
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.

Returns:

Array of space names.

getInitialScriptPath

@Nullable
String getInitialScriptPath()

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

Returns:

Script path.

getLongQueryExecutionTimeout

@GridMBeanDescription(value="Query execution time interpreted by SPI as long query.")
long getLongQueryExecutionTimeout()

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

Returns:

Long query execution time.

See Also:

isLongQueryExplain()

isLongQueryExplain

@GridMBeanDescription(value="If true, SPI will print SQL execution plan for long queries (explain SQL query).")
boolean isLongQueryExplain()

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

Returns:

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

See Also:

getLongQueryExecutionTimeout()

isIndexPrimitiveKey

@GridMBeanDescription(value="Index by key entries where key and value are primitive types in given space.")
@GridMBeanParametersNames(value="spaceName")
@GridMBeanParametersDescriptions(value="Space name.")
boolean isIndexPrimitiveKey(@Nullable
                                                                                                        String spaceName)

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

Parameters:

spaceName - Space name.

Returns:

Flag value.

isIndexPrimitiveValue

@GridMBeanDescription(value="Index by value entries where key and value are primitive types in given space.")
@GridMBeanParametersNames(value="spaceName")
@GridMBeanParametersDescriptions(value="Space name.")
boolean isIndexPrimitiveValue(@Nullable
                                                                                                          String spaceName)

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

Parameters:

spaceName - Space name.

Returns:

Flag value.

isIndexFixedTyping

@GridMBeanDescription(value="If false, SPI will store all keys in BINARY form, otherwise it will try to convert key type to respective SQL type.")
@GridMBeanParametersNames(value="spaceName")
@GridMBeanParametersDescriptions(value="Space name.")
boolean isIndexFixedTyping(@Nullable
                                                                                                       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.

Parameters:

spaceName - Space name.

Returns:

Flag value.