Biml Language Reference
Lookup Element
The Lookup transformation combines data in input columns with data in columns in a reference data set. It is the data flow equivalent of a SQL join.
Attributes
  Attribute API Type Default Description
CacheMode CacheMode
This value specifies whether caching is activated for rows that have no matching entries in the reference data source.

[.NET API Property: CacheMode]

CacheSize32 Int32
This value specifies the cache size in megabytes for 32-bit computers. The default value is 25 megabytes.

[.NET API Property: CacheSize32]

CacheSize64 Int32
This value specifies the cache size in megabytes for 64-bit computers. The default value is 25 megabytes.

[.NET API Property: CacheSize64]

DefaultCodePage Int32
This value specifies which default code page to use when the data source does not specify a default code page.

[.NET API Property: DefaultCodePage]

LocaleId Language
This value specifies which locale is used by the dataflow task.

[.NET API Property: LocaleId]

Name String
Specifies the name of the object. This name can be used to reference this object from anywhere else in the program.

[.NET API Property: Name]

NoMatchBehavior LookupNoMatchBehavior
This value determines how the lookup component should behave when rows do not have matching entries in the reference data source. The default is to fail the component.

[.NET API Property: NoMatchBehavior]

NoMatchCachePercentage Int32
This value specifies what percentage of the cache is designated for rows that have no matching entries in the reference data source.

[.NET API Property: NoMatchCachePercentage]

OleDbConnectionName AstConnectionBaseNode
This value specifies the name of the connection from which the lookup data set is loaded.

[.NET API Property: Connection]

TreatDuplicateKeysAsError Boolean
Determines whether duplicate keys in the reference data should be treated as errors when full cache mode is used.

[.NET API Property: TreatDuplicateKeysAsError]

ValidateExternalMetadata Boolean
This value specifies whether the data flow transformation is validated against columns that originated in external data sources. When server assets such as tables and stored procedures are created during processing, ValidateExternalMetadata is normally set to False, which prevents validation from completing at compile time.

[.NET API Property: ValidateExternalMetadata]

Singleton Children
  Child API Type Description
<DirectInput /> AstDirectResourceNode
This is the query that will be used to obtain a data set from the Connection. The Lookup transformation will use this data set to map input and output columns.

[.NET API Property: Query]

<TableInput /> AstTableResourceNode
<ExternalTableInput /> AstUnmanagedTableResourceNode
<ErrorHandling /> AstComponentErrorHandlingNode
This value specifies how errors are handled by default in columns processed by the component. This can be overriden at the component or column level for specific cases.

[.NET API Property: ErrorHandling]

<InputPath /> AstDataflowInputPathNode
This specifies the input path that will be used by this dataflow component. If an input path is not specified, the dataflow component will attempt to automatically discover an appropriate input path based on the surrounding dataflow.

[.NET API Property: InputPath]

<ParameterizedQuery /> AstDirectResourceNode
This value specifies the parameterized query for the Lookup transformation.

[.NET API Property: ParameterizedQuery]

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.

[.NET API Property: Annotations]

<Outputs>
    <Column />
</Outputs>
AstLookupOutputColumnMappingNode
This is the collection of lookup output column mapping definitions.

[.NET API Property: Outputs]

<Inputs>
    <Column />
</Inputs>
AstDataflowColumnMappingNode
This is the collection of lookup input column mapping definitions.

[.NET API Property: Inputs]

<DataflowOverrides>
    Multiple Choices...
</DataflowOverrides>
AstDataflowOverrideNode
Provides a collection of objects to override properties of the component, its input paths, its output paths, and its consituent dataflow columns.

[.NET API Property: DataflowOverrides]

<Parameters>
    <Parameter />
</Parameters>
AstDataflowColumnMappingNode
This is a collection of mappings from variables to parameters specified in the Query property.

[.NET API Property: Parameters]