Apache Derby Database Engine and Embedded JDBC Driver 10.17.1.0 · org.apache.derby.impl.sql.compile.DDLStatementNode

Modifier and Type	Field and Description
public static final int	ADD_TYPE
public static final int	DROP_STATISTICS
public static final int	DROP_TYPE
pack-priv boolean	implicitCreateSchema sub-classes can set this to be true to allow implicit creation of the main object's schema at execution time.
private boolean	initOk
public static final int	LOCKING_TYPE
public static final int	MODIFY_TYPE
private TableName	tableName
public static final int	UNKNOWN_TYPE
public static final int	UPDATE_STATISTICS

Access	Constructor and Description
pack-priv	DDLStatementNode(TableName tableName, ContextManager cm)
pack-priv	DDLStatementNode(ContextManager cm)

Method Summary

Modifier and Type	Method and Description
pack-priv void	acceptChildren(Visitor the visitor v) Overrides org.apache.derby.impl.sql.compile.QueryTreeNode.acceptChildren. Accept a visitor on all child nodes.
pack-priv int	activationKind() Implements abstract org.apache.derby.impl.sql.compile.StatementNode.activationKind.
private TableDescriptor	checkTableDescriptor(TableDescriptor td, boolean doSystemTableCheck)
pack-priv final void	generate(ActivationClassBuilder The ActivationClassBuilder for the class being built acb, MethodBuilder The execute() method to be built mb) Overrides org.apache.derby.impl.sql.compile.QueryTreeNode.generate. Generic generate code for all DDL statements.
pack-priv String	Returns: the full name getFullName() Return the full dot expression name of the object being dropped.
public final TableName	getObjectName()
pack-priv String	Returns: the relative name getRelativeName() Return the name of the table being dropped.
protected final SchemaDescriptor	Returns: Schema Descriptor getSchemaDescriptor() Get a schema descriptor for this DDL object.
protected final SchemaDescriptor	Returns: Schema Descriptor getSchemaDescriptor(boolean If check for schema owner is needed ownerCheck, boolean If check for system schema is needed. If set to true, then throw an exception if schema descriptor is requested for a system schema. The only time this param will be set to false is when user is asking for inplace compress of a system table. DERBY-1062 doSystemSchemaCheck) Get a schema descriptor for this DDL object.
protected final TableDescriptor	getTableDescriptor()
protected final TableDescriptor	Returns: the validated table descriptor, never null getTableDescriptor(boolean doSystemTableCheck) Validate that the table is ok for DDL -- e.g. that it exists, it is not a view.
protected final TableDescriptor	getTableDescriptor(UUID tableId)
protected final TableDescriptor	Returns: the validated table descriptor, never null getTableDescriptor(TableName tableName) Validate that the table is ok for DDL -- e.g. that it exists, it is not a view, and is not a system table, and that its schema is ok.
protected void	initAndCheck(Object objectName) Initialize the object name we will be performing the DDL on and check that we are not in the system schema and that DDL is allowed.
public boolean	Returns: true isAtomic() Overrides org.apache.derby.impl.sql.compile.StatementNode.isAtomic. A DDL statement is always atomic
private TableDescriptor	Returns: TableDescriptor for the give TableName justGetDescriptor(TableName tableName) Just get the table descriptor.
pack-priv FromList	makeFromList(DataDictionary Metadata. dd, TableElementList the parenthesized list of columns and constraints in a CREATE/ALTER TABLE statement tableElementList, boolean true if this is for CREATE TABLE. false if this is for ALTER TABLE creatingTable) Make a from list for binding query fragments in a CREATE/ALTER TABLE statement.
public String	Returns: This object as a String toString() Overrides org.apache.derby.impl.sql.compile.StatementNode.toString. Convert this object to a String.

Inherited from org.apache.derby.impl.sql.compile.StatementNode:: bindStatement executeSchemaName executeStatementName generate getCursorInfo getSPSName lockTableForCompilation makeResultDescription needsSavepoint optimizeStatement statementToString updateIndexStatisticsFor

