• PRODUCTS
  • SUPPORT
  • DOCS
  • PARTNERS
  • COMPANY
  • QUOTE
  • ACCOUNT
  • STORE
QUOTE

Documentation

Support Forums
What can we help you with?
Topics

Class AstFuzzyLookupNode

The Fuzzy Lookup transformation looks up values in a reference data set by using fuzzy matching. That is, matches can be close rather than exact.

Namespace:
Varigence.Languages.Biml.Transformation
Assembly:
Biml.dll
C#
    public class AstFuzzyLookupNode : AstSingleInTransformationNode, IBindableItem, IGetJsonProvider, INamedNode, IScopeBoundary, IReferenceableItem, IFrameworkItem, IValidationInfo, INamedItem, IDataflowItem
    
  
Inheritance
System.Object
AstNode
AstNamedNode
AstScopeBoundaryNode
AstTransformationNode
AstSingleInTransformationNode
AstFuzzyLookupNode
Implements

Varigence.Utility.Collections.IVulcanCollectionParent, Varigence.Utility.ComponentModel.IVulcanNotifyPropertyChanged, Varigence.Utility.ComponentModel.IPropertyChangeNotificationTarget, System.ComponentModel.INotifyPropertyChanged, Varigence.Utility.Xml.IXObjectMappingProvider, System.ComponentModel.IDataErrorInfo, Varigence.Utility.Collections.IScopedNameIndexable,

Constructors

AstFuzzyLookupNode(IFrameworkItem)

Initializes a new instance of the AstFuzzyLookupNode class with the specified parent node.

Fields

ScopedNamePrefixBackingStore
IsScopeImported

Properties

AutoPassThroughInputColumns

Specifies whether or not input columns to the Fuzzy Lookup node that lack an input mapping should be automatically set to passthrough.

AutoPassThroughInputColumnsDefaultValue

Gets the default value for the AutoPassThroughInputColumns property

Connection

This values specifies the OLE DB connection and database in which the fuzzy lookup reference table is located and where the fuzzy match index table is stored and accessed.

CopyReferenceTable

This value specifies whether a copy of the table specified in the ReferenceTable should be made for the fuzzy lookup.

CopyReferenceTableDefaultValue

Gets the default value for the CopyReferenceTable property

Delimiters

This value specifies which set of white-space and punctuation characters is used to separate fuzzy match fields into the words used for matching and scoring a fuzzy lookup.

DelimitersDefaultValue

Gets the default value for the Delimiters property

DropExistingIndex

This value specifies whether any existing indexes having the name specified in the MatchIndexName property should removed. The default is True.

DropExistingIndexDefaultValue

Gets the default value for the DropExistingIndex property

Exhaustive

This value specifies whether each input record is directly compared against every record in the reference table. This option is primarily intended for debugging purposes and should be used with care. This method is extremely slow unless the number of records in the reference table is very small. Note also that the entire reference table is loaded into main memory if this option is enabled.

ExhaustiveDefaultValue

Gets the default value for the Exhaustive property

FriendlyTypeNameStatic

Gets the friendly name of the type of this node

Inputs

This is a collection of input column mapping definitions that determine the behavior of specific columns and their comparisons.

MatchIndexName

This value specifies the name of the fuzzy-match index table to be reused or the table name in which a newly generated fuzzy-match index table will be written.

MatchIndexNameDefaultValue

Gets the default value for the MatchIndexName property

MatchIndexOptions

This value indicates whether an existing fuzzy-match index table is reused or a new one is built. The new index table can be temporary, persisted, or persisted and maintained.

MatchIndexOptionsDefaultValue

Gets the default value for the MatchIndexOptions property

MaxMemoryUsage

This value specifies the maximum amount of memory (MB) that the current instance of the Fuzzy Lookup transformation can use. If 0 is given, then the transform dynamically adjusts memory usage based upon its requirements and available system memory.

MaxMemoryUsageDefaultValue

Gets the default value for the MaxMemoryUsage property

MaxOutputMatches

This value specifies which set of white-space and punctuation characters is used to separate fuzzy match fields into the words used for matching and scoring a fuzzy lookup.

MaxOutputMatchesDefaultValue

Gets the default value for the MaxOutputMatches property

MinSimilarity

This value specifies the minimum similarity score that is required in order for the transformation to return a match.

MinSimilarityDefaultValue

Gets the default value for the MinSimilarity property

OutputPath

Gets the output path for this transformation. This is the preferred output path and will automatically connect to any single-input transformation nodes that directly follow it in the Biml file.

Outputs

This is the collection of lookup output column mapping definitions.

ReferenceTable

This value specifies the name of the table or view against which incoming records are matched.

WarmCaches

This value specifies whether the error-tolerant index and the reference table are partially loaded into main memory before the Fuzzy Lookup transformation begins. This can greatly enhance performance if many input rows are to be processed.

WarmCachesDefaultValue

Gets the default value for the WarmCaches property

InputPath

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.

VisibleVariables

Gets a collection of all variable nodes that are available to be used by this transformation. It includes variables defined by this transformation and any tasks/packages that contain this transformation

PreferredOutputPath

Gets the preferred output path for the transformation. This output path will support automatic connections to single-input transformations that directly follow in the Biml code

DataflowInputs

Gets a collection of all dataflow input paths for this transformation

DataflowOutputs

Gets a collection of all dataflow output paths for this transformation

ValidateExternalMetadata

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.

LocaleId

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

ErrorHandling

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.

DataflowOverrides

Provides a collection of objects to override properties of the component, its input paths, its output paths, and its consituent dataflow columns.

