Multiple Column Table Reference Element
X-Ref:
- Ast Multiple Column Table Reference Node
- Ast Table Column Table Reference Base Node
- Ast Table Column Base Node
- Ast Securable Node
- Ast Scope Boundary Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| ForeignColumnName | AstTableColumnBaseNode | This value is a reference to the column on the foreign table that will be connected to the local column in this table. There should be additional multiple column table reference columns that point to other columns in the same table to complete the reference. This is a required reference to an existing definiton. | |
| MultipleColumnTableReferenceGroupName | String | All multiple column table reference columns that point to foreign columns in the same foreign key must have the same MultipleColumnTableReferenceGroupName. This is a required property | |
| Name | String | Specifies the name of the object. This name can be used to reference this object from anywhere else in the program. This is a required property | |
| CodePage | Int32 | 0 | This value specifies the integer index for the codepage of the dataflow column. This property applies only to dataflow column types that support code pages, such as strings. Codepages supported by Windows are listed at: http://msdn.microsoft.com/en-us/goglobal/bb964654.aspx. |
| Computed | String | 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 | |
| CustomType | String | 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 | |
| DataType | DbType | Int32 | 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. |
| Default | String | This value specifies a default value for the column using Transact-SQL constant expression syntax. | |
| DefaultConstraintName | String | This value specifies the name that should be used for the default value constraint for this column in the database. If the Default property has not been specified, the value of this property will be ignored. | |
| ForeignKeyConstraintMode | ForeignKeyConstraintMode | CreateAndCheck | This value determines whether a foreign key constraint will be created for this table reference column and whether the created constraint is enforced by the database. |
| ForeignKeyNameOverride | String | When the ForeignKeyConstraintMode property is properly set, the Biml compiler 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. | |
| FriendlyName | String | Provides a convenience property for storing an alternative name for this column. | |
| IdentityIncrement | Int32 | 0 | 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. |
| IdentitySeed | Int32 | 1 | 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. |
| IsNullable | Boolean | False | This value specifies whether null values are accepted for the column. |
| Length | Int32 | 0 | (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. |
| Precision | Int32 | -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. |
| ReadOnly | Boolean | False | 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. |
| Scale | Int32 | -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. |
| ScdType | ScdType | Update | 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. |
Singleton Children
| Child | API Type | Description |
|---|---|---|
| <CheckConstraint /> | AstCheckConstraintNode | Defines a Check constraint, which can be used to enforce that data in a table or column meets specific criteria. |
Collection Children
| Child | API Type | Description |
|---|---|---|
| <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. |