ADD_TYPE	back to summary
public static final int ADD_TYPE

DROP_STATISTICS	back to summary
public static final int DROP_STATISTICS

DROP_TYPE	back to summary
public static final int DROP_TYPE

implicitCreateSchema	back to summary
pack-priv boolean implicitCreateSchema sub-classes can set this to be true to allow implicit creation of the main object's schema at execution time.

initOk	back to summary
private boolean initOk

LOCKING_TYPE	back to summary
public static final int LOCKING_TYPE

MODIFY_TYPE	back to summary
public static final int MODIFY_TYPE

tableName	back to summary
private TableName tableName

UNKNOWN_TYPE	back to summary
public static final int UNKNOWN_TYPE

UPDATE_STATISTICS	back to summary
public static final int UPDATE_STATISTICS

DDLStatementNode	back to summary
pack-priv DDLStatementNode(TableName tableName, ContextManager cm)

DDLStatementNode	back to summary
pack-priv DDLStatementNode(ContextManager cm)

Method Detail

acceptChildren back to summary

acceptChildren	back to summary
pack-priv void acceptChildren(Visitor v) throws StandardException Overrides org.apache.derby.impl.sql.compile.QueryTreeNode.acceptChildren. Doc from org.apache.derby.impl.sql.compile.QueryTreeNode.acceptChildren. Accept a visitor on all child nodes. All sub-classes that add fields that should be visited, should override this method and call `accept(v)` on all visitable fields, as well as `super.acceptChildren(v)` to make sure all visitable fields defined by the super-class are accepted too. Parameters v:Visitor the visitor Annotations @Override Exceptions StandardException: on errors raised by the visitor

pack-priv void acceptChildren(Visitor v) throws StandardException

Overrides org.apache.derby.impl.sql.compile.QueryTreeNode.acceptChildren.

Doc from org.apache.derby.impl.sql.compile.QueryTreeNode.acceptChildren.

Accept a visitor on all child nodes. All sub-classes that add fields that should be visited, should override this method and call accept(v) on all visitable fields, as well as super.acceptChildren(v) to make sure all visitable fields defined by the super-class are accepted too.

Parameters

v:Visitor: the visitor

Annotations

@Override

Exceptions

StandardException:: on errors raised by the visitor

activationKind	back to summary
pack-priv int activationKind() Implements abstract org.apache.derby.impl.sql.compile.StatementNode.activationKind.

checkTableDescriptor	back to summary
private TableDescriptor checkTableDescriptor(TableDescriptor td, boolean doSystemTableCheck) throws StandardException

generate	back to summary
pack-priv final void generate(ActivationClassBuilder acb, MethodBuilder mb) throws StandardException Overrides org.apache.derby.impl.sql.compile.QueryTreeNode.generate. Generic generate code for all DDL statements. Parameters acb:ActivationClassBuilder The ActivationClassBuilder for the class being built mb:MethodBuilder The execute() method to be built Annotations @Override Exceptions StandardException: Thrown on error

generate

back to summary

pack-priv final void generate(ActivationClassBuilder acb, MethodBuilder mb) throws StandardException

Overrides org.apache.derby.impl.sql.compile.QueryTreeNode.generate.

Generic generate code for all DDL statements.

Parameters

acb:ActivationClassBuilder: The ActivationClassBuilder for the class being built
mb:MethodBuilder: The execute() method to be built

Annotations

@Override

Exceptions

StandardException:: Thrown on error

getFullName	back to summary
pack-priv String getFullName() Return the full dot expression name of the object being dropped. Returns:String the full name

getFullName

back to summary

pack-priv String getFullName()

Return the full dot expression name of the object being dropped.

Returns:String: the full name

getObjectName	back to summary
public final TableName getObjectName()

getRelativeName	back to summary
pack-priv String getRelativeName() Return the name of the table being dropped. This is the unqualified table name. Returns:String the relative name

getRelativeName

back to summary

pack-priv String getRelativeName()

Return the name of the table being dropped. This is the unqualified table name.

Returns:String: the relative name

getSchemaDescriptor	back to summary
protected final SchemaDescriptor getSchemaDescriptor() throws StandardException Get a schema descriptor for this DDL object. Uses this.objectName. Always returns a schema, we lock in the schema name prior to execution. Checks if current authorizationID is owner of the schema. Returns:SchemaDescriptor Schema Descriptor Exceptions StandardException: throws on schema name that doesn't exist

getSchemaDescriptor

back to summary

protected final SchemaDescriptor getSchemaDescriptor() throws StandardException

Get a schema descriptor for this DDL object. Uses this.objectName. Always returns a schema, we lock in the schema name prior to execution. Checks if current authorizationID is owner of the schema.

Returns:SchemaDescriptor

Schema Descriptor

Exceptions

StandardException:: throws on schema name that doesn't exist

getSchemaDescriptor	back to summary
protected final SchemaDescriptor getSchemaDescriptor(boolean ownerCheck, boolean doSystemSchemaCheck) throws StandardException Get a schema descriptor for this DDL object. Uses this.objectName. Always returns a schema, we lock in the schema name prior to execution. The most common call to this method is with 2nd parameter true which says that SchemaDescriptor should not be requested for system schema. The only time this method will get called with 2nd parameter set to false will be when user has requested for inplace compress using SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE Above inplace compress can be invoked on system tables. A call to SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE internally gets translated into ALTER TABLE sql. When ALTER TABLE is executed for SYSCS_INPLACE_COMPRESS_TABLE, we want to allow SchemaDescriptor request for system tables. DERBY-1062 Parameters ownerCheck:boolean If check for schema owner is needed doSystemSchemaCheck:boolean If check for system schema is needed. If set to true, then throw an exception if schema descriptor is requested for a system schema. The only time this param will be set to false is when user is asking for inplace compress of a system table. DERBY-1062 Returns:SchemaDescriptor Schema Descriptor Exceptions StandardException: throws on schema name that doesn't exist

getSchemaDescriptor

back to summary

protected final SchemaDescriptor getSchemaDescriptor(boolean ownerCheck, boolean doSystemSchemaCheck) throws StandardException

Get a schema descriptor for this DDL object. Uses this.objectName. Always returns a schema, we lock in the schema name prior to execution. The most common call to this method is with 2nd parameter true which says that SchemaDescriptor should not be requested for system schema. The only time this method will get called with 2nd parameter set to false will be when user has requested for inplace compress using SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE Above inplace compress can be invoked on system tables. A call to SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE internally gets translated into ALTER TABLE sql. When ALTER TABLE is executed for SYSCS_INPLACE_COMPRESS_TABLE, we want to allow SchemaDescriptor request for system tables. DERBY-1062

Parameters

ownerCheck:boolean: If check for schema owner is needed
doSystemSchemaCheck:boolean: If check for system schema is needed. If set to true, then throw an exception if schema descriptor is requested for a system schema. The only time this param will be set to false is when user is asking for inplace compress of a system table. DERBY-1062

Returns:SchemaDescriptor

Schema Descriptor

Exceptions

StandardException:: throws on schema name that doesn't exist

getTableDescriptor	back to summary
protected final TableDescriptor getTableDescriptor() throws StandardException

getTableDescriptor	back to summary
protected final TableDescriptor getTableDescriptor(boolean doSystemTableCheck) throws StandardException Validate that the table is ok for DDL -- e.g. that it exists, it is not a view. It is ok for it to be a system table. Also check that its schema is ok. Currently, the only time this method is called is when user has asked for inplace compress. eg call SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE('SYS','SYSTABLES',1,1,1); Inplace compress is allowed on both system and user tables. Returns:TableDescriptor the validated table descriptor, never null Exceptions StandardException: on error

getTableDescriptor

back to summary

protected final TableDescriptor getTableDescriptor(boolean doSystemTableCheck) throws StandardException

