H2 Database Engine 2.3.232 · org.h2.index.IndexType · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private boolean	belongsToConstraint
private boolean	hash
private NullsDistinct	nullsDistinct
private boolean	persistent
private boolean	primaryKey
private boolean	scan
private boolean	spatial

Access	Constructor and Description
public	IndexType()

Method Summary

Modifier and Type	Method and Description
public static IndexType	Returns: the index type createNonUnique(boolean if the index is persistent persistent) Create a non-unique index.
public static IndexType	Returns: the index type createNonUnique(boolean if the index is persistent persistent, boolean if a hash index should be used hash, boolean if a spatial index should be used spatial) Create a non-unique index.
public static IndexType	Returns: the index type createPrimaryKey(boolean if the index is persistent persistent, boolean if a hash index should be used hash) Create a primary key index.
public static IndexType	Returns: the index type createScan(boolean if the index is persistent persistent) Create a scan pseudo-index.
public static IndexType	Returns: the index type createUnique(boolean if the index is persistent persistent, boolean if a hash index should be used hash, int count of unique columns (not stored) uniqueColumnCount, NullsDistinct are nulls distinct nullsDistinct) Create a unique index.
public boolean	Returns: if the index belongs to a constraint getBelongsToConstraint() If the index is created because of a constraint.
public NullsDistinct	Returns: are nulls distinct, or `null` for non-unique indexes getEffectiveNullsDistinct() Returns nulls distinct treatment for unique indexes, `NullsDistinct#NOT_DISTINCT` for primary key indexes, and `null` for other types of indexes.
public NullsDistinct	Returns: are nulls distinct, or `null` for non-unique and primary key indexes getNullsDistinct() Returns nulls distinct treatment for unique indexes (excluding primary key indexes).
public String	Returns: the SQL snippet getSQL(boolean `true` to add nulls distinct clause addNullsDistinct) Get the SQL snippet to create such an index.
public boolean	Returns: true if it is a hash index isHash() Is this a hash index?
public boolean	Returns: true if it is persistent isPersistent() Is this index persistent?
public boolean	Returns: true if it references a primary key constraint isPrimaryKey() Does this index belong to a primary key constraint?
public boolean	Returns: true if it is isScan() Is this a table scan pseudo-index?
public boolean	Returns: true if it is a spatial index isSpatial() Is this a spatial index?
public boolean	Returns: true if it is isUnique() Is this a unique index?
public void	setBelongsToConstraint(boolean if the index belongs to a constraint belongsToConstraint) Sets if this index belongs to a constraint.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

belongsToConstraint	back to summary
private boolean belongsToConstraint

hash	back to summary
private boolean hash

nullsDistinct	back to summary
private NullsDistinct nullsDistinct

persistent	back to summary
private boolean persistent

primaryKey	back to summary
private boolean primaryKey

scan	back to summary
private boolean scan

spatial	back to summary
private boolean spatial

IndexType	back to summary
public IndexType()

Method Detail

createNonUnique	back to summary
public static IndexType createNonUnique(boolean persistent) Create a non-unique index. Parameters persistent:boolean if the index is persistent Returns:IndexType the index type

createNonUnique

back to summary

public static IndexType createNonUnique(boolean persistent)

Create a non-unique index.

Parameters

persistent:boolean: if the index is persistent

Returns:IndexType

the index type

createNonUnique	back to summary
public static IndexType createNonUnique(boolean persistent, boolean hash, boolean spatial) Create a non-unique index. Parameters persistent:boolean if the index is persistent hash:boolean if a hash index should be used spatial:boolean if a spatial index should be used Returns:IndexType the index type

createNonUnique

back to summary

public static IndexType createNonUnique(boolean persistent, boolean hash, boolean spatial)

Create a non-unique index.

Parameters

persistent:boolean: if the index is persistent
hash:boolean: if a hash index should be used
spatial:boolean: if a spatial index should be used

Returns:IndexType

the index type

createPrimaryKey	back to summary
public static IndexType createPrimaryKey(boolean persistent, boolean hash) Create a primary key index. Parameters persistent:boolean if the index is persistent hash:boolean if a hash index should be used Returns:IndexType the index type

createPrimaryKey

back to summary

public static IndexType createPrimaryKey(boolean persistent, boolean hash)

Create a primary key index.

Parameters

persistent:boolean: if the index is persistent
hash:boolean: if a hash index should be used

Returns:IndexType

the index type

createScan	back to summary
public static IndexType createScan(boolean persistent) Create a scan pseudo-index. Parameters persistent:boolean if the index is persistent Returns:IndexType the index type

createScan

back to summary

public static IndexType createScan(boolean persistent)

Create a scan pseudo-index.

Parameters

persistent:boolean: if the index is persistent

Returns:IndexType

the index type

