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

Modifier and Type	Field and Description
private int[]	boundColumnIDs
private List<String>	columnNameList
private String[]	columnNames
private TableName	indexName
private String	indexType
private boolean[]	isAscending
private Properties	properties
private TableName	tableName Hides org.apache.derby.impl.sql.compile.DDLStatementNode.tableName.
private TableDescriptor	td
private boolean	unique

Modifier and Type

Field and Description

private int[]

private List<String>

private String[]

private TableName

private String

private boolean[]

private Properties

private TableName

Hides org.apache.derby.impl.sql.compile.DDLStatementNode.tableName.

private TableDescriptor

private boolean

unique

Constructor Summary

Access	Constructor and Description
pack-priv	CreateIndexNode(boolean True means it's a unique index unique, String The type of index indexType, TableName The name of the index indexName, TableName The name of the table the index will be on tableName, List<String> A list of column names, in the order they appear in the index. columnNameList, Properties The optional properties list associated with the index. properties, ContextManager Context manager cm) Constructor for a CreateIndexNode

Access

Constructor and Description

pack-priv

CreateIndexNode(boolean

True means it's a unique index

unique, String

The type of index

indexType, TableName

The name of the index

indexName, TableName

The name of the table the index will be on

tableName, List<String>

A list of column names, in the order they appear in the index.

columnNameList, Properties

The optional properties list associated with the index.

properties, ContextManager

Context manager

cm)

Constructor for a CreateIndexNode

Modifier and Type	Method and Description
pack-priv void	acceptChildren(Visitor the visitor v) Overrides org.apache.derby.impl.sql.compile.DDLStatementNode.acceptChildren. Accept a visitor on all child nodes.
public void	bindStatement() Overrides org.apache.derby.impl.sql.compile.StatementNode.bindStatement. Bind this CreateIndexNode.
public ConstantAction	makeConstantAction() Overrides org.apache.derby.impl.sql.compile.QueryTreeNode.makeConstantAction. Create the Constant information that will drive the guts of Execution.
public boolean	Returns: true if references SESSION schema tables, else false referencesSessionSchema() Overrides org.apache.derby.impl.sql.compile.QueryTreeNode.referencesSessionSchema. Return true if the node references SESSION schema tables (temporary or permanent)
pack-priv String	statementToString() Implements abstract org.apache.derby.impl.sql.compile.StatementNode.statementToString.
public String	Returns: This object as a String toString() Overrides org.apache.derby.impl.sql.compile.DDLStatementNode.toString. Convert this object to a String.
private void	verifyAndGetUniqueNames() Check the uniqueness of the column names within the derived column list.

Modifier and Type

Method and Description

pack-priv void

acceptChildren(Visitor

the visitor

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

Accept a visitor on all child nodes.

public void

bindStatement()

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

Bind this CreateIndexNode.

public ConstantAction

makeConstantAction()

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

Create the Constant information that will drive the guts of Execution.

public boolean

Returns:

true if references SESSION schema tables, else false

referencesSessionSchema()

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

Return true if the node references SESSION schema tables (temporary or permanent)

pack-priv String

statementToString()

Implements abstract org.apache.derby.impl.sql.compile.StatementNode.statementToString.

public String

Returns:

This object as a String

toString()

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

Convert this object to a String.

private void

verifyAndGetUniqueNames()

Check the uniqueness of the column names within the derived column list.

Field Detail

boundColumnIDs	back to summary
private int[] boundColumnIDs

columnNameList	back to summary
private List<String> columnNameList

columnNames	back to summary
private String[] columnNames

indexName	back to summary
private TableName indexName

indexType	back to summary
private String indexType

isAscending	back to summary
private boolean[] isAscending

properties	back to summary
private Properties properties

tableName	back to summary
private TableName tableName Hides org.apache.derby.impl.sql.compile.DDLStatementNode.tableName.

td	back to summary
private TableDescriptor td

unique	back to summary
private boolean unique

Constructor Detail

CreateIndexNode	back to summary
pack-priv CreateIndexNode(boolean unique, String indexType, TableName indexName, TableName tableName, List<String> columnNameList, Properties properties, ContextManager cm) throws StandardException Constructor for a CreateIndexNode Parameters unique:boolean True means it's a unique index indexType:String The type of index indexName:TableName The name of the index tableName:TableName The name of the table the index will be on columnNameList:List<String> A list of column names, in the order they appear in the index. properties:Properties The optional properties list associated with the index. cm:ContextManager Context manager Exceptions StandardException: Thrown on error

CreateIndexNode

back to summary

pack-priv CreateIndexNode(boolean unique, String indexType, TableName indexName, TableName tableName, List<String> columnNameList, Properties properties, ContextManager cm) throws StandardException

Constructor for a CreateIndexNode

Parameters

unique:boolean: True means it's a unique index
indexType:String: The type of index
indexName:TableName: The name of the index
tableName:TableName: The name of the table the index will be on
columnNameList:List<String>: A list of column names, in the order they appear in the index.
properties:Properties: The optional properties list associated with the index.
cm:ContextManager: Context manager

Exceptions

StandardException:: Thrown on error

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.DDLStatementNode.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.DDLStatementNode.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

bindStatement	back to summary
public void bindStatement() throws StandardException Overrides org.apache.derby.impl.sql.compile.StatementNode.bindStatement. Bind this CreateIndexNode. This means doing any static error checking that can be done before actually creating the table. For example, verifying that the column name list does not contain any duplicate column names. Annotations @Override Exceptions StandardException: Thrown on error

bindStatement

back to summary

public void bindStatement() throws StandardException

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

Bind this CreateIndexNode. This means doing any static error checking that can be done before actually creating the table. For example, verifying that the column name list does not contain any duplicate column names.

Annotations

@Override

Exceptions

StandardException:: Thrown on error

makeConstantAction	back to summary
public ConstantAction makeConstantAction() throws StandardException Overrides org.apache.derby.impl.sql.compile.QueryTreeNode.makeConstantAction. Create the Constant information that will drive the guts of Execution. Annotations @Override Exceptions StandardException: Thrown on failure

makeConstantAction

back to summary

public ConstantAction makeConstantAction() throws StandardException

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

Create the Constant information that will drive the guts of Execution.

Annotations

@Override

Exceptions

StandardException:: Thrown on failure

referencesSessionSchema	back to summary
public boolean referencesSessionSchema() throws StandardException Overrides org.apache.derby.impl.sql.compile.QueryTreeNode.referencesSessionSchema. Return true if the node references SESSION schema tables (temporary or permanent) Returns:boolean true if references SESSION schema tables, else false Annotations @Override Exceptions StandardException: Thrown on error

referencesSessionSchema

back to summary

public boolean referencesSessionSchema() throws StandardException

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

Return true if the node references SESSION schema tables (temporary or permanent)

Returns:boolean

true if references SESSION schema tables, else false

Annotations

@Override

Exceptions

StandardException:: Thrown on error

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

toString	back to summary
public String toString() Overrides org.apache.derby.impl.sql.compile.DDLStatementNode.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.DDLStatementNode.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

verifyAndGetUniqueNames	back to summary
private void verifyAndGetUniqueNames() throws StandardException Check the uniqueness of the column names within the derived column list. Exceptions StandardException: Thrown if column list contains a duplicate name.

verifyAndGetUniqueNames

back to summary

private void verifyAndGetUniqueNames() throws StandardException

Check the uniqueness of the column names within the derived column list.

Exceptions

StandardException:: Thrown if column list contains a duplicate name.

pack-priv Class CreateIndexNode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail