OpenAPI 1.0

com.aquafold.openapi.rdbms.schema
Interface AQIndex

All Superinterfaces:
AQSchemaObject, AQServerObject

public interface AQIndex
extends AQSchemaObject

This interface represents an index.


Method Summary
 AQIndexColumn[] extractColumns()
          To get a list of columns used by the index.
 AQPartition[] extractPartitions()
          To get a list of partitions associated with this index.
 AQObjectPermission[] extractPermissions()
          To get a list of permissions for the database index.
 String getTableName()
          To get the table name associated with this index.
 String getTableSchemaName()
          To get the schema name of the table associated with this index.
 boolean isUserDefined()
          To get if the index is a user defined index
 String scriptCREATEFULL()
          To generate the full creation script for the index.
 
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

AQIndexColumn[] extractColumns()
To get a list of columns used by the index.

Returns:
An array of AQIndexColumn objects; empty array if no columns exist.

extractPermissions

AQObjectPermission[] extractPermissions()
To get a list of permissions for the database index.

Returns:
An array of AQObjectPermission; empty array if no permissions exist.

extractPartitions

AQPartition[] extractPartitions()
To get a list of partitions associated with this index.

Returns:
An array of AQPartition objects;

scriptCREATEFULL

String scriptCREATEFULL()
                        throws Exception
To generate the full creation script for the index. The result will include partition and storage information.

Returns:
The create script for the index object.
Throws:
Exception

getTableName

String getTableName()
To get the table name associated with this index.

Returns:
The table name.

getTableSchemaName

String getTableSchemaName()
To get the schema name of the table associated with this index.

Returns:
The table schema name.

isUserDefined

boolean isUserDefined()
To get if the index is a user defined index

Returns:
The index user defined boolean value.

OpenAPI 1.0


Copyright © 2010 AquaFold, Inc. All Rights Reserved. Use is subject to license terms.