createUnique	back to summary
public static IndexType createUnique(boolean persistent, boolean hash, int uniqueColumnCount, NullsDistinct nullsDistinct) Create a unique index. Parameters persistent:boolean if the index is persistent hash:boolean if a hash index should be used uniqueColumnCount:int count of unique columns (not stored) nullsDistinct:NullsDistinct are nulls distinct Returns:IndexType the index type

createUnique

back to summary

public static IndexType createUnique(boolean persistent, boolean hash, int uniqueColumnCount, NullsDistinct nullsDistinct)

Create a unique index.

Parameters

persistent:boolean: if the index is persistent
hash:boolean: if a hash index should be used
uniqueColumnCount:int: count of unique columns (not stored)
nullsDistinct:NullsDistinct: are nulls distinct

Returns:IndexType

the index type

getBelongsToConstraint	back to summary
public boolean getBelongsToConstraint() If the index is created because of a constraint. Such indexes are to be dropped once the constraint is dropped. Returns:boolean if the index belongs to a constraint

getBelongsToConstraint

back to summary

public boolean getBelongsToConstraint()

If the index is created because of a constraint. Such indexes are to be dropped once the constraint is dropped.

Returns:boolean: if the index belongs to a constraint

getEffectiveNullsDistinct back to summary

getEffectiveNullsDistinct	back to summary
public NullsDistinct getEffectiveNullsDistinct() Returns nulls distinct treatment for unique indexes, `NullsDistinct#NOT_DISTINCT` for primary key indexes, and `null` for other types of indexes. Returns:NullsDistinct are nulls distinct, or `null` for non-unique indexes

public NullsDistinct getEffectiveNullsDistinct()

Returns nulls distinct treatment for unique indexes, NullsDistinct#NOT_DISTINCT for primary key indexes, and null for other types of indexes.

Returns:NullsDistinct: are nulls distinct, or null for non-unique indexes

getNullsDistinct back to summary

getNullsDistinct	back to summary
public NullsDistinct getNullsDistinct() Returns nulls distinct treatment for unique indexes (excluding primary key indexes). For primary key and other types of indexes returns `null`. Returns:NullsDistinct are nulls distinct, or `null` for non-unique and primary key indexes

public NullsDistinct getNullsDistinct()

Returns nulls distinct treatment for unique indexes (excluding primary key indexes). For primary key and other types of indexes returns null.

Returns:NullsDistinct: are nulls distinct, or null for non-unique and primary key indexes

getSQL back to summary

getSQL	back to summary
public String getSQL(boolean addNullsDistinct) Get the SQL snippet to create such an index. Parameters addNullsDistinct:boolean `true` to add nulls distinct clause Returns:String the SQL snippet

public String getSQL(boolean addNullsDistinct)

Get the SQL snippet to create such an index.

Parameters

addNullsDistinct:boolean: true to add nulls distinct clause

Returns:String

the SQL snippet

isHash	back to summary
public boolean isHash() Is this a hash index? Returns:boolean true if it is a hash index

isHash

back to summary

public boolean isHash()

Is this a hash index?

Returns:boolean: true if it is a hash index

isPersistent	back to summary
public boolean isPersistent() Is this index persistent? Returns:boolean true if it is persistent

isPersistent

back to summary

public boolean isPersistent()

Is this index persistent?

Returns:boolean: true if it is persistent

isPrimaryKey	back to summary
public boolean isPrimaryKey() Does this index belong to a primary key constraint? Returns:boolean true if it references a primary key constraint

isPrimaryKey

back to summary

public boolean isPrimaryKey()

Does this index belong to a primary key constraint?

Returns:boolean: true if it references a primary key constraint

isScan	back to summary
public boolean isScan() Is this a table scan pseudo-index? Returns:boolean true if it is

isScan

back to summary

public boolean isScan()

Is this a table scan pseudo-index?

Returns:boolean: true if it is

isSpatial	back to summary
public boolean isSpatial() Is this a spatial index? Returns:boolean true if it is a spatial index

isSpatial

back to summary

public boolean isSpatial()

Is this a spatial index?

Returns:boolean: true if it is a spatial index

isUnique	back to summary
public boolean isUnique() Is this a unique index? Returns:boolean true if it is

isUnique

back to summary

public boolean isUnique()

Is this a unique index?

Returns:boolean: true if it is

setBelongsToConstraint	back to summary
public void setBelongsToConstraint(boolean belongsToConstraint) Sets if this index belongs to a constraint. Parameters belongsToConstraint:boolean if the index belongs to a constraint

setBelongsToConstraint

back to summary

public void setBelongsToConstraint(boolean belongsToConstraint)

Sets if this index belongs to a constraint.

Parameters

belongsToConstraint:boolean: if the index belongs to a constraint

public Class IndexType

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail