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

Documentation

Support Forums
What can we help you with?
Topics

Class AstBulkInsertTaskNode

The Bulk Insert task is an efficient method of copying large amounts of data into a SQL Server table.

Namespace:
Varigence.Languages.Biml.Task
Assembly:
Biml.dll
C#
    public class AstBulkInsertTaskNode : AstTaskBaseNode, IBindableItem, IGetJsonProvider, INamedNode, IScopeBoundary, IReferenceableItem, IFrameworkItem, IValidationInfo, INamedItem, IDataflowItem
    
  
Inheritance
System.Object
AstNode
AstNamedNode
AstScopeBoundaryNode
AstTaskNode
AstTaskBaseNode
AstBulkInsertTaskNode
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

AstBulkInsertTaskNode(IFrameworkItem)

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

Fields

ScopedNamePrefixBackingStore
IsScopeImported

Properties

BatchSize

This value specifies whether all of the data is copied in a single transaction or in a series of smaller batches.

BatchSizeDefaultValue

Gets the default value for the BatchSize property

CheckConstraints

This value specifies whether constraint checking is enforced or ignored during bulk import of data.

CheckConstraintsDefaultValue

Gets the default value for the CheckConstraints property

CodePage

This value specifies the code page of the data file if the data in the file contains relevant text or character data.

CodePageDefaultValue

Gets the default value for the CodePage property

Connection

This value specifies a direct reference to the OLE DB connection that will be used to bulk insert the data.

DataFileType

This value specifies which data-file type the Bulk Insert task uses when importing the data.

DataFileTypeDefaultValue

Gets the default value for the DataFileType property

Destination

This value specifies the destination table for the bulk insert.

FieldTerminator

This value specifies which field terminator is used in char and widechar data files. The default is tab (\t).

FieldTerminatorDefaultValue

Gets the default value for the FieldTerminator property

FireTriggers

This value specifies whether insert triggers are executed on the table during the operation. The default is False. Set the value to True to fire the triggers.

FireTriggersDefaultValue

Gets the default value for the FireTriggers property

FirstRow

This value specifies the first row from which to start copying. The default value is 1 (i.e. the first row in the data file is the first row copied.)

FirstRowDefaultValue

Gets the default value for the FirstRow property

FormatFile

This value specifies the full path of a format file. A format file is needed when the columns in the data file differ from the columns in the table or view.

FriendlyTypeNameStatic

Gets the friendly name of the type of this node

KeepIdentity

This value specifies whether the identity value or values specified in the source data are applied to the identity column in the destination table or view or ignored. The default value is True, meaning that the source identity values are used.

KeepIdentityDefaultValue

Gets the default value for the KeepIdentity property

KeepNulls

This value specifies whether empty columns retain a null value or receive specifed default values during the bulk load operation.

KeepNullsDefaultValue

Gets the default value for the KeepNulls property

LastRow

This value specifies which row is the last to be copied.

LastRowDefaultValue

Gets the default value for the LastRow property

MaximumErrors

This value specifies the maximum number of errors allowed before the bulk insert operation is halted. A value of 0 means that there is no limit on the number of errors allowed.

MaximumErrorsDefaultValue

Gets the default value for the MaximumErrors property

RowTerminator

This value which row terminator is used in char and widechar data files. The default is newline (\n).

RowTerminatorDefaultValue

Gets the default value for the RowTerminator property

SortedData

This value specifies whether the data is sorted using an orber by clause in the bulk insert statement. The default value is False, meaning that the data is not sorted by an order by clause.

SortedDataDefaultValue

Gets the default value for the SortedData property

Source

This value specifies the source file for the bulk insert.

TableLock

This value specifies whether the destination table is locked during the bulk insert operation. Set the value to True to lock the table.

TableLockDefaultValue

Gets the default value for the TableLock property

ExecutionValueVariable

Specifies a variable to hold the execution results of this component.

VisibleVariables

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

VisiblePackageParameters

Gets a collection of all package parameter nodes that are available to be used by this task.

