org.h2.table

Class TableSynonym

java.lang.Object

org.h2.engine.DbObjectBase

org.h2.schema.SchemaObjectBase

org.h2.table.TableSynonym

All Implemented Interfaces:

DbObject, SchemaObject

public class TableSynonym
extends SchemaObjectBase

Synonym for an existing table or view. All DML requests are forwarded to the backing table. Adding indices to a synonym or altering the table is not supported.

Field Summary

Fields inherited from class org.h2.engine.DbObjectBase

comment, database, trace

Fields inherited from interface org.h2.engine.DbObject

AGGREGATE, COMMENT, CONSTANT, CONSTRAINT, FUNCTION_ALIAS, INDEX, RIGHT, ROLE, SCHEMA, SEQUENCE, SETTING, SYNONYM, TABLE_OR_VIEW, TRIGGER, USER, USER_DATATYPE

Constructor Summary

Constructors

Constructor and Description
TableSynonym(CreateSynonymData data)

Method Summary

Modifier and Type	Method and Description
void	checkRename() Check if this object can be renamed.
java.lang.String	getCreateSQL() Build a SQL statement to re-create this object.
java.lang.String	getCreateSQLForCopy(Table table, 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	getDropSQL() Build a SQL statement to drop this object.
Table	getSynonymFor()
java.lang.String	getSynonymForName()
Schema	getSynonymForSchema()
int	getType() Get the object type.
boolean	isInvalid()
void	removeChildrenAndResources(Session session) Remove all dependent objects and free all resources (files, blocks in files) of this object.
void	rename(java.lang.String newName) Rename the object.
void	updateData(CreateSynonymData data) Set (update) the data.
void	updateSynonymFor() Update the table that this is a synonym for, to know about this synonym.

Methods inherited from class org.h2.schema.SchemaObjectBase

getSchema, getSQL, initSchemaObjectBase, isHidden

Methods inherited from class org.h2.engine.DbObjectBase

getChildren, getComment, getDatabase, getId, getModificationId, getName, initDbObjectBase, invalidate, isTemporary, isValid, setComment, setModified, setObjectName, setTemporary, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.h2.engine.DbObject

getChildren, getComment, getDatabase, getId, getName, isTemporary, setComment, setTemporary

Constructor Detail

TableSynonym

public TableSynonym(CreateSynonymData data)

Method Detail

getSynonymFor

public Table getSynonymFor()

Returns:

the table this is a synonym for

updateData

public void updateData(CreateSynonymData data)

Set (update) the data.

Parameters:

data - the new data

getType

public int getType()

Description copied from interface: DbObject

Get the object type.

Returns:

the object type

getCreateSQLForCopy

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

Description copied from interface: 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

Parameters:

table - the new table

quotedName - the quoted name

Returns:

the SQL statement

rename

public void rename(java.lang.String newName)

Description copied from interface: DbObject

Rename the object.

Specified by:

rename in interface DbObject

Overrides:

rename in class DbObjectBase

Parameters:

newName - the new name

removeChildrenAndResources

public void removeChildrenAndResources(Session session)

Description copied from class: DbObjectBase

Remove all dependent objects and free all resources (files, blocks in files) of this object.

Specified by:

removeChildrenAndResources in interface DbObject

Specified by:

removeChildrenAndResources in class DbObjectBase

Parameters:

session - the session

getCreateSQL

public java.lang.String getCreateSQL()

Description copied from class: DbObjectBase

Build a SQL statement to re-create this object.

Specified by:

getCreateSQL in interface DbObject

Specified by:

getCreateSQL in class DbObjectBase

Returns:

the SQL statement

getDropSQL

public java.lang.String getDropSQL()

Description copied from class: DbObjectBase

Build a SQL statement to drop this object.

Specified by:

getDropSQL in interface DbObject

Specified by:

getDropSQL in class DbObjectBase

Returns:

the SQL statement

checkRename

public void checkRename()

Description copied from class: DbObjectBase

Check if this object can be renamed. System objects may not be renamed.

Specified by:

checkRename in interface DbObject

Specified by:

checkRename in class DbObjectBase

getSynonymForName

public java.lang.String getSynonymForName()

Returns:

the table this synonym is for

getSynonymForSchema

public Schema getSynonymForSchema()

Returns:

the schema this synonym is for

isInvalid

public boolean isInvalid()

Returns:

true if this synonym currently points to a real table

updateSynonymFor

public void updateSynonymFor()

Update the table that this is a synonym for, to know about this synonym.