Package org.h2.constraint

Class ConstraintUnique

java.lang.Object

org.h2.engine.DbObject

org.h2.schema.SchemaObject

org.h2.constraint.Constraint

org.h2.constraint.ConstraintUnique

All Implemented Interfaces:

java.lang.Comparable<Constraint>, HasSQL

public class ConstraintUnique
extends Constraint

A unique constraint. This object always backed by a unique index.

Nested Class Summary

Nested classes/interfaces inherited from class org.h2.constraint.Constraint

Constraint.Type

Field Summary

Fields inherited from class org.h2.constraint.Constraint

table

Fields inherited from class org.h2.engine.DbObject

AGGREGATE, comment, COMMENT, CONSTANT, CONSTRAINT, database, DOMAIN, FUNCTION_ALIAS, INDEX, RIGHT, ROLE, SCHEMA, SEQUENCE, SETTING, SYNONYM, TABLE_OR_VIEW, trace, TRIGGER, USER

Fields inherited from interface org.h2.util.HasSQL

ADD_PLAN_INFORMATION, DEFAULT_SQL_FLAGS, NO_CASTS, QUOTE_ONLY_WHEN_REQUIRED, REPLACE_LOBS_FOR_TRACE, TRACE_SQL_FLAGS

Constructor Summary

Constructors

Constructor	Description
ConstraintUnique(Schema schema, int id, java.lang.String name, Table table, boolean primaryKey, IndexColumn[] indexColumns, Index index, boolean indexOwner, NullsDistinct nullsDistinct)

Method Summary

Modifier and Type	Method	Description
void	checkExistingData(SessionLocal session)	Check the existing data.
void	checkRow(SessionLocal session, Table t, Row oldRow, Row newRow)	Check if this row fulfils the constraint.
IndexColumn[]	getColumns()
Constraint.Type	getConstraintType()	The constraint type name
java.lang.String	getCreateSQL()	Construct the CREATE ...
java.lang.String	getCreateSQLForCopy(Table forTable, java.lang.String quotedName)	Build a SQL statement to re-create the object, or to create a copy of the object with a different name or referencing a different table
java.lang.String	getCreateSQLWithoutIndexes()	Get the SQL statement to create this constraint.
Index	getIndex()	Get the index of this constraint in the source table, or null if no index is used.
NullsDistinct	getNullsDistinct()
java.util.HashSet<Column>	getReferencedColumns(Table table)	Get all referenced columns.
boolean	isBefore()	Check if this constraint needs to be checked before updating the data.
void	rebuild()	This method is called after a related table has changed (the table was renamed, or columns have been renamed).
void	removeChildrenAndResources(SessionLocal session)	Delete all dependent children objects and resources of this object.
void	setIndexOwner(Index index)	This index is now the owner of the specified index.
boolean	usesIndex(Index idx)	Check if this constraint needs the specified index.

Methods inherited from class org.h2.constraint.Constraint

compareTo, getExpression, getReferencedConstraint, getRefTable, getTable, getType, isEverything

Methods inherited from class org.h2.schema.SchemaObject

getSchema, getSQL, getSQL

Methods inherited from class org.h2.engine.DbObject

checkRename, equals, getChildren, getComment, getCreateSQLForMeta, getDatabase, getDropSQL, getId, getModificationId, getName, hashCode, invalidate, isTemporary, isValid, rename, setComment, setModified, setObjectName, setTemporary, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.h2.util.HasSQL

getTraceSQL

Constructor Detail

ConstraintUnique

public ConstraintUnique(Schema schema,
                        int id,
                        java.lang.String name,
                        Table table,
                        boolean primaryKey,
                        IndexColumn[] indexColumns,
                        Index index,
                        boolean indexOwner,
                        NullsDistinct nullsDistinct)

Parameters:

schema - constraint belongs to

id - of the constraint

name - of the constraint

table - constraint belongs to

primaryKey - true if primary key constraint

indexColumns - used by this constraint

index - the index

indexOwner - true if the index is generated by the system and belongs to this constraint

nullsDistinct - NULL handling mode

Method Detail

getConstraintType

public Constraint.Type getConstraintType()

Description copied from class: Constraint

The constraint type name

Specified by:

getConstraintType in class Constraint

Returns:

the name

getCreateSQLForCopy

public java.lang.String getCreateSQLForCopy(Table forTable,
                                            java.lang.String quotedName)

Description copied from class: DbObject

Build a SQL statement to re-create the object, or to create a copy of the object with a different name or referencing a different table

Overrides:

getCreateSQLForCopy in class DbObject

Parameters:

forTable - the new table

quotedName - the quoted name

Returns:

the SQL statement

getCreateSQLWithoutIndexes

public java.lang.String getCreateSQLWithoutIndexes()

Description copied from class: Constraint

Get the SQL statement to create this constraint.

Specified by:

getCreateSQLWithoutIndexes in class Constraint

Returns:

the SQL statement

getCreateSQL

public java.lang.String getCreateSQL()

Description copied from class: DbObject

Construct the CREATE ... SQL statement for this object.

Specified by:

getCreateSQL in class DbObject

Returns:

the SQL statement

getColumns

public IndexColumn[] getColumns()

removeChildrenAndResources

public void removeChildrenAndResources(SessionLocal session)

Description copied from class: DbObject

Delete all dependent children objects and resources of this object.

Specified by:

removeChildrenAndResources in class DbObject

Parameters:

session - the session

checkRow

public void checkRow(SessionLocal session,
                     Table t,
                     Row oldRow,
                     Row newRow)

Description copied from class: Constraint

Check if this row fulfils the constraint. This method throws an exception if not.

Specified by:

checkRow in class Constraint

Parameters:

session - the session

t - the table

oldRow - the old row

newRow - the new row

usesIndex

public boolean usesIndex(Index idx)

Description copied from class: Constraint

Check if this constraint needs the specified index.

Specified by:

usesIndex in class Constraint

Parameters:

idx - the index

Returns:

true if the index is used

setIndexOwner

public void setIndexOwner(Index index)

Description copied from class: Constraint

This index is now the owner of the specified index.

Specified by:

setIndexOwner in class Constraint

Parameters:

index - the index

getReferencedColumns

public java.util.HashSet<Column> getReferencedColumns(Table table)

Description copied from class: Constraint

Get all referenced columns.

Specified by:

getReferencedColumns in class Constraint

Parameters:

table - the table

Returns:

the set of referenced columns

isBefore

public boolean isBefore()

Description copied from class: Constraint

Check if this constraint needs to be checked before updating the data.

Specified by:

isBefore in class Constraint

Returns:

true if it must be checked before updating

checkExistingData

public void checkExistingData(SessionLocal session)

Description copied from class: Constraint

Check the existing data. This method is called if the constraint is added after data has been inserted into the table.

Specified by:

checkExistingData in class Constraint

Parameters:

session - the session

getIndex

public Index getIndex()

Description copied from class: Constraint

Get the index of this constraint in the source table, or null if no index is used.

Overrides:

getIndex in class Constraint

Returns:

the index

rebuild

public void rebuild()

Description copied from class: Constraint

This method is called after a related table has changed (the table was renamed, or columns have been renamed).

Specified by:

rebuild in class Constraint

getNullsDistinct

public NullsDistinct getNullsDistinct()

Returns:

are nulls distinct