Class AstOdbcDestinationNode
The ODBC Destination loads data into an ODBC-compliant database that uses a database table, a view, or an SQL command.
Namespace: Varigence.Languages.Biml.Transformation.Destination
Assembly: Biml.dll
C#
public class AstOdbcDestinationNode : AstDestinationTransformationNode, IBindableItem, IGetJsonProvider, INamedNode, IScopeBoundary, IReferenceableItem, IFrameworkItem, IValidationInfo, INamedItem, IDataflowItem
Inheritance AstNode
-
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
| Constructors | Description |
|---|---|
| AstOdbcDestinationNode(IFrameworkItem) | Initializes a new instance of the AstOdbcDestinationNode class with the specified parent node. |
Fields
| Fields | Description |
|---|---|
| ScopedNamePrefixBackingStore | |
| IsScopeImported |
Properties
| Properties | Description |
|---|---|
| BatchSize | This value specifies how many rows can be loaded into the destination table in each batch before additional rows are requested from the data flow pipeline. The default value is 1000. |
| BatchSizeDefaultValue | Gets the default value for the BatchSize property |
| BindCharColumnAs | This value specifies how multibyte string types (SQL_CHAR, SQL_VARCHAR, SQL_LONGVARCHAR, etc.) should be mapped by the component. Either Unicode (SQL_C_WCHAR) or ANSI (SQL_C_CHAR) can be selected. The default value is Unicode. |
| BindCharColumnAsDefaultValue | Gets the default value for the BindCharColumnAs property |
| BindNumericAs | This value specifies how numerci data should be mapped by the component. Either Char or Numeric can be selected. The default value is Char. |
| BindNumericAsDefaultValue | Gets the default value for the BindNumericAs property |
| Columns | This value specifies how the component should map columns in the data flow to columns in the destination. Columns that are not explicitly listed in this collection are automatically mapped based on name. |
| Connection | This value specifies the ODBC connection to use when loading the data. |
| DefaultCodePage | This value specifies which code page to use when the data source does not provide code page information. |
| DefaultCodePageDefaultValue | Gets the default value for the DefaultCodePage property |
| Destination | This value specifies the location to which the data is written. |
| ErrorOutput | Gets the error output path for this transformation |
| FriendlyTypeNameStatic | Gets the friendly name of the type of this node |
| LobChunkSize | This value specifies the chunk size that should be allocated of Large Object (LOB) columns. |
| LobChunkSizeDefaultValue | Gets the default value for the LobChunkSize property |
| Timeout | The number of seconds before the command times out. Zero indicates an infinite time-out. The default value is 0. |
| TimeoutDefaultValue | Gets the default value for the Timeout property |
| TransactionSize | This value specifies how many rows can be added in a single transaction before a new transaction must created on the ODBC target. Zero indicates that all rows should be loaded in the same transaction. The default value is 0. |
| TransactionSizeDefaultValue | Gets the default value for the TransactionSize property |
| UseBatch | This value specifies whether Batch load should be used instead of the default Row-By-Row load mechanism. |
| UseBatchDefaultValue | Gets the default value for the UseBatch 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
| Methods | Description |
|---|---|
| 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 |
| GetOfflineSchemaItemResource() | |
| 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. |
| 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) |