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

Modifier and Type	Class and Description
pack-priv static class	SchemaManager.UserSchemaFilter

Modifier and Type	Field and Description
pack-priv HsqlNameManager.HsqlName[]	catalogNameArray
pack-priv Database	database
pack-priv HsqlNameManager.HsqlName	defaultSchemaHsqlName
pack-priv int	defaultTableType
pack-priv Table	dualTable
pack-priv ReadWriteLock	lock
pack-priv Lock	readLock
pack-priv MultiValueHashMap<HsqlNameManager.HsqlName, HsqlNameManager.HsqlName>	referenceMap
pack-priv long	schemaChangeTimestamp
pack-priv OrderedHashMap<String, Schema>	schemaMap
pack-priv long[][]	tempIndexRoots
pack-priv SchemaManager.UserSchemaFilter	userSchemaFilter
pack-priv Lock	writeLock

Access	Constructor and Description
public	SchemaManager(Database database)

Method Summary

Modifier and Type	Method and Description
private void	addReferencesFrom(SchemaObject object)
public void	addSchemaObject(SchemaObject object)
public void	checkColumnIsReferenced(HsqlNameManager.HsqlName tableName, HsqlNameManager.HsqlName name)
public void	checkObjectIsReferenced(HsqlNameManager.HsqlName name)
public void	checkSchemaNameCanChange(HsqlNameManager.HsqlName name)
public void	checkSchemaObjectNotExists(HsqlNameManager.HsqlName name)
public void	createPublicSchema()
public void	createSchema(HsqlNameManager.HsqlName name, Grantee owner) Creates a schema belonging to the given grantee.
public void	createSystemTables()
public Iterator<Constraint>	databaseCheckConstraintIterator()
public Iterator<SchemaObject>	databaseObjectIterator(String schemaName, int type)
public Iterator<SchemaObject>	databaseObjectIterator(int type)
public Iterator<Table>	databaseTableIterator()
pack-priv void	dropConstraint(Session session, HsqlNameManager.HsqlName name, boolean cascade) Drops the constraint with the specified name.
pack-priv void	dropIndex(Session session, HsqlNameManager.HsqlName name) Drops the index with the specified name.
public void	dropSchema(Session session, String name, boolean cascade)
public void	dropSchemas(Session session, Grantee grantee, boolean cascade) drop all schemas with the given authorisation
private void	dropTable(Session session, Table table, boolean cascade)
public void	dropTableOrView(Session the connected context in which to perform this operation session, Table if true and if the Table to drop does not exist, fail silently, else throw table, boolean true if the name argument refers to a View cascade) Drops the specified user-defined view or table from this Database object.
private void	dropView(Table table, boolean cascade)
public SchemaObject	findAnySchemaObjectForSynonym(String name, String schemaName)
public Type	findDomainOrUDT(Session session, String name, String prefix, String prePrefix, String prePrePrefix)
public Schema	findSchema(String name)
public HsqlNameManager.HsqlName	findSchemaHsqlName(String name)
public SchemaObject	findSchemaObject(Session session, String name, String prefix, String prePrefix, int type)
public SchemaObject	findSchemaObject(String name, String schemaName, int type)
public SchemaObject	findSchemaObject(HsqlNameManager.HsqlName name)
public NumberSequence	findSequence(Session session, String name, String schemaName)
public Table	findSessionTable(Session session, String name) Returns the specified session context table.
public ReferenceObject	findSynonym(String name, String schemaName, int type)
public Table	findTable(Session session, String name, String prefix, String prePrefix)
public Table	findUserTable(String name, String schemaName) Returns the specified user-defined table or view visible within the context of the specified schema.
pack-priv Table	findUserTableForIndex(Session session, String name, String schemaName) Returns the table that has an index with the given name and schema.
public Schema[]	getAllSchemas()
public HsqlArrayList<Table>	getAllTables(boolean withLobTables) Returns an HsqlArrayList containing references to all non-system tables and views of the given type.
public void	getCascadingReferencesTo(HsqlNameManager.HsqlName object, OrderedHashSet<HsqlNameManager.HsqlName> set)
public void	getCascadingReferencesToSchema(HsqlNameManager.HsqlName schema, OrderedHashSet<HsqlNameManager.HsqlName> set)
public HsqlNameManager.HsqlName[]	getCatalogAndBaseTableNames()
public HsqlNameManager.HsqlName[]	getCatalogAndBaseTableNames(HsqlNameManager.HsqlName name)
public HsqlNameManager.HsqlName[]	getCatalogNameArray()
public SchemaObject	getCharacterSet(Session session, String name, String schemaName)
public Collation	getCollation(Session session, String name, String schemaName)
public HsqlNameManager.HsqlName	getDefaultSchemaHsqlName()
public int	getDefaultTableType()
public Type	getDistinctType(String name, String schemaName, boolean raise)
public Type	getDomain(String name, String schemaName, boolean raise)
public long[][]	getIndexRoots()
public List<String>	getIndexRootsSQLArray()
public OrderedHashSet<HsqlNameManager.HsqlName>	getReferencesTo(HsqlNameManager.HsqlName object)
public OrderedHashSet<HsqlNameManager.HsqlName>	getReferencesTo(HsqlNameManager.HsqlName table, HsqlNameManager.HsqlName column)
public MultiValueHashMap<HsqlNameManager.HsqlName, HsqlNameManager.HsqlName>	getReferencesToSchema(String schemaName)
public long	getSchemaChangeTimestamp()
public HsqlNameManager.HsqlName	getSchemaHsqlName(String name) If schemaName is null, return the default schema name, else return the HsqlName object for the schema.
public String	getSchemaName(String name) Same as above, but return string
public String[]	getSchemaNamesArray()
public SchemaObject	getSchemaObject(String name, String schemaName, int type)
public HsqlNameManager.HsqlName	getSchemaObjectName(HsqlNameManager.HsqlName schemaName, String name, int type, boolean raise)
public HsqlArrayList<Schema>	getSchemas(Grantee grantee)
public NumberSequence	getSequence(String name, String schemaName, boolean raise)
public List<String>	getSQLArray()
public HsqlNameManager.HsqlName	getSQLJSchemaHsqlName()
public int	Returns: the index of the specified table or view, or -1 if not found getTableIndex(Table the Table object table) Returns index of a table or view in the HashMappedList that contains the table objects for this Database.
public List<String>	getTablePropsSQLArray(boolean withHeader)
public OrderedHashMap<String, Table>	getTables(String schema)
public List<String>	getTableSpaceSQLArray()
public Type	getUserDefinedType(String name, String schemaName, boolean raise)
public HsqlNameManager.HsqlName	getUserSchemaHsqlName(String name)
public Iterator<Schema>	getUserSchemaIterator()
public Table	getUserTable(HsqlNameManager.HsqlName name)
public Table	getUserTable(String name, String schema) Returns the specified user-defined table or view visible within the context of the specified Session.
public boolean	hasSchemas(Grantee grantee)
private boolean	isReferenced(HsqlNameManager.HsqlName object)
public void	recompileDependentObjects(OrderedHashSet<Table> tableSet)
public void	recompileDependentObjects(Table table) After addition or removal of columns and indexes all views that reference the table should be recompiled.
public void	release()
pack-priv void	removeDependentObjects(HsqlNameManager.HsqlName name)
pack-priv void	removeExportedKeys(Table The table to which other tables may be holding keys. This is a table that is in the process of being dropped. toDrop) Removes any foreign key Constraint objects (exported keys) held by any tables referenced by the specified table.
private void	removeReferencesFrom(SchemaObject object)
private void	removeReferencesTo(OrderedHashSet<HsqlNameManager.HsqlName> set)
private void	removeReferencesTo(HsqlNameManager.HsqlName referenced)
public void	removeSchemaObject(HsqlNameManager.HsqlName name, boolean cascade)
public void	removeSchemaObject(HsqlNameManager.HsqlName name)
public void	removeSchemaObjects(OrderedHashSet<HsqlNameManager.HsqlName> set)
private void	removeTable(Session session, Table table)
private void	removeTableDependentReferences(Table table)
public void	renameSchema(HsqlNameManager.HsqlName name, HsqlNameManager.HsqlName newName)
public void	renameSchemaObject(HsqlNameManager.HsqlName name, HsqlNameManager.HsqlName newName)
public void	replaceReferences(SchemaObject oldObject, SchemaObject newObject)
public boolean	schemaExists(String name)
public void	setDefaultSchemaHsqlName(HsqlNameManager.HsqlName name)
public void	setDefaultTableType(int type)
public void	setIndexRoots(long[][] roots) called after the completion of defrag
public void	setSchemaChangeTimestamp()
public void	setTable(int index, Table table)
public void	setTempIndexRoots(long[][] roots)
public Grantee	toSchemaOwner(String name)

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

catalogNameArray	back to summary
pack-priv HsqlNameManager.HsqlName[] catalogNameArray

database	back to summary
pack-priv Database database

defaultSchemaHsqlName	back to summary
pack-priv HsqlNameManager.HsqlName defaultSchemaHsqlName

defaultTableType	back to summary
pack-priv int defaultTableType

dualTable	back to summary
pack-priv Table dualTable

lock	back to summary
pack-priv ReadWriteLock lock

readLock	back to summary
pack-priv Lock readLock

referenceMap	back to summary
pack-priv MultiValueHashMap<HsqlNameManager.HsqlName, HsqlNameManager.HsqlName> referenceMap

schemaChangeTimestamp	back to summary
pack-priv long schemaChangeTimestamp

schemaMap	back to summary
pack-priv OrderedHashMap<String, Schema> schemaMap

tempIndexRoots	back to summary
pack-priv long[][] tempIndexRoots

userSchemaFilter	back to summary
pack-priv SchemaManager.UserSchemaFilter userSchemaFilter

writeLock	back to summary
pack-priv Lock writeLock

SchemaManager	back to summary
public SchemaManager(Database database)

Method Detail

addReferencesFrom	back to summary
private void addReferencesFrom(SchemaObject object)

addSchemaObject	back to summary
public void addSchemaObject(SchemaObject object)