VisibleProjectParameters

Gets a collection of all project parameter nodes that are available to be used by this task. This include all parameters defined by all package projects that contain the parent package for this task.

OutputPath

Gets a default OutputPath that all subsequent nodes will connect to, if they choose to create a precendence constraint

SystemVariables

Gets a collection of all variables defined in this task that have been provided by SSIS as system variables

PrecedenceConstraints

This is a container for task precedence constraint definitions.

Events

This is a collection of event handlers that can respond to SQL Server Integration Services events that are raised on this task.

DelayValidation

This value specifies whether the validation of the Dataflow task in SSIS should be delayed until the package is executed. DelayValidation is most often used when the ETL process references tables and other server assets that were created in an earlier stage of the data processing run.

IsolationLevel

Sets the Isolation Level which controls how Transactions behave for this container.

ForcedExecutionValue

If the ForceExecutionValue property is set to True, then the container will return the value stored in this property as its execution value. Otherwise, this value will be ignored. The default value for ForecedExecutionValue is 0.

ForceExecutionResult

This value indicates whether a specified execution result value will result if the container runs. The default value is None, which means that the container does not force a specified outcome.

ForceExecutionValue

Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain the value specified in the ForcedExecutionValue property.

ForcedExecutionValueDataType

This property specifies the data type of the value stored in the ForceExecutionValue property.

Disabled

This value specifies whether the item is disabled. The default value is False.

FailPackageOnFailure

This value determines whether the container will fail when a container component fails. If this container corresponds to a package, then the only valid value is False.

FailParentOnFailure

This value determines whether the parent container will fail when a child container failes. The default value is False.

MaximumErrorCount

This value specifies the maximum number of errors allowed to occur before a package is forced to stop running. The default value is 1.

Language

This specifies the default language to be used by this task and its descendants.

DisableEventHandlers

This value specifies whether the event handlers for this task, container, or package should be prevented from executing. The default value is False.

TransactionMode

This value specifies the transaction context in which this task will execute.

Variables

This is a container for variable definitions that are specific to this task, container, or package.

LoggingMode

This value specifies whether logging is enabled or disabled by the container or by the parent container. The default value is UseParentSetting.

LogEvents

This is a container for log event definitions that are specific to this task, container, or package.

LogProviders

Defines the log providers to use for the SSIS task or container

Expressions

This is a collection of SSIS expression definitions for property value overrides that are specific to this task, container, or package.

Id

Allows the developer to specify a unique identifier (GUID) for the package. This can be used to retain a consistent ID between builds.

DelayValidationDefaultValue

Gets the default value for the DelayValidation property

IsolationLevelDefaultValue

Gets the default value for the IsolationLevel property

ForcedExecutionValueDefaultValue

Gets the default value for the ForcedExecutionValue property

ForceExecutionResultDefaultValue

Gets the default value for the ForceExecutionResult property

ForceExecutionValueDefaultValue

Gets the default value for the ForceExecutionValue property

DisabledDefaultValue

Gets the default value for the Disabled property

FailPackageOnFailureDefaultValue

Gets the default value for the FailPackageOnFailure property

FailParentOnFailureDefaultValue

Gets the default value for the FailParentOnFailure property

MaximumErrorCountDefaultValue

Gets the default value for the MaximumErrorCount property

LanguageDefaultValue

Gets the default value for the Language property

DisableEventHandlersDefaultValue

Gets the default value for the DisableEventHandlers property

TransactionModeDefaultValue

Gets the default value for the TransactionMode property

LoggingModeDefaultValue

Gets the default value for the LoggingMode property

IdDefaultValue

Gets the default value for the Id 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.

AddExpressionProperty(AstPropertyNode)
CreateVariable(String, String, String, Boolean, Boolean, IncludeInDebugDump, TypeCode, Object)

Adds a variable with this task as the parent node

AddVariable(String, String, String, Boolean, Boolean, IncludeInDebugDump, TypeCode, Object)

Adds a variable with this task as the parent node

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