IndexType

Represents information about the properties of an index

Methods
static IndexType createAffinity()
Create an affinity index.
static IndexType createAffinity()
Create an affinity index.
Returns:
the index type
static IndexType createNonUnique(boolean persistent)
Create a non-unique index.
static IndexType createNonUnique(boolean persistent)
Create a non-unique index.
Parameters:
persistent - if the index is persistent
Returns:
the index type
static IndexType createNonUnique(boolean persistent, boolean hash, boolean spatial)
Create a non-unique index.
static IndexType createNonUnique(boolean persistent, boolean hash, boolean spatial)
Create a non-unique index.
Parameters:
persistent - if the index is persistent
hash - if a hash index should be used
spatial - if a spatial index should be used
Returns:
the index type
static IndexType createPrimaryKey(boolean persistent, boolean hash)
Create a primary key index.
static IndexType createPrimaryKey(boolean persistent, boolean hash)
Create a primary key index.
Parameters:
persistent - if the index is persistent
hash - if a hash index should be used
Returns:
the index type
static IndexType createScan(boolean persistent)
Create a scan pseudo-index.
static IndexType createScan(boolean persistent)
Create a scan pseudo-index.
Parameters:
persistent - if the index is persistent
Returns:
the index type
static IndexType createUnique(boolean persistent, boolean hash)
Create a unique index.
static IndexType createUnique(boolean persistent, boolean hash)
Create a unique index.
Parameters:
persistent - if the index is persistent
hash - if a hash index should be used
Returns:
the index type
boolean getBelongsToConstraint()
If the index is created because of a constraint.
boolean getBelongsToConstraint()
If the index is created because of a constraint. Such indexes are to be dropped once the constraint is dropped.
Returns:
if the index belongs to a constraint
String getSQL()
Get the SQL snippet to create such an index.
String getSQL()
Get the SQL snippet to create such an index.
Returns:
the SQL snippet
boolean isAffinity()
Does this index represent an affinity key?
boolean isAffinity()
Does this index represent an affinity key?
Returns:
true if it does
boolean isHash()
Is this a hash index?
boolean isHash()
Is this a hash index?
Returns:
true if it is a hash index
boolean isPersistent()
Is this index persistent?
boolean isPersistent()
Is this index persistent?
Returns:
true if it is persistent
boolean isPrimaryKey()
Does this index belong to a primary key constraint?
boolean isPrimaryKey()
Does this index belong to a primary key constraint?
Returns:
true if it references a primary key constraint
boolean isScan()
Is this a table scan pseudo-index?
boolean isScan()
Is this a table scan pseudo-index?
Returns:
true if it is
boolean isSpatial()
Is this a spatial index?
boolean isSpatial()
Is this a spatial index?
Returns:
true if it is a spatial index
boolean isUnique()
Is this a unique index?
boolean isUnique()
Is this a unique index?
Returns:
true if it is
void setBelongsToConstraint(boolean belongsToConstraint)
Sets if this index belongs to a constraint.
void setBelongsToConstraint(boolean belongsToConstraint)
Sets if this index belongs to a constraint.
Parameters:
belongsToConstraint - if the index belongs to a constraint