Validate that the table is ok for DDL -- e.g. that it exists, it is not a view. It is ok for it to be a system table. Also check that its schema is ok. Currently, the only time this method is called is when user has asked for inplace compress. eg call SYSCS_UTIL.SYSCS_INPLACE_COMPRESS_TABLE('SYS','SYSTABLES',1,1,1); Inplace compress is allowed on both system and user tables.

Returns:TableDescriptor

the validated table descriptor, never null

Exceptions

StandardException:: on error

getTableDescriptor	back to summary
protected final TableDescriptor getTableDescriptor(UUID tableId) throws StandardException

getTableDescriptor	back to summary
protected final TableDescriptor getTableDescriptor(TableName tableName) throws StandardException Validate that the table is ok for DDL -- e.g. that it exists, it is not a view, and is not a system table, and that its schema is ok. Returns:TableDescriptor the validated table descriptor, never null Exceptions StandardException: on error

getTableDescriptor

back to summary

protected final TableDescriptor getTableDescriptor(TableName tableName) throws StandardException

Validate that the table is ok for DDL -- e.g. that it exists, it is not a view, and is not a system table, and that its schema is ok.

Returns:TableDescriptor

the validated table descriptor, never null

Exceptions

StandardException:: on error

initAndCheck	back to summary
protected void initAndCheck(Object objectName) throws StandardException Initialize the object name we will be performing the DDL on and check that we are not in the system schema and that DDL is allowed.

isAtomic	back to summary
public boolean isAtomic() Overrides org.apache.derby.impl.sql.compile.StatementNode.isAtomic. A DDL statement is always atomic Returns:boolean true Annotations @Override

isAtomic

back to summary

public boolean isAtomic()

Overrides org.apache.derby.impl.sql.compile.StatementNode.isAtomic.

A DDL statement is always atomic

Returns:boolean

true

Annotations

@Override

justGetDescriptor	back to summary
private TableDescriptor justGetDescriptor(TableName tableName) throws StandardException Just get the table descriptor. Don't worry if it belongs to a view, system table, synonym or a real table. Let the caller decide what to do. Returns:TableDescriptor TableDescriptor for the give TableName Exceptions StandardException: on error

justGetDescriptor

back to summary

private TableDescriptor justGetDescriptor(TableName tableName) throws StandardException

Just get the table descriptor. Don't worry if it belongs to a view, system table, synonym or a real table. Let the caller decide what to do.

Returns:TableDescriptor

TableDescriptor for the give TableName

Exceptions

StandardException:: on error

makeFromList	back to summary
pack-priv FromList makeFromList(DataDictionary dd, TableElementList tableElementList, boolean creatingTable) throws StandardException Make a from list for binding query fragments in a CREATE/ALTER TABLE statement. Parameters dd:DataDictionary Metadata. tableElementList:TableElementList the parenthesized list of columns and constraints in a CREATE/ALTER TABLE statement creatingTable:boolean true if this is for CREATE TABLE. false if this is for ALTER TABLE

makeFromList

back to summary

pack-priv FromList makeFromList(DataDictionary dd, TableElementList tableElementList, boolean creatingTable) throws StandardException

Make a from list for binding query fragments in a CREATE/ALTER TABLE statement.

Parameters

dd:DataDictionary: Metadata.
tableElementList:TableElementList: the parenthesized list of columns and constraints in a CREATE/ALTER TABLE statement
creatingTable:boolean: true if this is for CREATE TABLE. false if this is for ALTER TABLE

toString	back to summary
public String toString() Overrides org.apache.derby.impl.sql.compile.StatementNode.toString. Convert this object to a String. See comments in QueryTreeNode.java for how this should be done for tree printing. Returns:String This object as a String Annotations @Override

toString

back to summary

public String toString()

Overrides org.apache.derby.impl.sql.compile.StatementNode.toString.

Convert this object to a String. See comments in QueryTreeNode.java for how this should be done for tree printing.

Returns:String

This object as a String

Annotations

@Override

pack-priv abstract Class DDLStatementNode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail