Versions Compared

Key

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

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. 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.
GUIDGUID of the attribute as assigned by ER/Studio. Each attribute has a unique GUID. DATATYPE: String.
HasLogicalRoleNameIndicates whether the foreign key column has a logical rolename. DATATYPE: Boolean.
HasRoleNameIndicates whether the foreign key column is rolenamed. DATATYPE: Boolean.
HeadingDB2 AS/400 Heading for the column. DATATYPE: String.
HiddenIndicating that an Attribute is hidden in the Diagram display. Only applies to PK and FK attributes/columns. DATATYPE: Boolean.
HiveColumnPartitionSpecifies whether the column is a Hive Partitioning Column. DATATYPE: Boolean
HiveComplexTypeSpecifies the Hive column's Complex datatype. DATATYPE: String
IDID of the attribute as assigned by ER/Studio. Each attribute in a diagram has a unique ID. DATATYPE: Integer.
IdentityIdentity property of the attribute. DATATYPE: Boolean.
IdentityIncrementIdentity increment value of the attribute. DATATYPE: Integer.
IdentitySeedIdentity seed value of the attribute. DATATYPE: Integer.
InterModelIDInterModelID of the object as assigned by ER/Studio. DATATYPE: Integer.
IntervalYearToMonthIntervalYearToMonth property for the column. DATATYPE: Boolean.
IsCaseSpecificTeradata V2R5 and later only. True if this column is case specific. It applies only to CHAR and VARCHAR data types. DATATYPE: Boolean.
IsComputedInterbase 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.
IsFileStreamSQL Server 2008 and later only. True if this column has FILESTREAM property set. It applies only to VARBINARY(MAX) data type. DATATYPE: Boolean.
IsGeneratedDB2 UDB 8 and later only. True if the column is generated with an expression. 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.
IsXMLDocumentSQL server 2005 and later only. Returns true if the column has datatype XML and is flagged as document. DATATYPE: Boolean.
LOBUnitUnit used for the LOB size. The value can be empty, "K", "M", or "G". DATATYPE: String.
LocalTimeZoneLocalTimeZone property for the column. DATATYPE: Boolean.
LogicalRoleNameLogical Rolename. DATATYPE: String.
LogOrPhysOnlyControls the logical/physical only Attribute Property. DATATYPE: Boolean.
MaxValueMaxValue property for the column. DATATYPE: Integer.
MinValueMinValue property for the column. DATATYPE: Integer.
MongoDBArrayIndicates whether 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.
NotesNotes property of the attribute. DATATYPE: String.
NotForReplicationSQL Server 2000 and later only. Specifies whether an identity column constraint is for replication. DATATYPE: Boolean.
NotLoggedNotLogged property for the column. DATATYPE: Boolean.
NullOptionNullability of the attribute. The possible values are: 'NULL' or 'NOT NULL'. DATATYPE: String.
OracleNotNullConstraintNameOracle 8 and later only. Specifies the Not Null constraint of the column. DATATYPE: String
PercentNullPercentage of nulls of a column in a table. This property applies only to physical models. DATATYPE: Integer.
PersistedSQL Server 2005 and later only. Specifies whether a computed column is persisted. DATATYPE: Boolean.
PhysicalDatatypePhysical datatype of the attribute. DATATYPE: String.
PrimaryKeyIndicates whether 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.
RoleNameRole name of the attribute. DATATYPE: String.
RowGuidColumnRowGuidColumn property for the column. DATATYPE: Boolean.
RuleIdID of the bounded rule object, if any. A user can bind a rule object to the attribute by assigning a particular rule ID to this property. DATATYPE: Integer.
SequenceNumberSequence number of the attribute. DATATYPE: Integer.
ShowLengthIndicates whether the datatype length is used (true) or not (false). DATATYPE: Boolean.
ShowScaleIndicates whether the datatype scale is used (true) or not (false). DATATYPE: Boolean.
ShowVirtualColumnDatatypeOracle 11g and later only. Specifies whether the data type of an Oracle virtual column is manually set (true) or automatically determined by the database (false). DATATYPE: Boolean.
SourceDirectTransformationDescriptionSource direct transformation description property for the column. This property applies only to physical models. DATATYPE: String.
SourceDirectTransformationLogicSource direct transformation logic property for the column. This property applies only to physical models. DATATYPE: String.
SourceSecondaryTransformationDescriptionSource secondary transformation description property for the column. This property applies only to physical models. DATATYPE: String.
SourceSecondaryTransformationLogicSource secondary transformation logic property for the column. This property applies only to physical models. DATATYPE: String.
SystemNameDB2 AS/400 SystemName for the column. DATATYPE: String.
TargetDirectTransformationDescriptionTarget direct transformation description property for the column. This property applies only to physical models. DATATYPE: String.
TargetDirectTransformationLogicTarget direct transformation logic property for the column. This property applies only to physical models. DATATYPE: String.
TargetSecondaryTransformationDescriptionTarget secondary transformation description property for the column. This property applies only to physical models. DATATYPE: String.
TargetSecondaryTransformationLogicTarget secondary transformation logic property for the column. This property applies only to physical models. DATATYPE: String.
TeradataCollectStatisticsTeradata V12 and later only. Specifies whether the collect statistics option of the column is on. DATATYPE: Boolean.
TeradataIntervalStrTeradata V13 and later only. Specifies the interval string for a column with INTERVAL datatype. DATATYPE: String.
TeradataPeriodTeradata V13 and later only. Specifies whether the column has PERIOD datatype. It only applies to columns that have datatype as TIME, TIMESTAMP and DATE. DATATYPE: Boolean
TeradataUsingSampleTeradata V12 and later only. Specifies whether the using sample option of the column is on. The collect statistics option must be on before this option can be set. DATATYPE: Boolean.
TextLabelDB2 AS/400 TextLabel for the column. DATATYPE: String.
TimeZoneTimeZone property for the column. DATATYPE: Boolean.
TitleTeradata models only. Title property for the column. DATATYPE: String.
UnsignedMySQL only. Specifies whether the column data type is unsigned. DATATYPE: Boolean.
UserDatatypeIdID of the bounded user datatype object, if any. A user can bind a user datatype object to the attribute by assigning a particular user datatype ID to this property. DATATYPE: Integer.
VirtualColumnExpressionOracle 11g and later only. Holds the expression used to compute a virtual column. DATATYPE: String
XMLCollectionSQL Server 2005 and later only. Column's Collection property, which applies to Columns with datatype XML. DATATYPE: String.
Info
titleSee Also