AttributeObj Members

Public Methods

Method	Description
BoundAttachments	Get all the BoundAttachments of this Attribute.
BoundSecurityProperties	Get all the BoundSecurityProperties of this Attribute.
DataMovementColumnLinks	Returns a collection of DataMovementLinks that link this column to source/target columns.
DataMovementRuleLinks	Get all the Bound Data Movement Rules of this Attribute.
DeleteNamingStandardsTemplate	Unbind this Attribute from the naming standards template by deleting the naming standards template ID from the attribute.
DeleteReferenceValue	Unbind this Attribute from the reference value by deleting the reference value ID from the attribute.
EnableOverride	Turn on or off a specified attribute override flag. PARAMETERS: OverrideFlag as Integer, Enable as Boolean.
GetNamingStandardsTemplate	Returns the naming standards template bound to the attribute or null, if none is bound to the attribute.
GetParent	Returns the parent Entity of this attribute.
GetReferenceValue	Returns the reference value bound to the attribute or null, if none is bound to the attribute.
IsOverrideEnabled	Check if a specified attribute override flag is enabled. PARAMETERS: OverrideFlag as Integer. RETURN DATATYPE: Boolean.
RepoCheckOutStatus	Get the Check Out status of this Attribute object. DATATYPE: StringObjects.
RepoVersionHistory	Get the Version History of this Attribute from the Repository server. Return the data in the StringObjects collection. DATATYPE: StringObjects.
SetXMLType	Use to change the XML's type. Pass the collection name and true for DOCUMENT, false for CONTENT. PARAMETERS: IsDocument as Boolean, CollectionName as String.
SetXMLUnTyped	SQL 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.
UniversalMappings	Returns a collection of universal mappings applied to this object.
UserComments	Returns a collection of user comments associated with this Attribute.
UserDefinedMappings	Returns a collection of user defined mappings applied to this object.
WhereUsedModelUsage	Returns a collection of matches in other models based on the results of a WhereUsed analysis on this object.

Public Properties