checkColumnIsReferenced	back to summary
public void checkColumnIsReferenced(HsqlNameManager.HsqlName tableName, HsqlNameManager.HsqlName name)

checkObjectIsReferenced	back to summary
public void checkObjectIsReferenced(HsqlNameManager.HsqlName name)

checkSchemaNameCanChange	back to summary
public void checkSchemaNameCanChange(HsqlNameManager.HsqlName name)

checkSchemaObjectNotExists	back to summary
public void checkSchemaObjectNotExists(HsqlNameManager.HsqlName name)

createPublicSchema	back to summary
public void createPublicSchema()

createSchema	back to summary
public void createSchema(HsqlNameManager.HsqlName name, Grantee owner) Creates a schema belonging to the given grantee.

createSystemTables	back to summary
public void createSystemTables()

databaseCheckConstraintIterator	back to summary
public Iterator<Constraint> databaseCheckConstraintIterator()

databaseObjectIterator	back to summary
public Iterator<SchemaObject> databaseObjectIterator(String schemaName, int type)

databaseObjectIterator	back to summary
public Iterator<SchemaObject> databaseObjectIterator(int type)

databaseTableIterator	back to summary
public Iterator<Table> databaseTableIterator()

dropConstraint	back to summary
pack-priv void dropConstraint(Session session, HsqlNameManager.HsqlName name, boolean cascade) Drops the constraint with the specified name.

dropIndex	back to summary
pack-priv void dropIndex(Session session, HsqlNameManager.HsqlName name) Drops the index with the specified name.

dropSchema	back to summary
public void dropSchema(Session session, String name, boolean cascade)

dropSchemas	back to summary
public void dropSchemas(Session session, Grantee grantee, boolean cascade) drop all schemas with the given authorisation

dropTable	back to summary
private void dropTable(Session session, Table table, boolean cascade)

dropTableOrView	back to summary
public void dropTableOrView(Session session, Table table, boolean cascade) Drops the specified user-defined view or table from this Database object. The process of dropping a table or view includes: checking that the specified Session's currently connected User has the right to perform this operation and refusing to proceed if not by throwing. checking for referential constraints that conflict with this operation and refusing to proceed if they exist by throwing. removing the specified Table from this Database object. removing any exported foreign keys Constraint objects held by any tables referenced by the table to be dropped. This is especially important so that the dropped Table ceases to be referenced, eventually allowing its full garbage collection. Parameters session:Session the connected context in which to perform this operation table:Table if true and if the Table to drop does not exist, fail silently, else throw cascade:boolean true if the name argument refers to a View

dropTableOrView

back to summary

public void dropTableOrView(Session session, Table table, boolean cascade)

Drops the specified user-defined view or table from this Database object.

The process of dropping a table or view includes:

checking that the specified Session's currently connected User has the right to perform this operation and refusing to proceed if not by throwing.
checking for referential constraints that conflict with this operation and refusing to proceed if they exist by throwing.
removing the specified Table from this Database object.
removing any exported foreign keys Constraint objects held by any tables referenced by the table to be dropped. This is especially important so that the dropped Table ceases to be referenced, eventually allowing its full garbage collection.

Parameters

session:Session: the connected context in which to perform this operation
table:Table: if true and if the Table to drop does not exist, fail silently, else throw
cascade:boolean: true if the name argument refers to a View

dropView	back to summary
private void dropView(Table table, boolean cascade)

findAnySchemaObjectForSynonym	back to summary
public SchemaObject findAnySchemaObjectForSynonym(String name, String schemaName)

