You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Public Methods

MethodDescription

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

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.
KeyTypeThis identifies and sets the KeyType if it's P (PK), A (Alternate) or I (Inversion). DATATYPE: String.
LocationThis is the location of the index storage. DATATYPE: String.
LockModeSettingThis is the LockModeSetting of the index storage. DATATYPE: Integer.
LogOrPhysOnlyControls the logical/physical only Index Property. DATATYPE: Boolean.
MaximumExtentsThis is the MaximumExtents of the index storage. Parameter can be positive integer as string or UNLIMITED. DATATYPE: String.
MaximumRowsPerPageThis is the MaximumRowsPerPage of the index storage. DATATYPE: Integer.
MaximumTransactionsThis is the MaximumTransactions of the index storage. DATATYPE: Integer.
MinimumExtentsThis is the MinimumExtents of the index storage. DATATYPE: Integer.
MinimumTransactionsThis is the MinimumTransactions of the index storage. DATATYPE: Integer.
MinPercentUsedThis property specifies the minimum percent used. DATATYPE: Integer.
NameThis is the name of the index. DATATYPE: String.
NextExtentSizeThis is the NextExtentSize of the index storage. DATATYPE: Integer.
NoLoggingThis property specifies whether NoLogging is set (true). DATATYPE: Boolean.
NoValidateUsed for PKIndexes on Oracle platforms. Determines if the constraint is NoValidate (true) or Validate (false).DATATYPE: Boolean.
OracleBitMapThis property specifies either BTree (false) or BitMap (true). To set it, BitMap, Unique, NoSort, and ReverseByteOrder must be false. DATATYPE: Boolean.
OracleBufferPoolThis property holds the value for BufferPool. Legal values are KEEP, DEFAULT, RECYCLE. DATATYPE: String.
OracleDegreesProperty holds the value for Degrees (positive int or zero). To set it, Degrees Parallel must be true. DATATYPE: Integer.
OracleIndexFunctionThis specifies 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, Instances Parallel must be true. DATATYPE: Integer.
OracleNoSortThis property specifies whether NoSort is set (true). To set it, NoSort, BitMap, and ReverseByteOrder must be false. DATATYPE: Boolean.
OracleParallelThis property specifies whether the Parallel Option is set (true). DATATYPE: Boolean.
OracleReverseByteOrderThis property specifies whether ReverseByteOrder is true, false specifies forward. To set it, NoSort and BitMap must be false. DATATYPE: Boolean.
OwnerThis property specifies the owner of the index. Applies to Oracle, DB2 UDB V6, V7, V8 and OS390 platforms. On Oracle platforms this property is readonly. DATATYPE: String.
PadIndexThis 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.
PercentFreeThis is the PercentFree of the index storage. DATATYPE: Integer.
PercentUsedThis is the PercentUsed of the index storage. DATATYPE: Integer.
PKConstraintNameThis 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.
SortInTempdbThis property specifies whether or not the intermediate sort results used to build the index will be sorted in the tempdb database. DATATYPE: Boolean.
SybaseIQDelimitedByThis property specifies the string separators for WD index in SybaseIQ. DATATYPE: String.
SybaseIQIndexTypeThis property specifies the index type in SybaseIQ. DATATYPE: String.
SybaseIQLimitThis property specifies the max length of the WD index column in SybaseIQ. DATATYPE: Integer.
TeradataCollectStatisticsThis property specifies whether the collect statistics option of the index is on for Teradata (V12 or higher). DATATYPE: Boolean.
TeradataPartitioningExpressionThis specifies the Teradata Partitioning Expression of the index. DATATYPE: String.
TeradataPrimaryThis property specifies whether or not the index is a Teradata primary index. DATATYPE: Boolean.
TeradataUsingSampleThis 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.
TypeThis is the type of the index. The possible values are: Clustered -'C', NonClustered - 'N', Hashed - 'H'. DATATYPE: String.
UniqueThis determines whether the index is unique (true) or not unique (false). DATATYPE: Boolean.

See Also

  • No labels