Property	Description
AllocatedWidth	Returns the allocated width of a column. DATATYPE: Integer.
AttributeName	Logical attribute name. DATATYPE: String.
AverageWidth	Average width of a column. This property applies only to physical models. DATATYPE: Integer.
Cache	Cache property for the column. DATATYPE: Integer.
CharacterSet	Interbase 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.
CharUsed	CharUsed property for the column. DATATYPE: Boolean.
CheckConstraint	Check constraint of the attribute, if any. DATATYPE: String.
CheckConstraintName	Name of the Attribute's Check Constraint. DATATYPE: String.
Collate	Collate property for the column. DATATYPE: String.
Color	Color 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).
ColumnName	Physical column name. DATATYPE: String.
Compact	Compact property for the column. DATATYPE: Boolean.
CompositeDatatype	Attribute's full datatype, including nullability. DATATYPE: String.
Compress	Teradata models only. Compress property for the column. DATATYPE: String.
Computation	Interbase 2007 and later and SQL server 7.x and later only. Computation property for columns that are computed. DATATYPE: String.
Cycle	Cycle property for the column. DATATYPE: Boolean.
DataLength	Data length of the datatype, if any. DATATYPE: Integer.
DataScale	Data scale of the datatype, if any. DATATYPE: Integer.
Datatype	Datatype. Note that you can assign user-defined datatypes in the UserDatatypeId property. DATATYPE: String.
DeclaredDefault	Default constraint for the attribute, if any. DATATYPE: String.
DefaultId	ID of the bounded default object, if any. A user can bind a default object to the attribute by assigning a particular default ID to this property. DATATYPE: Integer.
DefaultName	Name of the Attribute's default constraint. DATATYPE: String.
Definition	Definition of the attribute. DATATYPE: String.
DomainId	ID 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.
Encrypted	Oracle 10.2 and later and Sybase ASE 12.5.3 and later only. Indicates whether a column is encrypted. DATATYPE: Boolean.
EncryptionAlgorithm	Oracle 10.2 and later only. Specifies the algorithm used for the column encryption. DATATYPE: String.
EncryptionKey	Sybase ASE 12.5.3 and later only. Specifies the encryption keys used to encrypt the column. DATATYPE: String.
EncryptionSALT	Oracle 10.2 and later only. Indicates whether a column is encrypted with SALT. DATATYPE: Boolean.
EnumOrSetValues	EnumOrSetValues property for columns that have either Enum or Ser as column data type. DATATYPE: String.
Font	Font 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.
ForBitData	ForBitData property for the column. DATATYPE: Boolean.
ForeignKey	Indicates whether the attribute is a foreign key. DATATYPE: Boolean.
Format	Teradata models only. Format property for the column. DATATYPE: String.
FreezeName	True if this attribute is not affected by naming standards name updates. DATATYPE: Boolean.
GenerateByDefault	GenerateByDefault property for the column. DATATYPE: Boolean.
GenerationExpression	DB2 UDB version 8 and later only. Specifies how to generate the column. DATATYPE: String.
GUID	GUID of the attribute as assigned by ER/Studio. Each attribute has a unique GUID. DATATYPE: String.
HasLogicalRoleName	Indicates whether the foreign key column has a logical rolename. DATATYPE: Boolean.
HasRoleName	Indicates whether the foreign key column is rolenamed. DATATYPE: Boolean.
Heading	DB2 AS/400 Heading for the column. DATATYPE: String.
Hidden	Indicating that an Attribute is hidden in the Diagram display. Only applies to PK and FK attributes/columns. DATATYPE: Boolean.
HiveColumnPartition	Specifies whether the column is a Hive Partitioning Column. DATATYPE: Boolean
HiveComplexType	Specifies the Hive column's Complex datatype. DATATYPE: String
ID	ID of the attribute as assigned by ER/Studio. Each attribute in a diagram has a unique ID. DATATYPE: Integer.
Identity	Identity property of the attribute. DATATYPE: Boolean.
IdentityIncrement	Identity increment value of the attribute. DATATYPE: Integer.
IdentitySeed	Identity seed value of the attribute. DATATYPE: Integer.
InterModelID	InterModelID of the object as assigned by ER/Studio. DATATYPE: Integer.
IntervalYearToMonth	IntervalYearToMonth property for the column. DATATYPE: Boolean.
IsCaseSpecific	Teradata V2R5 and later only. True if this column is case specific. It applies only to CHAR and VARCHAR data types. DATATYPE: Boolean.
IsComputed	Interbase 2007 and later and SQL server 7.x and later only. Returns true if the column is computed (if there is a value specified for the Computation property), false otherwise. DATATYPE: Boolean.
IsFileStream	SQL Server 2008 and later only. True if this column has FILESTREAM property set. It applies only to VARBINARY(MAX) data type. DATATYPE: Boolean.
IsGenerated	DB2 UDB 8 and later only. True if the column is generated with an expression. DATATYPE: Boolean.
IsSparse	True if this is a sparse column. DATATYPE: Boolean.
IsVirtual	True 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
IsWithTimeZone	True if this column has WITH TIME ZONE property set. It applies only to TIME and TIMESTAMP data types in Teradata all versions. DATATYPE: Boolean.
IsXMLDocument	Returns true if the column has datatype XML and is flagged as document. Applies only to SQL server 2005 and later versions. DATATYPE: Boolean.
LOBUnit	This is the unit to be used for the LOB size. The value can be empty, "K", "M" or "G". DATATYPE: String.
LocalTimeZone	This is the LocalTimeZone property for the column. DATATYPE: Boolean.
LogicalRoleName	This is the Logical Rolename. DATATYPE: String.
LogOrPhysOnly	Controls the logical/physical only Attribute Property. DATATYPE: Boolean.
MaxValue	This is the MaxValue property for the column. DATATYPE: Integer.
MinValue	This is the MinValue property for the column. DATATYPE: Integer.
MongoDBArray	This property indicates that the Column is a MongoDB array. DATATYPE: Boolean
NamingStandardsTemplateId	ID 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.
Notes	This is the Notes property of the attribute. DATATYPE: String.
NotForReplication	This property specifies if an identity column constraint is for replication. This applies only to MS SQL Server 2000 and later versions. DATATYPE: Boolean.
NotLogged	This is the NotLogged property for the column. DATATYPE: Boolean.
NullOption	This is the nullability of the attribute. The possible values are: 'NULL' or 'NOT NULL'. DATATYPE: String.
OracleNotNullConstraintName	This property specifies the Not Null constraint of the column. It only applies to Oracle 8 and later versions. DATATYPE: String
PercentNull	This is the percentage of nulls of a column in a table. This property applies only to physical models. DATATYPE: Integer.
Persisted	This property specifies if a computed column is persisted. It applies only to a computed column in SQL Server 2005 and later versions. DATATYPE: Boolean.
PhysicalDatatype	This is the physical datatype of the attribute. DATATYPE: String.
PrimaryKey	This indicates if the attribute is a primary key. DATATYPE: Boolean.
ReferenceValueId	ID 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.
RoleName	This is the role name of the attribute. DATATYPE: String.
RowGuidColumn	This is the RowGuidColumn property for the column. DATATYPE: Boolean.
RuleId	The 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.
SequenceNumber	This is the sequence number of the attribute. DATATYPE: Integer.
ShowLength	This tells whether the datatype length is used (true) or not (false). DATATYPE: Boolean.
ShowScale	This tells whether the datatype scale is used (true) or not (false). DATATYPE: Boolean.
ShowVirtualColumnDatatype	This 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.
SourceDirectTransformationDescription	This is the source direct transformation description property for the column. This property applies only to physical models. DATATYPE: String.
SourceDirectTransformationLogic	This is the source direct transformation logic property for the column. This property applies only to physical models. DATATYPE: String.
SourceSecondaryTransformationDescription	This is the source secondary transformation description property for the column. This property applies only to physical models. DATATYPE: String.
SourceSecondaryTransformationLogic	This is the source secondary transformation logic property for the column. This property applies only to physical models. DATATYPE: String.
SystemName	This is the DB2 AS/400 SystemName for the column. DATATYPE: String.
TargetDirectTransformationDescription	This is the target direct transformation description property for the column. This property applies only to physical models. DATATYPE: String.
TargetDirectTransformationLogic	This is the target direct transformation logic property for the column. This property applies only to physical models. DATATYPE: String.
TargetSecondaryTransformationDescription	This is the target secondary transformation description property for the column. This property applies only to physical models. DATATYPE: String.
TargetSecondaryTransformationLogic	This is the target secondary transformation logic property for the column. This property applies only to physical models. DATATYPE: String.
TeradataCollectStatistics	This property specifies whether the collect statistics option of the column is on for Teradata (V12 or higher). DATATYPE: Boolean.
TeradataIntervalStr	This property specifies the interval string for a column with INTERVAL datatype, It only applies to Teradata 13 and later versions.. DATATYPE: String.
TeradataPeriod	This 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
TeradataUsingSample	This 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.
TextLabel	This is the DB2 AS/400 TextLabel for the column. DATATYPE: String.
TimeZone	This is the TimeZone property for the column. DATATYPE: Boolean.
Title	This is the Title property for the column. This property is only used in Teradata models. DATATYPE: String.
Unsigned	This property specifies if the column data type is unsigned. It applies only to MySQL platforms. DATATYPE: Boolean.
UserDatatypeId	The 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.
VirtualColumnExpression	This property holds the expression used to compute an Oracle (11g or higher) virtual column. DATATYPE: String
XMLCollection	This represents the column's Collection property, which applies to Columns with datatype XML. Applies only to SQL server 2005 and later versions. DATATYPE: String.

Content

Space Tools

Public Methods

Public Properties

See Also