findDomainOrUDT	back to summary
public Type findDomainOrUDT(Session session, String name, String prefix, String prePrefix, String prePrePrefix)

findSchema	back to summary
public Schema findSchema(String name)

findSchemaHsqlName	back to summary
public HsqlNameManager.HsqlName findSchemaHsqlName(String name)

findSchemaObject	back to summary
public SchemaObject findSchemaObject(Session session, String name, String prefix, String prePrefix, int type)

findSchemaObject	back to summary
public SchemaObject findSchemaObject(String name, String schemaName, int type)

findSchemaObject	back to summary
public SchemaObject findSchemaObject(HsqlNameManager.HsqlName name)

findSequence	back to summary
public NumberSequence findSequence(Session session, String name, String schemaName)

findSessionTable	back to summary
public Table findSessionTable(Session session, String name) Returns the specified session context table. Returns null if the table does not exist in the context.

findSynonym	back to summary
public ReferenceObject findSynonym(String name, String schemaName, int type)

findTable	back to summary
public Table findTable(Session session, String name, String prefix, String prePrefix)

findUserTable	back to summary
public Table findUserTable(String name, String schemaName) Returns the specified user-defined table or view visible within the context of the specified schema. It excludes system tables. Returns null if the table does not exist in the context.

findUserTableForIndex	back to summary
pack-priv Table findUserTableForIndex(Session session, String name, String schemaName) Returns the table that has an index with the given name and schema.

getAllSchemas	back to summary
public Schema[] getAllSchemas()

getAllTables	back to summary
public HsqlArrayList<Table> getAllTables(boolean withLobTables) Returns an HsqlArrayList containing references to all non-system tables and views of the given type.

getCascadingReferencesTo	back to summary
public void getCascadingReferencesTo(HsqlNameManager.HsqlName object, OrderedHashSet<HsqlNameManager.HsqlName> set)

getCascadingReferencesToSchema	back to summary
public void getCascadingReferencesToSchema(HsqlNameManager.HsqlName schema, OrderedHashSet<HsqlNameManager.HsqlName> set)

getCatalogAndBaseTableNames	back to summary
public HsqlNameManager.HsqlName[] getCatalogAndBaseTableNames()

getCatalogAndBaseTableNames	back to summary
public HsqlNameManager.HsqlName[] getCatalogAndBaseTableNames(HsqlNameManager.HsqlName name)

getCatalogNameArray	back to summary
public HsqlNameManager.HsqlName[] getCatalogNameArray()

getCharacterSet	back to summary
public SchemaObject getCharacterSet(Session session, String name, String schemaName)

getCollation	back to summary
public Collation getCollation(Session session, String name, String schemaName)

getDefaultSchemaHsqlName	back to summary
public HsqlNameManager.HsqlName getDefaultSchemaHsqlName()

getDefaultTableType	back to summary
public int getDefaultTableType()

getDistinctType	back to summary
public Type getDistinctType(String name, String schemaName, boolean raise)

getDomain	back to summary
public Type getDomain(String name, String schemaName, boolean raise)

getIndexRoots	back to summary
public long[][] getIndexRoots()

getIndexRootsSQLArray	back to summary
public List<String> getIndexRootsSQLArray()

getReferencesTo	back to summary
public OrderedHashSet<HsqlNameManager.HsqlName> getReferencesTo(HsqlNameManager.HsqlName object)

getReferencesTo	back to summary
public OrderedHashSet<HsqlNameManager.HsqlName> getReferencesTo(HsqlNameManager.HsqlName table, HsqlNameManager.HsqlName column)

getReferencesToSchema	back to summary
public MultiValueHashMap<HsqlNameManager.HsqlName, HsqlNameManager.HsqlName> getReferencesToSchema(String schemaName)

getSchemaChangeTimestamp	back to summary
public long getSchemaChangeTimestamp()

getSchemaHsqlName	back to summary
public HsqlNameManager.HsqlName getSchemaHsqlName(String name) If schemaName is null, return the default schema name, else return the HsqlName object for the schema. If schemaName does not exist, throw.

getSchemaName	back to summary
public String getSchemaName(String name) Same as above, but return string

getSchemaNamesArray	back to summary
public String[] getSchemaNamesArray()

getSchemaObject	back to summary
public SchemaObject getSchemaObject(String name, String schemaName, int type)

getSchemaObjectName	back to summary
public HsqlNameManager.HsqlName getSchemaObjectName(HsqlNameManager.HsqlName schemaName, String name, int type, boolean raise)

getSchemas	back to summary
public HsqlArrayList<Schema> getSchemas(Grantee grantee)

getSequence	back to summary
public NumberSequence getSequence(String name, String schemaName, boolean raise)

getSQLArray	back to summary
public List<String> getSQLArray()

getSQLJSchemaHsqlName	back to summary
public HsqlNameManager.HsqlName getSQLJSchemaHsqlName()

getTableIndex

back to summary

public int getTableIndex(Table table)

Returns index of a table or view in the HashMappedList that contains the table objects for this Database.

Parameters

table:Table: the Table object

Returns:int

the index of the specified table or view, or -1 if not found

getTablePropsSQLArray	back to summary
public List<String> getTablePropsSQLArray(boolean withHeader)

getTables	back to summary
public OrderedHashMap<String, Table> getTables(String schema)

getTableSpaceSQLArray	back to summary
public List<String> getTableSpaceSQLArray()

getUserDefinedType	back to summary
public Type getUserDefinedType(String name, String schemaName, boolean raise)

getUserSchemaHsqlName	back to summary
public HsqlNameManager.HsqlName getUserSchemaHsqlName(String name)

getUserSchemaIterator	back to summary
public Iterator<Schema> getUserSchemaIterator()

getUserTable	back to summary
public Table getUserTable(HsqlNameManager.HsqlName name)

getUserTable	back to summary
public Table getUserTable(String name, String schema) Returns the specified user-defined table or view visible within the context of the specified Session. Throws if the table does not exist in the context.

hasSchemas	back to summary
public boolean hasSchemas(Grantee grantee)

isReferenced	back to summary
private boolean isReferenced(HsqlNameManager.HsqlName object)

recompileDependentObjects	back to summary
public void recompileDependentObjects(OrderedHashSet<Table> tableSet)

recompileDependentObjects	back to summary
public void recompileDependentObjects(Table table) After addition or removal of columns and indexes all views that reference the table should be recompiled.

release	back to summary
public void release()

removeDependentObjects	back to summary
pack-priv void removeDependentObjects(HsqlNameManager.HsqlName name)

removeExportedKeys

back to summary

pack-priv void removeExportedKeys(Table toDrop)

Removes any foreign key Constraint objects (exported keys) held by any tables referenced by the specified table.

This method is called as the last step of a successful call to dropTable() in order to ensure that the dropped Table ceases to be referenced when enforcing referential integrity.

Parameters

toDrop:Table: The table to which other tables may be holding keys. This is a table that is in the process of being dropped.

removeReferencesFrom	back to summary
private void removeReferencesFrom(SchemaObject object)

removeReferencesTo	back to summary
private void removeReferencesTo(OrderedHashSet<HsqlNameManager.HsqlName> set)

removeReferencesTo	back to summary
private void removeReferencesTo(HsqlNameManager.HsqlName referenced)

removeSchemaObject	back to summary
public void removeSchemaObject(HsqlNameManager.HsqlName name, boolean cascade)

removeSchemaObject	back to summary
public void removeSchemaObject(HsqlNameManager.HsqlName name)

removeSchemaObjects	back to summary
public void removeSchemaObjects(OrderedHashSet<HsqlNameManager.HsqlName> set)

removeTable	back to summary
private void removeTable(Session session, Table table)

removeTableDependentReferences	back to summary
private void removeTableDependentReferences(Table table)

renameSchema	back to summary
public void renameSchema(HsqlNameManager.HsqlName name, HsqlNameManager.HsqlName newName)

renameSchemaObject	back to summary
public void renameSchemaObject(HsqlNameManager.HsqlName name, HsqlNameManager.HsqlName newName)

replaceReferences	back to summary
public void replaceReferences(SchemaObject oldObject, SchemaObject newObject)

schemaExists	back to summary
public boolean schemaExists(String name)

setDefaultSchemaHsqlName	back to summary
public void setDefaultSchemaHsqlName(HsqlNameManager.HsqlName name)

setDefaultTableType	back to summary
public void setDefaultTableType(int type)

setIndexRoots	back to summary
public void setIndexRoots(long[][] roots) called after the completion of defrag

setSchemaChangeTimestamp	back to summary
public void setSchemaChangeTimestamp()

setTable	back to summary
public void setTable(int index, Table table)

setTempIndexRoots	back to summary
public void setTempIndexRoots(long[][] roots)

toSchemaOwner	back to summary
public Grantee toSchemaOwner(String name)

public Class SchemaManager

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class SchemaManager.UserSchemaFilter

Constructor Summary

Method Summary

Constructor Detail

Method Detail