Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Public Methods

MethodDescription
BoundAttachmentsGet all the BoundAttachments of this Index.
DB2IdxPartitionsGet DB2IdxPartitions of this Index.
IndexColumnsReturns an object representing a collection of index columns for the index.
OracleIndexPartitionsOracle 9i and later models only. Get Partitions of this Index.
RepoCheckOutStatusGet the Check Out status of this Index object.
RepoVersionHistoryGet the Version History of this Index from the Repository server. Return the data in the StringObjects collection. DATATYPE: StringObjects.
UserCommentsReturns a collection of user comments associated with this Index.

Public Properties

PropertyDescription
Specifies whether reverse scans are allowed. DATATYPE: Boolean.
ClusteredDetermines whether the index is clustered (true) or not clustered (false). DATATYPE: Boolean.
ColorColor 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).
CompressCompress property of the Index. DATATYPE: Boolean.
CompressLengthCompression Prefix Length property of the Index. DATATYPE: Integer.
DB2BufferPoolDetermines which bufferpool is used for the index. DATATYPE: String.
DB2CloseDetermines whether the index CLOSE property is YES (true) or NO (false). DATATYPE: Boolean.
DB2CopyDetermines whether the index COPY property is YES (true) or NO (false). DATATYPE: Boolean.
DB2DeferFlags the Index Defer property to delay creation of B-Tree. DATATYPE: Boolean.
DB2EraseDetermines whether the index ERASE property is YES (true) or NO (false). DATATYPE: Boolean.
DB2OSPaddedDB2 OS/390 v8 and later only. Specifies whether the index is padded. DATATYPE: Boolean.
DB2OSPartitionedDB2 OS/390 and later only. Specifies whether the index is partitioned. DATATYPE: Boolean.
DB2UniqueNotNullFlag the Index Unique Not NULL property. DATATYPE: Boolean.
DisableUsed 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.
ExtentGrowthFactorExtentGrowthFactor of the index storage. DATATYPE: Integer.
FillfactorPercentFillfactorPercent of the index storage. DATATYPE: Integer.
FontFont 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.
FreeListGroupsSpecifies the value for FreeListGroups. Input must be a positive integer or zero. DATATYPE: Integer.
FreeListsSpecifies the value for FreeLists. Input must be a positive integer or zero. DATATYPE: Integer.
FulltextSpecifies whether the index is a MySql FULLTEXT index. DATATYPE: Boolean.
GBPCacheDetermines the GBPCACHE setting. Valid values are ALL, CHANGED, and NONE. DATATYPE: String.
GUIDGUID of the index as assigned by ER/Studio. Each index has a unique GUID. DATATYPE: String.
HiRDBSplitSpecifies whether the Unbalanced Split Option is set (true). DATATYPE: Boolean.
HiveDeferredRebuildHive models only. Specifies the deferred rebuild option of the index on Hive models. DATATYPE: Boolean.
HiveIndexTypeHive models only. Specifies Hive Index Type for indexes in Hive models. DATATYPE: String.
IDID of the index as assigned by ER/Studio. Each index in a diagram has a unique ID. DATATYPE: Integer.
IgnoreDupKeysFlags the Ignore Dup Keys option of indexes in SQL Server models. DATATYPE: Boolean.
IncludeSpecifies the DB2 include columns. DATATYPE: String.
InitialExtentSizeInitialExtentSize of the index storage. DATATYPE: Integer.
InterModelIDInterModelID of the object as assigned by ER/Studio. DATATYPE: Integer.
IsFunctionBasedRead-only. True if the index is a function-based index. DATATYPE: Boolean.
IsPKDetermines whether the index is PKIndex (true) or not PKIndex (false). DATATYPE: Boolean.
IsStoGroupDetermines whether the index storage type is STOGROUP (true) or VCAT (false). DATATYPE: Boolean.
IsUniqueConstraintSpecifies whether the index is a Unique Constraint. DATATYPE: Boolean.
KeyTypeIdentifies and sets the KeyType to P (PK), A (Alternate), or I (Inversion). DATATYPE: String.
LocationLocation of the index storage. DATATYPE: String.
LockModeSettingLockModeSetting of the index storage. DATATYPE: Integer.
LogOrPhysOnlyControls the logical/physical only Index Property. DATATYPE: Boolean.
MaximumExtentsMaximumExtents of the index storage. Parameter can be a positive integer as string or UNLIMITED. DATATYPE: String.
MaximumRowsPerPageMaximumRowsPerPage of the index storage. DATATYPE: Integer.
MaximumTransactionsMaximumTransactions of the index storage. DATATYPE: Integer.
MinimumExtentsMinimumExtents of the index storage. DATATYPE: Integer.
MinimumTransactionsMinimumTransactions of the index storage. DATATYPE: Integer.
MinPercentUsedSpecifies the minimum percent used. DATATYPE: Integer.
NameName of the index. DATATYPE: String.
NextExtentSizeNextExtentSize of the index storage. DATATYPE: Integer.
NoLoggingSpecifies whether NoLogging is set (true). DATATYPE: Boolean.
NoValidateOracle only. Used for PKIndexes and determines if the constraint is NoValidate (true) or Validate (false). DATATYPE: Boolean.
OracleBitMapSpecifies either BTree (false) or BitMap (true). To set it, the BitMap, Unique, NoSort, and ReverseByteOrder must be false. DATATYPE: Boolean.
OracleBufferPoolHolds the value for BufferPool. Valid values are KEEP, DEFAULT, RECYCLE. DATATYPE: String.
OracleDegreesHolds the value for Degrees (positive int or zero). To set it, the Degrees Parallel must be true. DATATYPE: Integer.
OracleIndexFunctionSpecifies the expression used for a function-based index in Oracle. DATATYPE: String.
OracleInstancesProperty holds the value for Instances (postive int or zero). To set it, the Instances Parallel must be true. DATATYPE: Integer.
OracleNoSortSpecifies whether NoSort is set (true). To set it, the NoSort, BitMap, and ReverseByteOrder must be false. DATATYPE: Boolean.
OracleParallelSpecifies whether the Parallel Option is set (true). DATATYPE: Boolean.
OracleReverseByteOrderSpecifies whether ReverseByteOrder is true, false specifies forward. To set it, the NoSort and BitMap must be false. DATATYPE: Boolean.
OwnerOracle, 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.
PadIndexSpecifies 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.
PercentFreePercentFree of the index storage. DATATYPE: Integer.
PercentUsedPercentUsed of the index storage. DATATYPE: Integer.
PKConstraintNameDB2 UDB v6 and later, and Oracle 9 and later only. Specifies whether the ConstraintName associated with the index. DATATYPE: String.
SortInTempdbSpecifies whether the intermediate sort results used to build the index are sorted in the tempdb database. DATATYPE: Boolean.
SybaseIQDelimitedBySybaseIQ only. Specifies the string separators for the WD index. DATATYPE: String.
SybaseIQIndexTypeSybaseIQ only. Specifies the index type. DATATYPE: String.
SybaseIQLimitSybaseIQ only. Specifies the max length of the WD index column. DATATYPE: Integer.
TeradataCollectStatisticsTeradata v12 and later only. Specifies whether the collect statistics option of the index is on. DATATYPE: Boolean.
TeradataPartitioningExpressionTeradata only. Specifies the Teradata Partitioning Expression of the index. DATATYPE: String.
TeradataPrimaryTeradata only. Specifies whether the index is a Teradata primary index. DATATYPE: Boolean.
TeradataUsingSampleTeradata v12 and later only. Specifies whether the using sample option of the index is on. The collect statistics option must be on before you can set this option. DATATYPE: Boolean.
TypeIndex type. Valid values are C (Clustered), N (NonClustered), and H (Hashed). DATATYPE: String.
UniqueDetermines whether the index is unique (true) or not unique (false). DATATYPE: Boolean.
Info
titleSee Also