HyperSQL Database 2.7.4 · org.hsqldb.TableWorks · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private Database	database
pack-priv OrderedHashSet<HsqlNameManager.HsqlName>	emptySet
private Session	session
private Table	table

Access	Constructor and Description
public	TableWorks(Session session, Table table)

Method Summary

Modifier and Type	Method and Description
pack-priv void	addCheckConstraint(Constraint c)
pack-priv void	addColumn(ColumnSchema column, int colIndex, HsqlArrayList<Constraint> constraints)
pack-priv void	addForeignKey(Constraint the constraint object c) Creates a foreign key on an existing table.
pack-priv Index	Returns: new index addIndex(int[] int[] col, HsqlNameManager.HsqlName HsqlName name, boolean boolean unique) Because of the way indexes and column data are held in memory and on disk, it is necessary to recreate the table when an index is added to a non-empty cached table.
pack-priv void	addPrimaryKey(Constraint constraint)
pack-priv void	addSystemPeriod(PeriodDefinition period)
pack-priv void	addUniqueConstraint(int[] int[] cols, HsqlNameManager.HsqlName HsqlName name) A unique constraint relies on a unique index on the table.
pack-priv void	addUniqueConstraint(Constraint constraint)
pack-priv void	alterIndex(Index index, int[] columns)
pack-priv void	checkAddColumn(ColumnSchema the Column to add to the Table, t col) Checks if the attributes of the Column argument, c, are compatible with the operation of adding such a Column to the Table argument, table.
pack-priv void	checkAddDomainConstraint(Type domain domain, Constraint added constraint check)
pack-priv void	checkConvertColDataType(ColumnSchema Column oldCol, ColumnSchema Column newCol)
pack-priv void	checkCreateForeignKey(Table fkTable, Constraint c)
private void	checkModifyTable(boolean withContents)
pack-priv void	dropColumn(int colIndex, boolean cascade)
pack-priv void	dropConstraint(String name, boolean cascade)
pack-priv OrderedHashSet<Table>	dropConstraintsAndIndexes(OrderedHashSet<Table> tableSet, OrderedHashSet<HsqlNameManager.HsqlName> dropConstraintSet, OrderedHashSet<HsqlNameManager.HsqlName> dropIndexSet)
pack-priv void	dropConstraintsAndIndexes(OrderedHashSet<HsqlNameManager.HsqlName> dropConstraintSet, OrderedHashSet<HsqlNameManager.HsqlName> dropIndexSet) Drops a set of fk constraints, their indexes and other indexes in table.
pack-priv void	dropIndex(String String indexName) Because of the way indexes and column data are held in memory and on disk, it is necessary to recreate the table when an index is added to or removed from a non-empty table.
pack-priv void	dropSystemPeriod(boolean cascade)
pack-priv void	dropSystemVersioning(boolean cascade)
public Table	getTable()
pack-priv void	moveData(Table oldTable, Table newTable, int[] colIndex, int adjust)
pack-priv void	registerConstraintNames(HsqlArrayList<Constraint> constraints)
pack-priv void	removeColumnNotNullConstraints(int colIndex)
pack-priv void	retypeColumn(ColumnSchema Column oldCol, ColumnSchema Column newCol) Allows changing the type only.
private void	retypeColumn(ColumnSchema Column column, int int colIndex)
pack-priv void	setColDefaultExpression(int int colIndex, Expression Expression def) performs the work for changing the default value of a column
pack-priv void	setColNullability(ColumnSchema Column column, boolean boolean nullable) performs the work for changing the nullability of a column
pack-priv void	setNewTableInSchema(Table newTable)
pack-priv void	setNewTablesInSchema(OrderedHashSet<Table> tableSet)
public boolean	Returns: boolean setTableType(int int newType) Changes the type of the table
pack-priv void	updateConstraints(OrderedHashSet<Table> tableSet, OrderedHashSet<HsqlNameManager.HsqlName> dropConstraints)
pack-priv void	updateConstraints(Table t, OrderedHashSet<HsqlNameManager.HsqlName> dropConstraints)

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

database	back to summary
private Database database

emptySet	back to summary
pack-priv OrderedHashSet<HsqlNameManager.HsqlName> emptySet

session	back to summary
private Session session

table	back to summary
private Table table

TableWorks	back to summary
public TableWorks(Session session, Table table)

Method Detail

addCheckConstraint	back to summary
pack-priv void addCheckConstraint(Constraint c)

addColumn	back to summary
pack-priv void addColumn(ColumnSchema column, int colIndex, HsqlArrayList<Constraint> constraints)

