com.aquafold.openapi.rdbms.schema
Interface AQTable

All Superinterfaces:

AQSchemaObject, AQServerObject

public interface AQTable
extends AQSchemaObject

This interface represents a database table object.

Method Summary

AQTableColumn[]	extractColumns() To get a list of table columns.
AQConstraint	extractConstraint(String name) To get information on a constraint associated with the table that is specified by the user.
AQConstraint[]	extractConstraints() To get a list of constraints associated with the table.
AQIndex	extractIndex(String name) To get information on an index associated with the table that is specified by the user.
AQIndex[]	extractIndexes() To get a list of indexes associated with the table.
AQPartition	extractPartition(String name)
AQPartition[]	extractPartitions() To get a list of database partitions.
AQObjectPermission[]	extractPermissions() To get a list of permissions for the table.
AQConstraintColumn[]	extractPrimaryKeyColumns() To get a list of columns associated with the primary key constraint.
AQTrigger	extractTrigger(String name) To get information on a trigger associated with the table that is specified by the user.
AQTrigger[]	extractTriggers() To get a list of triggers associated with the table.
AQTableWriter	getWriter() Returns a writer object suitable for importing data into the table.
String	scriptCREATEFULL()

Methods inherited from interface com.aquafold.openapi.rdbms.AQSchemaObject

getDatabaseName, getSchemaName

Methods inherited from interface com.aquafold.openapi.rdbms.AQServerObject

getIcon, getName, getServerConnection, getTypeName, scriptCREATE, scriptCREATE, scriptDROP

Method Detail

extractColumns

AQTableColumn[] extractColumns()

To get a list of table columns.

Returns:

An array of AQTableColumn objects; empty array if no columns exist. Yes, it can happen, look for "special" tables in Sybase ASE.

extractConstraints

AQConstraint[] extractConstraints()

To get a list of constraints associated with the table.

Returns:

An array of AQConstraints objects; empty array if no constraints exist.

extractConstraint

AQConstraint extractConstraint(String name)

To get information on a constraint associated with the table that is specified by the user.

Parameters:

name - The name of the constraint.

Returns:

An AQConstraint object; null if the constraint specified does not exist.

extractPrimaryKeyColumns

AQConstraintColumn[] extractPrimaryKeyColumns()

To get a list of columns associated with the primary key constraint.

Returns:

A list of columns associated with the primary key constraint; if primary key is not defined, an empty array is returned.

extractIndexes

AQIndex[] extractIndexes()

To get a list of indexes associated with the table.

Returns:

An array of AQIndex objects; empty array if no indexes exist.

extractIndex

AQIndex extractIndex(String name)

To get information on an index associated with the table that is specified by the user.

Parameters:

name - The name of the index.

Returns:

An AQIndex object; null if the index specified does not exist.

extractTriggers

AQTrigger[] extractTriggers()

To get a list of triggers associated with the table.

Returns:

An array of AQTrigger objects; empty array if no triggers exist.

extractTrigger

AQTrigger extractTrigger(String name)

To get information on a trigger associated with the table that is specified by the user.

Parameters:

name - The name of the trigger.`

Returns:

An AQTrigger object; null if trigger specified does not exist.

extractPermissions

AQObjectPermission[] extractPermissions()

To get a list of permissions for the table.

Returns:

An array of AQObjectPermission objects; empty array if no permissions exist.

extractPartitions

AQPartition[] extractPartitions()

To get a list of database partitions.

This method only applies to the following databases:

• Oracle 8i
• Oracle 9g
• Oracle 10g
• Oracle 11g

• MySql 6.x

• DB2 LUW 8.x
• Db2 LUW 9.x

Returns:

An array of AQPartition objects; array will be zero length if no package bodies exist.

extractPartition

AQPartition extractPartition(String name)

scriptCREATEFULL

String scriptCREATEFULL()
                        throws Exception

Throws:

Exception

getWriter

AQTableWriter getWriter()

Returns a writer object suitable for importing data into the table.