Page History
Public Methods
| Method | Description |
|---|---|
| Get all the BoundAttachments of this Index. | |
| Get DB2IdxPartitions of this Index. | |
| Returns an object representing a collection of index columns for the index. | |
| Oracle 9i and later models only. Get Partitions of this Index. | |
| Get the Check Out status of this Index object. | |
| Get the Version History of this Index from the Repository server. Return the data in the StringObjects collection. DATATYPE: StringObjects. | |
| Returns a collection od user comments associated with this Index. |
Public Properties
| Property | Description |
|---|---|
| Specifies whether reverse scans are allowed. DATATYPE: Boolean. | |
| Clustered | Determines whether the index is clustered (true) or not clustered (false). DATATYPE: Boolean. |
| Color | Color for the index. It takes a 4-byte integer where the first byte represents red value (0-255), the second byte is the green value (0-255), and the third byte is the blue value (0-255). |
| Compress | Compress property of the Index. DATATYPE: Boolean. |
| CompressLength | Compression Prefix Length property of the Index. DATATYPE: Integer. |
| DB2BufferPool | Determines which bufferpool is used for the index. DATATYPE: String. |
| DB2Close | Determines whether the index CLOSE property is YES (true) or NO (false). DATATYPE: Boolean. |
| DB2Copy | Determines whether the index COPY property is YES (true) or NO (false). DATATYPE: Boolean. |
| DB2Defer | Flags the Index Defer property to delay creation of B-Tree. DATATYPE: Boolean. |
| DB2Erase | Determines whether the index ERASE property is YES (true) or NO (false). DATATYPE: Boolean. |
| DB2OSPadded | DB2 OS/390 v8 and later only. Specifies whether the index is padded. DATATYPE: Boolean. |
| DB2OSPartitioned | DB2 OS/390 and later only. Specifies whether the index is partitioned. DATATYPE: Boolean. |
| DB2UniqueNotNull | Flag the Index Unique Not NULL property. DATATYPE: Boolean. |
| Disable | Used for PKIndexes on Oracle platforms. Determines whether the constraint is disabled (true) or enabled (false). When set to true, the corresponding FKs are also set to true. DATATYPE: Boolean. |
| ExtentGrowthFactor | ExtentGrowthFactor of the index storage. DATATYPE: Integer. |
| FillfactorPercent | FillfactorPercent of the index storage. DATATYPE: Integer. |
| Font | Font for the index name. Although this property is read only, the user can modify the font by setting the properties in the ERSFont object, which is returned to the caller. |
| FreeListGroups | Specifies the value for FreeListGroups. Input must be a positive integer or zero. DATATYPE: Integer. |
| FreeLists | Specifies the value for FreeLists. Input must be a positive integer or zero. DATATYPE: Integer. |
| Fulltext | Specifies whether the index is a MySql FULLTEXT index. DATATYPE: Boolean. |
| GBPCache | Determines the GBPCACHE setting. Valid values are ALL, CHANGED, and NONE. DATATYPE: String. |
| GUID | GUID of the index as assigned by ER/Studio. Each index has a unique GUID. DATATYPE: String. |
| HiRDBSplit | Specifies whether the Unbalanced Split Option is set (true). DATATYPE: Boolean. |
| HiveDeferredRebuild | Hive models only. Specifies the deferred rebuild option of the index on Hive models. DATATYPE: Boolean. |
| HiveIndexType | Hive models only. Specifies Hive Index Type for indexes in Hive models. DATATYPE: String. |
| ID | ID of the index as assigned by ER/Studio. Each index in a diagram has a unique ID. DATATYPE: Integer. |
| IgnoreDupKeys | Flags the Ignore Dup Keys option of indexes in SQL Server models. DATATYPE: Boolean. |
| Include | Specifies the DB2 include columns. DATATYPE: String. |
| InitialExtentSize | InitialExtentSize of the index storage. DATATYPE: Integer. |
| InterModelID | InterModelID of the object as assigned by ER/Studio. DATATYPE: Integer. |
| IsFunctionBased | Read-only. True if the index is a function-based index. DATATYPE: Boolean. |
| IsPK | Determines whether the index is PKIndex (true) or not PKIndex (false). DATATYPE: Boolean. |
| IsStoGroup | Determines whether the index storage type is STOGROUP (true) or VCAT (false). DATATYPE: Boolean. |
| IsUniqueConstraint | Specifies whether the index is a Unique Constraint. DATATYPE: Boolean. |
| KeyType |
| Identifies and sets the KeyType |
| to P (PK), A (Alternate), or I (Inversion). DATATYPE: String. |
| Location |
| Location of the index storage. DATATYPE: String. |
| LockModeSetting |
| LockModeSetting of the index storage. DATATYPE: Integer. | |
| LogOrPhysOnly | Controls the logical/physical only Index Property. DATATYPE: Boolean. |
| MaximumExtents |
| MaximumExtents of the index storage. Parameter can be a positive integer as string or UNLIMITED. DATATYPE: String. |
| MaximumRowsPerPage |
| MaximumRowsPerPage of the index storage. DATATYPE: Integer. |
| MaximumTransactions |
| MaximumTransactions of the index storage. DATATYPE: Integer. |
| MinimumExtents |
| MinimumExtents of the index storage. DATATYPE: Integer. |
| MinimumTransactions |
| MinimumTransactions of the index storage. DATATYPE: Integer. |
| MinPercentUsed |
| Specifies the minimum percent used. DATATYPE: Integer. |
| Name |
| Name of the index. DATATYPE: String. |
| NextExtentSize |
| NextExtentSize of the index storage. DATATYPE: Integer. |
| NoLogging |
| Specifies whether NoLogging is set (true). DATATYPE: Boolean. | |
| NoValidate | Oracle only. Used for PKIndexes |
| and determines if the constraint is NoValidate (true) or Validate (false). DATATYPE: Boolean. |
| OracleBitMap |
| Specifies either BTree (false) or BitMap (true). To set it, the BitMap, Unique, NoSort, and ReverseByteOrder must be false. DATATYPE: Boolean. |
| OracleBufferPool |
| Holds the value for BufferPool. |
| Valid values are KEEP, DEFAULT, RECYCLE. DATATYPE: String. |
| OracleDegrees |
| Holds the value for Degrees (positive int or zero). To set it, the Degrees Parallel must be true. DATATYPE: Integer. |
| OracleIndexFunction |
| Specifies the expression used for a function-based index in Oracle. DATATYPE: String. | |
| OracleInstances | Property holds the value for Instances (postive int or zero). To set it, the Instances Parallel must be true. DATATYPE: Integer. |
| OracleNoSort |
| Specifies whether NoSort is set (true). To set it, the NoSort, BitMap, and ReverseByteOrder must be false. DATATYPE: Boolean. |
| OracleParallel |
| Specifies whether the Parallel Option is set (true). DATATYPE: Boolean. |
| OracleReverseByteOrder |
| Specifies whether ReverseByteOrder is true, false specifies forward. To set it, the NoSort and BitMap must be false. DATATYPE: Boolean. |
| Owner |
| Oracle, DB2 UDB |
| versions 6, |
| 7, |
| and 8; and OS/390 platforms only. Specifies the owner of the index. On Oracle platforms this property is |
| read only. DATATYPE: String. | |
| PadIndex | This property specifies the space to leave open on each page (node) in the intermediate levels of the index. The PadIndex option is useful only when FillFactor is specified. DATATYPE: Boolean. |
| PercentFree | This is the PercentFree of the index storage. DATATYPE: Integer. |
| PercentUsed | This is the PercentUsed of the index storage. DATATYPE: Integer. |
| PKConstraintName | This specifies if the ConstraintName associated with the index. This applies only to DB2 UDB V6 or later versions and Oracle 9 and later versions. DATATYPE: String. |
| SortInTempdb | This property specifies whether or not the intermediate sort results used to build the index will be sorted in the tempdb database. DATATYPE: Boolean. |
| SybaseIQDelimitedBy | This property specifies the string separators for WD index in SybaseIQ. DATATYPE: String. |
| SybaseIQIndexType | This property specifies the index type in SybaseIQ. DATATYPE: String. |
| SybaseIQLimit | This property specifies the max length of the WD index column in SybaseIQ. DATATYPE: Integer. |
| TeradataCollectStatistics | This property specifies whether the collect statistics option of the index is on for Teradata (V12 or higher). DATATYPE: Boolean. |
| TeradataPartitioningExpression | This specifies the Teradata Partitioning Expression of the index. DATATYPE: String. |
| TeradataPrimary | This property specifies whether or not the index is a Teradata primary index. DATATYPE: Boolean. |
| TeradataUsingSample | This property specifies whether the using sample option of the index is on for Teradata (V12 or higher), the collect statistics option has to be on before this option can be set. DATATYPE: Boolean. |
| Type | This is the type of the index. The possible values are: Clustered -'C', NonClustered - 'N', Hashed - 'H'. DATATYPE: String. |
| Unique | This determines whether the index is unique (true) or not unique (false). DATATYPE: Boolean. |
| Info | ||
|---|---|---|
| ||