addForeignKey	back to summary
pack-priv void addForeignKey(Constraint c) Creates a foreign key on an existing table. Foreign keys are enforced by indexes on both the referencing (child) and referenced (main) tables. Since version 1.7.2, a unique constraint on the referenced columns must exist. The non-unique index on the referencing table is now always created whether or not a PK or unique constraint index on the columns exist. Foreign keys on temp tables can reference other temp tables with the same rules above. Foreign keys on permanent tables cannot reference temp tables. Duplicate foreign keys are now disallowed. Parameters c:Constraint the constraint object

addForeignKey

back to summary

pack-priv void addForeignKey(Constraint c)

Creates a foreign key on an existing table. Foreign keys are enforced by indexes on both the referencing (child) and referenced (main) tables.

Since version 1.7.2, a unique constraint on the referenced columns must exist. The non-unique index on the referencing table is now always created whether or not a PK or unique constraint index on the columns exist. Foreign keys on temp tables can reference other temp tables with the same rules above. Foreign keys on permanent tables cannot reference temp tables. Duplicate foreign keys are now disallowed.

Parameters

c:Constraint: the constraint object

addIndex	back to summary
pack-priv Index addIndex(int[] col, HsqlNameManager.HsqlName name, boolean unique) Because of the way indexes and column data are held in memory and on disk, it is necessary to recreate the table when an index is added to a non-empty cached table. With empty tables, Index objects are simply added With MEOMRY and TEXT tables, a new index is built up and nodes for earch row are interlinked (fredt@users) Parameters col:int[] int[] name:HsqlNameManager.HsqlName HsqlName unique:boolean boolean Returns:Index new index

addIndex

back to summary

pack-priv Index addIndex(int[] col, HsqlNameManager.HsqlName name, boolean unique)

Because of the way indexes and column data are held in memory and on disk, it is necessary to recreate the table when an index is added to a non-empty cached table.

With empty tables, Index objects are simply added

With MEOMRY and TEXT tables, a new index is built up and nodes for earch row are interlinked (fredt@users)

Parameters

col:int[]: int[]
name:HsqlNameManager.HsqlName: HsqlName
unique:boolean: boolean

Returns:Index

new index

addPrimaryKey	back to summary
pack-priv void addPrimaryKey(Constraint constraint)

addSystemPeriod	back to summary
pack-priv void addSystemPeriod(PeriodDefinition period)

addUniqueConstraint	back to summary
pack-priv void addUniqueConstraint(int[] cols, HsqlNameManager.HsqlName name) A unique constraint relies on a unique index on the table. It can cover a single column or multiple columns. All constraint names are unique within the database. Duplicate constraints (more than one unique constraint on the same set of columns) are not allowed. (fredt@users) Parameters cols:int[] int[] name:HsqlNameManager.HsqlName HsqlName

addUniqueConstraint

back to summary

pack-priv void addUniqueConstraint(int[] cols, HsqlNameManager.HsqlName name)

A unique constraint relies on a unique index on the table. It can cover a single column or multiple columns.

All constraint names are unique within the database. Duplicate constraints (more than one unique constraint on the same set of columns) are not allowed. (fredt@users)

Parameters

cols:int[]: int[]
name:HsqlNameManager.HsqlName: HsqlName

addUniqueConstraint	back to summary
pack-priv void addUniqueConstraint(Constraint constraint)

alterIndex	back to summary
pack-priv void alterIndex(Index index, int[] columns)

checkAddColumn	back to summary
pack-priv void checkAddColumn(ColumnSchema col) Checks if the attributes of the Column argument, c, are compatible with the operation of adding such a Column to the Table argument, table. Parameters col:ColumnSchema the Column to add to the Table, t

checkAddColumn

back to summary

pack-priv void checkAddColumn(ColumnSchema col)

Checks if the attributes of the Column argument, c, are compatible with the operation of adding such a Column to the Table argument, table.

Parameters

col:ColumnSchema: the Column to add to the Table, t

checkAddDomainConstraint	back to summary
pack-priv void checkAddDomainConstraint(Type domain, Constraint check) Parameters domain:Type domain check:Constraint added constraint

checkConvertColDataType	back to summary
pack-priv void checkConvertColDataType(ColumnSchema oldCol, ColumnSchema newCol) Parameters oldCol:ColumnSchema Column newCol:ColumnSchema Column

checkCreateForeignKey	back to summary
pack-priv void checkCreateForeignKey(Table fkTable, Constraint c)

