Varigence, Inc.

Expand Minimize
BIML Language Reference
TableReferenceColumn Element
Table reference columns are used to create a local column with a relationship to a key column of a table, dimension, or fact table. Table reference columns can be used only with single column foreign keys, and the column properties will be directly inferred from the key of the foreign table. Use the multiple column table reference for keys with multiple columns.
Attributes
 AttributeAPI TypeDefaultDescription
NameString 
Specifies the name of the object. This name can be used to reference this object from anywhere else in the program.
TableNameAstTableNode 
This value specifies the name of a table to reference. This creates a column that matches the type of the primary key of the referenced table and also creates a foreign key constraint on the referenced table, unless the foreign key feature is disabled.
ComputedString 
This value specifies a computed value for the column using Transact-SQL expression syntax. Computed column specifications conform to all SQL Server computed column rules as described at http://msdn.microsoft.com/en-us/library/ms191250.aspx
CustomTypeString 
This value specifies the type of a column when the main column type has been set to Custom. This permits the specification of less commonly used SQL Server column types. A complete list of allowed types is available at http://msdn.microsoft.com/en-us/library/ms127023%28SQL.90%29.aspx
DataTypeDbTypeInt32
This value specifies the type of the data stored in this column using the unified type system. The type values include all of those types commonly used in Microsoft SQL Server table definitions.
DefaultString 
This value specifies a default value for the column using Transact-SQL constant expression syntax.
ForeignKeyConstraintModeForeignKeyConstraintModeCreateAndCheck
This value determines whether a foreign key constraint will be created for this table reference column. If the value is False, the relationship between the tables will be tracked to support relationship modeling within the internal model, but no foreign key will be created. If the value is True, a foreign key will be created in addition to the other tracking behaviors. The default value is True.
ForeignKeyNameOverrideString 
Hadron automatically creates a foreign key constraint name based on the names of the relevant tables and columns. To override the automatically generated foreign key constraint name, supply the value in this property.
IdentityIncrementInt320
Set IdentityIncrement to a non-zero value to enable this column as an IDENTITY. This value specifies the amount by which the Identity value is incremented when a row is inserted. Removing this property or setting the value to 0 will remove the IDENTITY specification for this column.
IdentitySeedInt321
This value specifies the starting value for an identity column. When the first row is inserted into the table, this value is used. Both seed and increment must be specified if either is explicitly specified. The default value is 1.
IsNullableBooleanFalse
This value specifies whether null values are accepted for the column.
LengthInt320
(Set to -1 to indicate MAX length) This value specifies the length parameter for the column type associated with this column. This property applies only to column types that support a length specification, such as String and Binary types.
PrecisionInt32-1
This value specifies the precision parameter for the column type associated with this column. Precision is the number of digits stored for a numeric value. This property applies only to column types that support precision, such as Decimal.
ReadOnlyBooleanFalse
Advanced Feature: Use at your own risk. Specifies that the column should be treated as a read-only column. This will automatically remove the column from assignment from Merge statements and other auto-generated code paths. Computed columns and rowversion columns are two examples of data types which are read-only.
ScaleInt32-1
This value specifies the scale parameter for the column type associated with this column. Scale is the number of digits to the right of the decimal point in a numeric value. This property applies only to column types that support precision, such as Decimal.
ScdTypeScdTypeUpdate
This value specifies the slowly changing dimension type for the column. The value determines the behavior of the table when a row with a matching unique key value is added to the table. This behavior is enforced in the various Task and Dataflow transformations that interact with this table.
Collection Children
 ChildAPI TypeDescription
<Annotations>
    <Annotation />
</Annotations>
AstAnnotationNode
This is a collection of annotation items that can be used to specify documentation, tags, or other information. Annotations are particularly useful for storing information about nodes that can be used by BimlScript code.