ValidateExternalMetadataDefaultValue

Gets the default value for the ValidateExternalMetadata property

LocaleIdDefaultValue

Gets the default value for the LocaleId property

ScopedName

Gets the scoped name which can be used to uniquely identify this object among other objects of its type

SymbolTable

Gets a reference to the symbol table that stores a reference to this and all other named objects in the project

SsisSafeScopedName

Returns a version of the ScopedName that has been cleaned of invalid characters for SSIS.

SsisSafeName

Returns a version of the Name that has been cleaned of invalid characters for SSIS.

Name

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

References

Gets collection of FrameworkItemReference objects, which track rich information about the properties that hold references to this node.

NameDefaultValue

Gets the default value for the Name property

Guid
Annotations

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.

ObjectTag

This property provides a general purpose storage mechanism for .NET objects to be associated with AstNode objects. It supplements the annotation system, which is intended for use with string-based metadata.

BimlFile

This value specifies the BimlFile in which the Biml code that defines AstNode resides.

ItemLabel

Gets a label that can be used to identify this node

ParentItem

This value specifies the parent of the current node. All nodes must have a valid parent in the Biml framework, except for the root node.

Methods

BindingScopeBoundaries()

Retrieves the permitted scope boundaries to bind references from this node.

DefinedAstNodes()

Retrieves a collection of nodes that have been defined as direct children of the current node.

Duplicate()

Creates a duplicate of the current node

Duplicate(IFrameworkItem)

Creates a duplicate of the current node with the specified parent item

GetAllItemsReferencedByDefinedSuccessors()

Builds a list of all items referenced by this node and its successors. Each tuple in the returned list represents a FrameworkItemReference. The first item is the ReferencingItem, the second item is the property name, and the third item is the ReferencedItem.

GetDefaultValue(String)

Retrieves the default value for the property with the name propertyName

GetDefaultValue<T>(String)

Retrieves the default value for the property with the name propertyName

StructureEquals(Object)

Compares this node to the provided object to determine if all defined children and references are equal.

CurrentSourceOutputPath()

Retrieves the output path to which the input path of this transformation is currently connected.
This method takes into account both explicit and implicit connections.

GetOfflineSchemaItemResource()
RegisterNewOutput(String)

Provides a convenience method for creating a new output path for the transformation, including both static and dynamic paths

RegisterNewOutput(String, Boolean)

Provides a convenience method for creating a new output path for the transformation, including both static and dynamic paths

DeregisterOutput(AstDataflowOutputPathNode)

Provides a convenience method for removing existing output paths from the transformation, including both static and dynamic paths

GetSchemaLocalName()

Retrieves the local XML element name that corresponds to this node in Biml code.

ToString()

Returns a string that represents the current object. In this case, it is the Name of the node.

OnScopedNameChanged(String, String)
OnItemLabelChanged(String, String)
OnNameChanging(String, String)
OnNameChanged(String, String)
AddScopedNameChangedEventListener(IReferenceableItem, EventHandler<VulcanPropertyChangedEventArgs>)

Adds the scoped name changed event handler to the specified referenceable item.

RemoveScopedNameChangedEventListener(IReferenceableItem, EventHandler<VulcanPropertyChangedEventArgs>)

Removes the scoped name changed event handler from the specified referenceable item.

FirstChildOfType<TChild>()

Gets the first defined descendant node of the specified type

RemoveFromParent()

Removes this node definition from its parent

GetJson()

Generates a JavaScript Object Notation (JSON) representation of the current node

GetExternalJson()

Generates a JavaScript Object Notation (JSON) representation of the current node

GetJson(Boolean, Boolean, Boolean, Boolean, Boolean)

Generates a JavaScript Object Notation (JSON) representation of the current node

GetXObjectName()

Gets the fully qualified XML element name for this node in the code document.

FirstParent<TAstNode>()

Retrieves the first parent or ancestor node of the specified type

FirstParent<TAstNode>(Type)

Retrieves the first parent or ancestor node of the specified type with the specified custom attribute type

FirstThisOrParent<TAstNode>()

Retrieves the first parent or ancestor node of the specified type, including this node

IsDirectAncestor(IFrameworkItem)

Retrieves a value indicating whether the specified node is a direct ancestor of this node.

AncestorDistance(IFrameworkItem)

Retrieves the number of steps between this node and the nearest shared ancestor with the specified relative node.

FirstThisOrParent<TAstNode>(Type)

Retrieves the first parent or ancestor node (including this node) of the specified type with the specified custom attribute type

AllDefinedSuccessors()

Retrieves the collection of all nodes defined as a child of this or any successor node or the current node

AllDefinedSuccessors(Boolean)

Retrieves the collection of all nodes defined as a child of this or any successor node or optionally the current node

OnNotificationTargetPropertyChanged(String)
OnScopeBoundaryChanged(IScopeBoundary, IScopeBoundary)
AddParseableChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>)
RemoveParseableChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>)
AddScopeBoundaryChangedEventListener(IFrameworkItem, EventHandler<VulcanPropertyChangedEventArgs>)
RemoveScopeBoundaryChangedEventListener(IFrameworkItem, EventHandler<VulcanPropertyChangedEventArgs>)
AddParsePendingChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>)
RemoveParsePendingChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>)
AddFromTemplateChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>)
RemoveFromTemplateChangedEventListener(IFlowFileChanged, EventHandler<EventArgs>)
ParseSelf(XElement, ParserContext)
ParseNameValueMapping(XElement)

© Varigence