checkModifyTable	back to summary
private void checkModifyTable(boolean withContents)

dropColumn	back to summary
pack-priv void dropColumn(int colIndex, boolean cascade)

dropConstraint	back to summary
pack-priv void dropConstraint(String name, boolean cascade)

dropConstraintsAndIndexes	back to summary
pack-priv OrderedHashSet<Table> dropConstraintsAndIndexes(OrderedHashSet<Table> tableSet, OrderedHashSet<HsqlNameManager.HsqlName> dropConstraintSet, OrderedHashSet<HsqlNameManager.HsqlName> dropIndexSet)

dropConstraintsAndIndexes	back to summary
pack-priv void dropConstraintsAndIndexes(OrderedHashSet<HsqlNameManager.HsqlName> dropConstraintSet, OrderedHashSet<HsqlNameManager.HsqlName> dropIndexSet) Drops a set of fk constraints, their indexes and other indexes in table. Uses sets of names which may contain names that are unrelated to this table.

dropIndex	back to summary
pack-priv void dropIndex(String indexName) Because of the way indexes and column data are held in memory and on disk, it is necessary to recreate the table when an index is added to or removed from a non-empty table. Originally, this method would break existing foreign keys as the table order in the DB was changed. The new table is now linked in place of the old table (fredt@users) Parameters indexName:String String

dropIndex

back to summary

pack-priv void dropIndex(String indexName)

Because of the way indexes and column data are held in memory and on disk, it is necessary to recreate the table when an index is added to or removed from a non-empty table.

Originally, this method would break existing foreign keys as the table order in the DB was changed. The new table is now linked in place of the old table (fredt@users)

Parameters

indexName:String: String

dropSystemPeriod	back to summary
pack-priv void dropSystemPeriod(boolean cascade)

dropSystemVersioning	back to summary
pack-priv void dropSystemVersioning(boolean cascade)

getTable	back to summary
public Table getTable()

moveData	back to summary
pack-priv void moveData(Table oldTable, Table newTable, int[] colIndex, int adjust)

registerConstraintNames	back to summary
pack-priv void registerConstraintNames(HsqlArrayList<Constraint> constraints)

removeColumnNotNullConstraints	back to summary
pack-priv void removeColumnNotNullConstraints(int colIndex)

retypeColumn	back to summary
pack-priv void retypeColumn(ColumnSchema oldCol, ColumnSchema newCol) Allows changing the type only. Parameters oldCol:ColumnSchema Column newCol:ColumnSchema Column

retypeColumn

back to summary

pack-priv void retypeColumn(ColumnSchema oldCol, ColumnSchema newCol)

Allows changing the type only.

Parameters

oldCol:ColumnSchema: Column
newCol:ColumnSchema: Column

retypeColumn	back to summary
private void retypeColumn(ColumnSchema column, int colIndex) Parameters column:ColumnSchema Column colIndex:int int

setColDefaultExpression	back to summary
pack-priv void setColDefaultExpression(int colIndex, Expression def) performs the work for changing the default value of a column Parameters colIndex:int int def:Expression Expression

setColDefaultExpression

back to summary

pack-priv void setColDefaultExpression(int colIndex, Expression def)

performs the work for changing the default value of a column

Parameters

colIndex:int: int
def:Expression: Expression

setColNullability	back to summary
pack-priv void setColNullability(ColumnSchema column, boolean nullable) performs the work for changing the nullability of a column Parameters column:ColumnSchema Column nullable:boolean boolean

setColNullability

back to summary

pack-priv void setColNullability(ColumnSchema column, boolean nullable)

performs the work for changing the nullability of a column

Parameters

column:ColumnSchema: Column
nullable:boolean: boolean

setNewTableInSchema	back to summary
pack-priv void setNewTableInSchema(Table newTable)

setNewTablesInSchema	back to summary
pack-priv void setNewTablesInSchema(OrderedHashSet<Table> tableSet)

setTableType	back to summary
public boolean setTableType(int newType) Changes the type of the table Parameters newType:int int Returns:boolean boolean

setTableType

back to summary

public boolean setTableType(int newType)

Changes the type of the table

Parameters

newType:int: int

Returns:boolean

boolean

updateConstraints	back to summary
pack-priv void updateConstraints(OrderedHashSet<Table> tableSet, OrderedHashSet<HsqlNameManager.HsqlName> dropConstraints)

updateConstraints	back to summary
pack-priv void updateConstraints(Table t, OrderedHashSet<HsqlNameManager.HsqlName> dropConstraints)

public Class TableWorks

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail