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

Compare with Current View Page History

« Previous Version 18 Next »

Public Methods

MethodDescription
BoundAttachmentsGet all the BoundAttachments of this Attribute.
BoundSecurityPropertiesGet all the BoundSecurityProperties of this Attribute.
DataMovementColumnLinksReturns a collection of DataMovementLinks that link this column to source/target columns.
DataMovementRuleLinksGet all the Bound Data Movement Rules of this Attribute.
DeleteNamingStandardsTemplateUnbind this Attribute from the naming standards template by deleting the naming standards template ID from the attribute.
DeleteReferenceValueUnbind this Attribute from the reference value by deleting the reference value ID from the attribute.
EnableOverrideTurn on or off a specified attribute override flag. PARAMETERS: OverrideFlag as Integer, Enable as Boolean.
GetNamingStandardsTemplateReturns the naming standards template bound to the attribute or null, if none is bound to the attribute.
GetParentReturns the parent Entity of this attribute.
GetReferenceValueReturns the reference value bound to the attribute or null, if none is bound to the attribute.
IsOverrideEnabledCheck if a specified attribute override flag is enabled. PARAMETERS: OverrideFlag as Integer. RETURN DATATYPE: Boolean.
RepoCheckOutStatusGet the Check Out status of this Attribute object. DATATYPE: StringObjects.
RepoVersionHistoryGet the Version History of this Attribute from the Repository server. Return the data in the StringObjects collection. DATATYPE: StringObjects.
SetXMLTypeUse to change the XML's type. Pass the collection name and true for DOCUMENT, false for CONTENT. PARAMETERS: IsDocument as Boolean, CollectionName as String.
SetXMLUnTypedSQL Server 2005 and later only. Use to make the XML datatype of a column untyped (clears CollectionName and DOCUMENT flag). Column must have datatype XML.
UniversalMappingsReturns a collection of universal mappings applied to this object.
UserCommentsReturns a collection of user comments associated with this Attribute.
UserDefinedMappingsReturns a collection of user defined mappings applied to this object.
WhereUsedModelUsageReturns a collection of matches in other models based on the results of a WhereUsed analysis on this object.

Public Properties

PropertyDescription
AllocatedWidthReturns the allocated width of a column. DATATYPE: Integer.
AttributeNameLogical attribute name. DATATYPE: String.
AverageWidthAverage width of a column. This property applies only to physical models. DATATYPE: Integer.
CacheCache property for the column. DATATYPE: Integer.
CharacterSetInterbase 2007 and later and Teradata V2R5 and later only. Specifies the character set for a CHAR, VARCHAR, and BLOB (Interbase) / CLOB (Teradata) column. DATATYPE: String.
CharUsedCharUsed property for the column. DATATYPE: Boolean.
CheckConstraintCheck constraint of the attribute, if any. DATATYPE: String.
CheckConstraintNameName of the Attribute's Check Constraint. DATATYPE: String.
CollateCollate property for the column. DATATYPE: String.
ColorColor of the Attribute object. It takes a 4-byte integer, where the first byte represents red value (0-255), the second byte represents green value (0-255), and the third byte represents blue value (0-255).
ColumnNamePhysical column name. DATATYPE: String.
CompactCompact property for the column. DATATYPE: Boolean.
CompositeDatatypeAttribute's full datatype, including nullability. DATATYPE: String.
CompressTeradata models only. Compress property for the column. DATATYPE: String.
ComputationInterbase 2007 and later and SQL server 7.x and later only. Computation property for columns that are computed. DATATYPE: String.
CycleCycle property for the column. DATATYPE: Boolean.
DataLengthData length of the datatype, if any. DATATYPE: Integer.
DataScaleData scale of the datatype, if any. DATATYPE: Integer.
DatatypeDatatype. Note that you can assign user-defined datatypes in the UserDatatypeId property. DATATYPE: String.
DeclaredDefaultDefault constraint for the attribute, if any. DATATYPE: String.
DefaultIdID of the bounded, default object, if any. This ID is used by ER/Studio. A user can bind a default object to the attribute by assigning a particular default ID to this property. DATATYPE: Integer.
DefaultNameName of the Attribute's default constraint. DATATYPE: String.
DefinitionDefinition of the attribute. DATATYPE: String.
DomainIdID of the bounded, domain object, if any. This ID is used by ER/Studio. A user can bind a domain object to the attribute by assigning a particular domain ID to this property. DATATYPE: Integer.
EncryptedOracle 10.2 and later and Sybase ASE 12.5.3 and later only. Indicates whether a column is encrypted. DATATYPE: Boolean.
EncryptionAlgorithmOracle 10.2 and later only. Specifies the algorithm used for the column encryption. DATATYPE: String.
EncryptionKeySybase ASE 12.5.3 and later only. Specifies the encryption keys used to encrypt the column. DATATYPE: String.
EncryptionSALTOracle 10.2 and later only. Indicates whether a column is encrypted with SALT. DATATYPE: Boolean.
EnumOrSetValuesEnumOrSetValues property for columns that have either Enum or Ser as column data type. DATATYPE: String.
FontFont for the attribute. 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.
ForBitDataForBitData property for the column. DATATYPE: Boolean.
ForeignKeyIndicates whether the attribute is a foreign key. DATATYPE: Boolean.
FormatTeradata models only. Format property for the column. DATATYPE: String.
FreezeNameTrue if this attribute is not affected by naming standards name updates. DATATYPE: Boolean.
GenerateByDefaultGenerateByDefault property for the column. DATATYPE: Boolean.
GenerationExpressionDB2 UDB version 8 and later only. Specifies how to generate the column. DATATYPE: String.
GUIDThis is the GUID of the attribute. This ID is assigned by ER/Studio. Each attribute has a unique GUID. DATATYPE: String.
HasLogicalRoleNameThis indicates if the foreign key column has a logical rolename. DATATYPE: Boolean.
HasRoleNameThis indicates if the foreign key column is rolenamed. DATATYPE: Boolean.
HeadingThis is the DB2 AS/400 Heading for the column. DATATYPE: String.
HiddenThis is the flag indicating that an Attribute is hidden in the Diagram display. Only applied to PK and FK attributes/columns. DATATYPE: Boolean.
HiveColumnPartitionThis property specifies whether the column is a Hive Partitioning Column. DATATYPE: Boolean
HiveComplexTypeThis property specifies the Hive column's Complex datatype. DATATYPE: String
IDThis is the ID of the attribute. This ID is assigned by ER/Studio. Each attribute in a diagram has a unique ID. DATATYPE: Integer.
IdentityThis is the identity property of the attribute. DATATYPE: Boolean.
IdentityIncrementThis is the identity increment value of the attribute. DATATYPE: Integer.
IdentitySeedThis is the identity seed value of the attribute. DATATYPE: Integer.
InterModelIDInterModelID of the object. This ID is assigned by ER/Studio. DATATYPE: Integer.
IntervalYearToMonthThis is the IntervalYearToMonth property for the column. DATATYPE: Boolean.
IsCaseSpecificTrue if this column is case specific. It applies only to CHAR and VARCHAR data types in Teradata version V2R5 and up. DATATYPE: Boolean.
IsComputedReturns true if the column is computed (if there is a value specified for the Computation property), false otherwise. Applies to Interbase 2007 and SQL server 7.x and above only. DATATYPE: Boolean.
IsFileStreamTrue if this column has FILESTREAM property set. It applies only to VARBINARY(MAX) data type in MS SQL SERVER 2008. DATATYPE: Boolean.
IsGeneratedTrue if the column is generated with an expression. This property applies only to DB2 UDB version 8 and later versions. DATATYPE: Boolean.
IsSparseTrue if this is a sparse column. DATATYPE: Boolean.
IsVirtualTrue if this column is an Oracle (11g or higher) virtual column, i.e. a computed column. A column is virtual if it has a VirtualColumnExpression set. Read-Only. DATATYPE: Boolean
IsWithTimeZoneTrue if this column has WITH TIME ZONE property set. It applies only to TIME and TIMESTAMP data types in Teradata all versions. DATATYPE: Boolean.
IsXMLDocumentReturns true if the column has datatype XML and is flagged as document. Applies only to SQL server 2005 and later versions. DATATYPE: Boolean.
LOBUnitThis is the unit to be used for the LOB size. The value can be empty, "K", "M" or "G". DATATYPE: String.
LocalTimeZoneThis is the LocalTimeZone property for the column. DATATYPE: Boolean.
LogicalRoleNameThis is the Logical Rolename. DATATYPE: String.
LogOrPhysOnlyControls the logical/physical only Attribute Property. DATATYPE: Boolean.
MaxValueThis is the MaxValue property for the column. DATATYPE: Integer.
MinValueThis is the MinValue property for the column. DATATYPE: Integer.
MongoDBArrayThis property indicates that the Column is a MongoDB array. DATATYPE: Boolean
NamingStandardsTemplateIdID of the NamingStandardsTemplate object bound to the attribute (if any). A user can bind a NamingStandardsTemplate to the attribute by assigning a particular NamingStandardsTemplateId to this property. DATATYPE: Integer.
NotesThis is the Notes property of the attribute. DATATYPE: String.
NotForReplicationThis property specifies if an identity column constraint is for replication. This applies only to MS SQL Server 2000 and later versions. DATATYPE: Boolean.
NotLoggedThis is the NotLogged property for the column. DATATYPE: Boolean.
NullOptionThis is the nullability of the attribute. The possible values are: 'NULL' or 'NOT NULL'. DATATYPE: String.
OracleNotNullConstraintNameThis property specifies the Not Null constraint of the column. It only applies to Oracle 8 and later versions. DATATYPE: String
PercentNullThis is the percentage of nulls of a column in a table. This property applies only to physical models. DATATYPE: Integer.
PersistedThis property specifies if a computed column is persisted. It applies only to a computed column in SQL Server 2005 and later versions. DATATYPE: Boolean.
PhysicalDatatypeThis is the physical datatype of the attribute. DATATYPE: String.
PrimaryKeyThis indicates if the attribute is a primary key. DATATYPE: Boolean.
ReferenceValueIdID of the ReferenceValue object bound to the attribute (if any). A user can bind a ReferenceValue to the attribute by assigning a particular ReferenceValueId to this property. DATATYPE: Integer.
RoleNameThis is the role name of the attribute. DATATYPE: String.
RowGuidColumnThis is the RowGuidColumn property for the column. DATATYPE: Boolean.
RuleIdThe ID of the bounded, rule object (if any). This ID is used by ER/Studio. A user can bind a rule object to the attribute by assigning a particular rule ID to this property. DATATYPE: Integer.
SequenceNumberThis is the sequence number of the attribute. DATATYPE: Integer.
ShowLengthThis tells whether the datatype length is used (true) or not (false). DATATYPE: Boolean.
ShowScaleThis tells whether the datatype scale is used (true) or not (false). DATATYPE: Boolean.
ShowVirtualColumnDatatypeThis property specifies whether the data type of an Oracle (11g or higher) virtual column should be manually set (true) or automatically determined by the database (false). DATATYPE: Boolean.
SourceDirectTransformationDescriptionThis is the source direct transformation description property for the column. This property applies only to physical models. DATATYPE: String.
SourceDirectTransformationLogicThis is the source direct transformation logic property for the column. This property applies only to physical models. DATATYPE: String.
SourceSecondaryTransformationDescriptionThis is the source secondary transformation description property for the column. This property applies only to physical models. DATATYPE: String.
SourceSecondaryTransformationLogicThis is the source secondary transformation logic property for the column. This property applies only to physical models. DATATYPE: String.
SystemNameThis is the DB2 AS/400 SystemName for the column. DATATYPE: String.
TargetDirectTransformationDescriptionThis is the target direct transformation description property for the column. This property applies only to physical models. DATATYPE: String.
TargetDirectTransformationLogicThis is the target direct transformation logic property for the column. This property applies only to physical models. DATATYPE: String.
TargetSecondaryTransformationDescriptionThis is the target secondary transformation description property for the column. This property applies only to physical models. DATATYPE: String.
TargetSecondaryTransformationLogicThis is the target secondary transformation logic property for the column. This property applies only to physical models. DATATYPE: String.
TeradataCollectStatisticsThis property specifies whether the collect statistics option of the column is on for Teradata (V12 or higher). DATATYPE: Boolean.
TeradataIntervalStrThis property specifies the interval string for a column with INTERVAL datatype, It only applies to Teradata 13 and later versions.. DATATYPE: String.
TeradataPeriodThis property specifies whether the column has PERIOD datatype. It only applies to columns that have datatype as TIME, TIMESTAMP and DATE in Teradata 13 and later versions. DATATYPE: Boolean
TeradataUsingSampleThis property specifies whether the using sample option of the column is on for Teradata (V12 or higher), the collect statistics option has to be on before this option can be set. DATATYPE: Boolean.
TextLabelThis is the DB2 AS/400 TextLabel for the column. DATATYPE: String.
TimeZoneThis is the TimeZone property for the column. DATATYPE: Boolean.
TitleThis is the Title property for the column. This property is only used in Teradata models. DATATYPE: String.
UnsignedThis property specifies if the column data type is unsigned. It applies only to MySQL platforms. DATATYPE: Boolean.
UserDatatypeIdThe ID of the bounded, user datatype object (if any). This ID is used by ER/Studio. A user can bind a user datatype object to the attribute by assigning a particular user datatype ID to this property. DATATYPE: Integer.
VirtualColumnExpressionThis property holds the expression used to compute an Oracle (11g or higher) virtual column. DATATYPE: String
XMLCollectionThis represents the column's Collection property, which applies to Columns with datatype XML. Applies only to SQL server 2005 and later versions. DATATYPE: String.

See Also

  • No labels