Versions Compared

Old Version 2

changes.mady.by.user Nadja Pollard

Saved on

compared with

New Version Current

changes.mady.by.user Nadja Pollard

Saved on

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
od
of user comments associated with this Index.

Public Properties

PropertyDescription

AllowReverseScans

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.
KeyType
This identifies
Identifies and sets the KeyType
if it's
to P (PK), A (Alternate), or I (Inversion). DATATYPE: String.
Location
This is the location
Location of the index storage. DATATYPE: String.
LockModeSetting
This is the
LockModeSetting of the index storage. DATATYPE: Integer.
LogOrPhysOnlyControls the logical/physical only Index Property. DATATYPE: Boolean.
MaximumExtents
This is the
MaximumExtents of the index storage. Parameter can be a positive integer as string or UNLIMITED. DATATYPE: String.
MaximumRowsPerPage
This is the
MaximumRowsPerPage of the index storage. DATATYPE: Integer.
MaximumTransactions
This is the
MaximumTransactions of the index storage. DATATYPE: Integer.
MinimumExtents
This is the
MinimumExtents of the index storage. DATATYPE: Integer.
MinimumTransactions
This is the
MinimumTransactions of the index storage. DATATYPE: Integer.
MinPercentUsed
This property specifies
Specifies the minimum percent used. DATATYPE: Integer.
Name
This is the name
Name of the index. DATATYPE: String.
NextExtentSize
This is the
NextExtentSize of the index storage. DATATYPE: Integer.
NoLogging
This property specifies
Specifies whether NoLogging is set (true). DATATYPE: Boolean.
NoValidateOracle only. Used for PKIndexes
on Oracle platforms. Determines
and determines if the constraint is NoValidate (true) or Validate (false). DATATYPE: Boolean.
OracleBitMap
This property specifies
Specifies either BTree (false) or BitMap (true). To set it, the BitMap, Unique, NoSort, and ReverseByteOrder must be false. DATATYPE: Boolean.
OracleBufferPool
This property holds
Holds the value for BufferPool.
Legal
Valid values are KEEP, DEFAULT, RECYCLE. DATATYPE: String.
OracleDegrees
Property holds
Holds the value for Degrees (positive int or zero). To set it, the Degrees Parallel must be true. DATATYPE: Integer.
OracleIndexFunction
This specifies
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, the Instances Parallel must be true. DATATYPE: Integer.
OracleNoSort
This property specifies
Specifies whether NoSort is set (true). To set it, the NoSort, BitMap, and ReverseByteOrder must be false. DATATYPE: Boolean.
OracleParallel
This property specifies
Specifies whether the Parallel Option is set (true). DATATYPE: Boolean.
OracleReverseByteOrder
This property specifies
Specifies whether ReverseByteOrder is true, false specifies forward. To set it, the NoSort and BitMap must be false. DATATYPE: Boolean.
Owner
This property specifies the owner of the index. Applies to
Oracle, DB2 UDB
V6
versions 6,
V7
7,
V8 and OS390 platforms
and 8; and OS/390 platforms only. Specifies the owner of the index. On Oracle platforms this property is
readonly
read only. DATATYPE: String.
PadIndex
This property specifies
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
v6 and later
versions
, and Oracle 9 and later
versions
only. Specifies whether the ConstraintName associated with the index. DATATYPE: String.
SortInTempdb
This property specifies
Specifies whether
or not
the intermediate sort results used to build the index
will be
are sorted in the tempdb database. DATATYPE: Boolean.
SybaseIQDelimitedBy
This property specifies
SybaseIQ only. Specifies the string separators for the WD index
in SybaseIQ
. DATATYPE: String.
SybaseIQIndexType
This property specifies
SybaseIQ only. Specifies the index type
in SybaseIQ
. DATATYPE: String.
SybaseIQLimit
This property specifies
SybaseIQ only. Specifies the max length of the WD index column
in SybaseIQ
. DATATYPE: Integer.
TeradataCollectStatistics
This property specifies
Teradata v12 and later only. Specifies whether the collect statistics option of the index is on
for Teradata (V12 or higher)
. DATATYPE: Boolean.
TeradataPartitioningExpression
This specifies
Teradata only. Specifies the Teradata Partitioning Expression of the index. DATATYPE: String.
TeradataPrimary
This property specifies whether or not
Teradata only. Specifies whether the index is a Teradata primary index. DATATYPE: Boolean.
TeradataUsingSample
This property specifies
Teradata v12 and later only. Specifies whether the using sample option of the index is on
for Teradata (V12 or higher), the
. The collect statistics option
has to
must be on before you can set 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'
Index type. Valid values are C (Clustered), N (NonClustered), and H (Hashed). DATATYPE: String.
Unique
This determines
Determines whether the index is unique (true) or not unique (false). DATATYPE: Boolean.
Info
titleSee Also