org.h2.table

Class IndexHints

java.lang.Object

org.h2.table.IndexHints

public final class IndexHints
extends java.lang.Object

Contains the hints for which index to use for a specific table. Currently allows a list of "use indexes" to be specified.

Use the factory method IndexHints.createUseIndexHints(listOfIndexes) to limit the query planner to only use specific indexes when determining which index to use for a table

Method Summary

Modifier and Type	Method and Description
boolean	allowIndex(Index index) Allow an index to be used.
static IndexHints	createUseIndexHints(java.util.LinkedHashSet<java.lang.String> allowedIndexes) Create an index hint object.
java.util.Set<java.lang.String>	getAllowedIndexes()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

createUseIndexHints

public static IndexHints createUseIndexHints(java.util.LinkedHashSet<java.lang.String> allowedIndexes)

Create an index hint object.

Parameters:

allowedIndexes - the set of allowed indexes

Returns:

the hint object

getAllowedIndexes

public java.util.Set<java.lang.String> getAllowedIndexes()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

allowIndex

public boolean allowIndex(Index index)

Allow an index to be used.

Parameters:

index - the index

Returns:

whether it was already allowed