Biml API Reference
AstTransferSqlServerObjectsTaskNode Type
BimlStudio 2017

The Transfer SQL Server Objects task copies objects in a SQL Server database from on instance of SQL Server to another. The version of SQL Server being used determines what types of objects can be copied.
Inheritance Hierarchy
Assembly:
Biml (in Biml.dll)
Properties
  Name Summary
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.
(Inherited from AstNode)
BimlFile
This value specifies the BimlFile in which the Biml code that defines AstNode resides.
(Inherited from AstNode)
CanAutoLayoutMoveSinkAnchors
Gets a value to indicate whether autolayout is permitted to rearrange sink anchors on the design surface to reduce edge overlapping
(Inherited from AstTaskNode)
CanAutoLayoutMoveSourceAnchors
Gets a value to indicate whether autolayout is permitted to rearrange source anchors on the design surface to reduce edge overlapping
(Inherited from AstTaskNode)
CopyAllDefaults
This value specifies whether all SQL Server default objects are copied, or only those specified.
CopyAllDefaultsDefaultValue
Gets the default value for the CopyAllDefaults property
CopyAllDriObjects
This value specifies whether all declarative referential integrity (DRI) objects are copied, or only those specified.
CopyAllDriObjectsDefaultValue
Gets the default value for the CopyAllDriObjects property
CopyAllLogins
This value indicates whether all SQL Server logins are copied, or only those specified.
CopyAllLoginsDefaultValue
Gets the default value for the CopyAllLogins property
CopyAllObjects
This value indicates whether all SQL Server database objects are copied, or only those specified.
CopyAllObjectsDefaultValue
Gets the default value for the CopyAllObjects property
CopyAllPartitionFunctions
This value indicates whether all SQL Server partitions are copied, or only those specified.
CopyAllPartitionFunctionsDefaultValue
Gets the default value for the CopyAllPartitionFunctions property
CopyAllPartitionSchemes
This value indicates whether all SQL Server partition schemes are copies, or only those specified.
CopyAllPartitionSchemesDefaultValue
Gets the default value for the CopyAllPartitionSchemes property
CopyAllRules
This value indicates whether all SQL Server rules are copied, or only those specified.
CopyAllRulesDefaultValue
Gets the default value for the CopyAllRules property
CopyAllSchemas
This value indicates whether all SQL Server schemas are copied, or only those specified.
CopyAllSchemasDefaultValue
Gets the default value for the CopyAllSchemas property
CopyAllSqlAssemblies
This value indicates whether all SQL Server assemblies are copied, or only those specified.
CopyAllSqlAssembliesDefaultValue
Gets the default value for the CopyAllSqlAssemblies property
CopyAllStoredProcedures
This value indicates whether all SQL Server stored procedures are copied, or only those specified.
CopyAllStoredProceduresDefaultValue
Gets the default value for the CopyAllStoredProcedures property
CopyAllTables
This value indicates whether all SQL Server tables are copied, or only those indicated.
CopyAllTablesDefaultValue
Gets the default value for the CopyAllTables property
CopyAllUserDefinedAggregates
This value indicates whether all user-defined aggregates are transferred, or only those specified.
CopyAllUserDefinedAggregatesDefaultValue
Gets the default value for the CopyAllUserDefinedAggregates property
CopyAllUserDefinedDataTypes
This value indicates whether all user-defined data types are copied, or only those specified.
CopyAllUserDefinedDataTypesDefaultValue
Gets the default value for the CopyAllUserDefinedDataTypes property
CopyAllUserDefinedFunctions
This value indicates whether all user-defined functions are copied, or only those specified.
CopyAllUserDefinedFunctionsDefaultValue
Gets the default value for the CopyAllUserDefinedFunctions property
CopyAllUserDefinedTypes
This value indicates whether all user-defined types are copied, or only those specified.
CopyAllUserDefinedTypesDefaultValue
Gets the default value for the CopyAllUserDefinedTypes property
CopyAllUsers
This value indicates whether all SQL Server database users are copied, or only those specified.
CopyAllUsersDefaultValue
Gets the default value for the CopyAllUsers property
CopyAllViews
This value indicates whether all SQL Server views are copied, or only those specified.
CopyAllViewsDefaultValue
Gets the default value for the CopyAllViews property
CopyAllXmlSchemaCollections
This value indicates whether all XML schema collections are copied, or only those specified.
CopyAllXmlSchemaCollectionsDefaultValue
Gets the default value for the CopyAllXmlSchemaCollections property
CopyData
This value specifies whether data is included when tables and views are copied.
CopyDatabaseRoles
This value specifies whether database roles are copied.
CopyDatabaseRolesDefaultValue
Gets the default value for the CopyDatabaseRoles property
CopyDatabaseUsers
This value specifies whether database users are copied.
CopyDatabaseUsersDefaultValue
Gets the default value for the CopyDatabaseUsers property
CopyDataDefaultValue
Gets the default value for the CopyData property
CopyForeignKeys
This value specifies whether foreign keys are copied.
CopyForeignKeysDefaultValue
Gets the default value for the CopyForeignKeys property
CopyFullTextIndexes
This value specifies whether full-text properties are copied.
CopyFullTextIndexesDefaultValue
Gets the default value for the CopyFullTextIndexes property
CopyIndexes
This value specifies whether indexes are copied.
CopyIndexesDefaultValue
Gets the default value for the CopyIndexes property
CopyObjectLevelPermissions
This value specifies whether indexes are copied.
CopyObjectLevelPermissionsDefaultValue
Gets the default value for the CopyObjectLevelPermissions property
CopyPrimaryKeys
This value specifies whether indexes are copied.
CopyPrimaryKeysDefaultValue
Gets the default value for the CopyPrimaryKeys property
CopySchema
This value specifies whether the schema is copied.
CopySchemaDefaultValue
Gets the default value for the CopySchema property
CopySqlServerLogins
This value specifies whether SQL Server logins are copied.
CopySqlServerLoginsDefaultValue
Gets the default value for the CopySqlServerLogins property
CopyTriggers
This value specifies whether triggers are copied.
CopyTriggersDefaultValue
Gets the default value for the CopyTriggers property
Defaults
This is a collection of the names of default objects to be copied when the value of CopyAllDefaults is set to False.
DefaultsDefaultValue
Gets the default value for the Defaults property
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.
(Inherited from AstTaskNode)
DelayValidationDefaultValue
Gets the default value for the DelayValidation property
(Inherited from AstTaskNode)
DestinationConnection
This value specifies the SQL Server Management Objects (SMO) connection for the destination database.
DestinationDatabase
This value specifies the name of the destination database to use.
DestinationDatabaseDefaultValue
Gets the default value for the DestinationDatabase property
DestinationTranslateChar
This value specifies whether AutoTranslate will be used to minimize problems with the transfer of character data when the source and the destination have different code pages.
DestinationTranslateCharDefaultValue
Gets the default value for the DestinationTranslateChar property
Disabled
This value specifies whether the item is disabled. The default value is False.
(Inherited from AstTaskNode)
DisabledDefaultValue
Gets the default value for the Disabled property
(Inherited from AstTaskNode)
DisableEventHandlers
This value specifies whether the event handlers for this task, container, or package should be prevented from executing. The default value is False.
(Inherited from AstTaskNode)
DisableEventHandlersDefaultValue
Gets the default value for the DisableEventHandlers property
(Inherited from AstTaskNode)
DropObjectsFirst
This value specifies whether objects selected for transfer are removed from the destination before the transfer begins.
DropObjectsFirstDefaultValue
Gets the default value for the DropObjectsFirst property
Error
Gets the error string for this node, if any
(Inherited from AstNode)
ErrorCount
Gets the count of error diagnostics that have been generated for this node
(Inherited from AstNode)
Events
This is a collection of event handlers that can respond to SQL Server Integration Services events that are raised on this task.
(Inherited from AstTaskNode)
ExecutionValueVariable
Specifies a variable to hold the execution results of this component.
(Inherited from AstTaskBaseNode)
ExistingData
This value specifies whether data copied from the source overwrites existing data in the destination database or is appended to the existing data.
ExistingDataDefaultValue
Gets the default value for the ExistingData property
ExpressionProperties
This collection holds properties that can be referenced by expressions. It's not necessarily the same properties that are available directly on the object. These AstPropertyNodes are here to support binding, not to be confused with the Properties collection on the generic control flow base object, which has "real" AstPropertyNodes.
(Inherited from AstTaskNode)
Expressions
This is a collection of SSIS expression definitions for property value overrides that are specific to this task, container, or package.
(Inherited from AstTaskNode)
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.
(Inherited from AstTaskNode)
FailPackageOnFailureDefaultValue
Gets the default value for the FailPackageOnFailure property
(Inherited from AstTaskNode)
FailParentOnFailure
This value determines whether the parent container will fail when a child container failes. The default value is False.
(Inherited from AstTaskNode)
FailParentOnFailureDefaultValue
Gets the default value for the FailParentOnFailure property
(Inherited from AstTaskNode)
FlowFile
This value specifies the containing code file of this node for Xml Binding purposes.
(Inherited from AstNode)
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.
(Inherited from AstTaskNode)
ForcedExecutionValueDataType
This property specifies the data type of the value stored in the ForceExecutionValue property.
(Inherited from AstTaskNode)
ForcedExecutionValueDefaultValue
Gets the default value for the ForcedExecutionValue property
(Inherited from AstTaskNode)
ForceDisableIncrementalChangeTracking
This value specifies whether changes to property values of this node should be automatically reflected in the corresponding Biml code. Its primary use is for temporary nodes that will never be persisted into BimlFiles.
(Inherited from AstNode)
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.
(Inherited from AstTaskNode)
ForceExecutionResultDefaultValue
Gets the default value for the ForceExecutionResult property
(Inherited from AstTaskNode)
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.
(Inherited from AstTaskNode)
ForceExecutionValueDefaultValue
Gets the default value for the ForceExecutionValue property
(Inherited from AstTaskNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstNamedNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstScopeBoundaryNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstTaskNode)
FriendlyTypeName
Gets the friendly name of the type of this node
(Inherited from AstTaskBaseNode)
FriendlyTypeName
Gets the friendly name of the type of this node
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstNamedNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstScopeBoundaryNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstTaskNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
(Inherited from AstTaskBaseNode)
FriendlyTypeNameStatic
Gets the friendly name of the type of this node
GenerateScriptsInUnicode
This value specifies whether data copied from the source overwrites existing data in the destination database or is appended to the existing data.
GenerateScriptsInUnicodeDefaultValue
Gets the default value for the GenerateScriptsInUnicode property
Id
Allows the developer to specify a unique identifier (GUID) for the package. This can be used to retain a consistent ID between builds.
(Inherited from AstTaskNode)
IdDefaultValue
Gets the default value for the Id property
(Inherited from AstTaskNode)
ImportedScopeChildren
Gets this ScopeBoundary's referenceable items. This is used to notify the children items when this item's ScopedName changes.
(Inherited from AstScopeBoundaryNode)
IncludeDependentObjects
This value specifies whether dependent objects are copied.
IncludeDependentObjectsDefaultValue
Gets the default value for the IncludeDependentObjects property
IncludeExtendedProperties
This value specifies whether extended properties are copied.
IncludeExtendedPropertiesDefaultValue
Gets the default value for the IncludeExtendedProperties property
IsAstNodeReadOnly
Gets a value indicating whether this node is currently in a read-only state
(Inherited from AstNode)
IsInBrokenLiveBimlScript
Specifies whether or not this object is part of a live BimlScript containing an error, which means that this is a cached object that may be out-of-date
(Inherited from AstNode)
IsolationLevel
Sets the Isolation Level which controls how Transactions behave for this container.
(Inherited from AstTaskNode)
IsolationLevelDefaultValue
Gets the default value for the IsolationLevel property
(Inherited from AstTaskNode)
ItemLabel
Gets a label that can be used to identify this node
(Inherited from AstNode)
Language
This specifies the default language to be used by this task and its descendants.
(Inherited from AstTaskNode)
LanguageDefaultValue
Gets the default value for the Language property
(Inherited from AstTaskNode)
LogEvents
This is a container for log event definitions that are specific to this task, container, or package.
(Inherited from AstTaskNode)
LoggingMode
This value specifies whether logging is enabled or disabled by the container or by the parent container. The default value is UseParentSetting.
(Inherited from AstTaskNode)
LoggingModeDefaultValue
Gets the default value for the LoggingMode property
(Inherited from AstTaskNode)
Logins
This is a collection of the SQL Server logins that are to be copied when the value of CopyAllLogins is set to False.
LoginsDefaultValue
Gets the default value for the Logins property
LogProviders
Defines the log providers to use for the SSIS task or container
(Inherited from AstTaskNode)
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.
(Inherited from AstTaskNode)
MaximumErrorCountDefaultValue
Gets the default value for the MaximumErrorCount property
(Inherited from AstTaskNode)
MessageCount
Gets the count of message diagnostics that have been generated for this node
(Inherited from AstNode)
Name
Specifies the name of the object. This name can be used to reference this object from anywhere else in the program.
(Inherited from AstNamedNode)
NameDefaultValue
Gets the default value for the Name property
(Inherited from AstNamedNode)
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.
(Inherited from AstNode)
OutputPath
Gets a default OutputPath that all subsequent nodes will connect to, if they choose to create a precendence constraint
(Inherited from AstTaskNode)
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.
(Inherited from AstNode)
ParentXObjectMappingProvider
This value specifies the parent of the current node for Xml Binding purposes.
(Inherited from AstNode)
PartitionFunctions
This is a collection of the partition functions that are to be copied when the value of CopyAllPartitionFunctions is set to False.
PartitionFunctionsDefaultValue
Gets the default value for the PartitionFunctions property
PartitionSchemes
This is a collection of the partition schemes that are to be copied when the value of CopyAllPartitionSchemes is set to False.
PartitionSchemesDefaultValue
Gets the default value for the PartitionSchemes property
PrecedenceConstraints
This is a container for task precedence constraint definitions.
(Inherited from AstTaskNode)
PropertyChangeNotificationTarget
Gets a reference to the ViewModel object for this node. This property should only be used by the internal Biml framework.
(Inherited from AstNode)
ReferenceCount
Gets or sets the total number of other node properties that hold a reference to this node.
(Inherited from AstNamedNode)
References
Gets collection of FrameworkItemReference objects, which track rich information about the properties that hold references to this node.
(Inherited from AstNamedNode)
RefId
Returns the SSIS refid that is used to reference this item from within an SSIS package or dataflow.
(Inherited from AstNamedNode)
Rules
This is a collection of the rules that are to be copied when the value of CopyAllRules is set to False.
RulesDefaultValue
Gets the default value for the Rules property
Schemas
This is a collection of the schemas that are to be copied when the value of CopyAllSchemas is set to False.
SchemasDefaultValue
Gets the default value for the Schemas property
ScopeBoundary
Gets the scope boundary for this node
(Inherited from AstNode)
ScopeBoundary
Gets the ScopeBoundary for this referenceable item
(Inherited from AstNamedNode)
ScopedName
Gets the scoped name which can be used to uniquely identify this object among other objects of its type
(Inherited from AstNamedNode)
ScopedNamePrefix
Gets the prefix to use for ScopedName calculations
(Inherited from AstNamedNode)
SourceConnection
This value specifies the SQL Server Management Objects (SMO) connection for the source database.
SourceDatabase
This value specifies the name of the database from which objects will be copied.
SourceDatabaseDefaultValue
Gets the default value for the SourceDatabase property
SourceTranslateChar
This value specifies whether AutoTranslate will be used to minimize problems with the transfer of character data when the source and the destination have different code pages.
SourceTranslateCharDefaultValue
Gets the default value for the SourceTranslateChar property
SqlAssemblies
This is a collection of the SQL Server assemblies that are to be copied when the value of CopyAllSqlAssemblies is set to False.
SqlAssembliesDefaultValue
Gets the default value for the SqlAssemblies property
SsisSafeName
Returns a version of the Name that has been cleaned of invalid characters for SSIS.
(Inherited from AstNamedNode)
SsisSafeScopedName
Returns a version of the ScopedName that has been cleaned of invalid characters for SSIS.
(Inherited from AstNamedNode)
StaticUserDefinedItems
Specifies a collection of items that are common across all instances of the same type in the framework.
(Inherited from AstTaskNode)
StaticUserDefinedItems
Specifies a collection of items that are common across all instances of the same type in the framework.
(Inherited from AstTaskBaseNode)
StaticUserDefinedItems
Specifies a collection of items that are common across all instances of the same type in the framework.
StoredProcedures
This is a collection of the stored procedures that are to be copied when the value of CopyAllStoredProcedures is set to False.
StoredProceduresDefaultValue
Gets the default value for the StoredProcedures property
SymbolTable
Gets a reference to the symbol table that stores a reference to this and all other named objects in the project
(Inherited from AstNamedNode)
SymbolTableProvider
Gets the symbol table provider for this node
(Inherited from AstNode)
SystemVariables
Gets a collection of all variables defined in this task that have been provided by SSIS as system variables
(Inherited from AstTaskNode)
Tables
This is a collection of the tables that are to be copied when the value of CopyAllTables is set to False.
TablesDefaultValue
Gets the default value for the Tables property
TransactionMode
This value specifies the transaction context in which this task will execute.
(Inherited from AstTaskNode)
TransactionModeDefaultValue
Gets the default value for the TransactionMode property
(Inherited from AstTaskNode)
TreeDepth
Gets the distance between this node and the root item
(Inherited from AstNode)
UseCollation
This value specifies whether collation settings are maintained during the transfer. Performance may decrease if UseCollation is set to True and the data includes non-Unicode data types such as text or varchar, or if the source database contains a large number of tables, columns, and rows. The default value is false.
UseCollationDefaultValue
Gets the default value for the UseCollation property
UserDefinedAggregates
This is a collection of the user-defined aggregates that are to be copied when the value of CopyAllUserDefinedAggregates is set to False.
UserDefinedAggregatesDefaultValue
Gets the default value for the UserDefinedAggregates property
UserDefinedDataTypes
This is a collection of the user-defined data types that are to be copied when the value of CopyAllUserDefinedDataTypes is set to False.
UserDefinedDataTypesDefaultValue
Gets the default value for the UserDefinedDataTypes property
UserDefinedFunctions
This is a collection of the user-defined functions that are to be copied when the value of CopyAllUserDefinedFunctions is set to False.
UserDefinedFunctionsDefaultValue
Gets the default value for the UserDefinedFunctions property
UserDefinedItems
Gets the child items of this node that were defined in user code
(Inherited from AstNode)
UserDefinedTypes
This is a collection of the user-defined types that are to be copied when the value of CopyAllUserDefinedTypes is set to False.
UserDefinedTypesDefaultValue
Gets the default value for the UserDefinedTypes property
Users
This is a collection of the SQL Server database users that are to be copied when the value of CopyAllUsers is set to False.
UsersDefaultValue
Gets the default value for the Users property
Variables
This is a container for variable definitions that are specific to this task, container, or package.
(Inherited from AstTaskNode)
Views
This is a collection of the views that are to be copied when the value of CopyAllViews is set to False.
ViewsDefaultValue
Gets the default value for the Views property
VisiblePackageParameters
Gets a collection of all package parameter nodes that are available to be used by this task.
(Inherited from AstTaskNode)
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.
(Inherited from AstTaskNode)
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
(Inherited from AstTaskNode)
WarningCount
Gets the count of warning diagnostics that have been generated for this node
(Inherited from AstNode)
XmlMapping
Gets the XML binding information that is used to track the Biml code that corresponds to this node
(Inherited from AstNode)
XmlSchemaCollections
This is a collection of the XML schema collections that are to be copied when the value of CopyAllXmlSchemaCollections is set to False.
XmlSchemaCollectionsDefaultValue
Gets the default value for the XmlSchemaCollections property
Methods
  Name Summary
Events
  Name Summary
ItemLabelChanged
The ItemLabelChanged event occurs when the name of this node or any scope boundary ancestor (as determined by following ParentItem to the AstRootNode) name changes.
NameChanged
The NameChanged event occurs when the Name property of the current node has changed to a new value and that value has been committed.
NameChanging
The NameChanging event occurs when the Name property of the current node is receiving a new value but that value has not yet been committed.
ScopeBoundaryChanged
The ScopeBoundaryChanged event occurs when any ancestor (as determined by following ParentItem to the AstRootNode) changes in such a way as the ScopeBoundary for this node changes. This will force the ScopedName of this node to change if it is an AstNamedNode.
ScopedNameChanged
The ScopedNameChanged event occurs when the name of this node or any scope boundary ancestor (as determined by following ParentItem to the AstRootNode) name changes.
Extension Methods
  Name Summary
AddAnnotation(AnnotationType,String)
Adds an annotation to an AstNode
[Extension Method: Import namespace Varigence.Biml.Extensions]
AddAnnotation(AnnotationType,String,String)
Adds an annotation to an AstNode
[Extension Method: Import namespace Varigence.Biml.Extensions]
EnumerateAncestors
Returns the ancestors of the current node
[Extension Method: Import namespace Varigence.Biml.Extensions]
GetBiml()
Retrieve the Biml that represents the AstNode
[Extension Method: Import namespace Varigence.Biml.Extensions]
GetTag(String)
Gets the first annotation with a matching tag and returns the value. If the tag is not found, returns an empty string.
[Extension Method: Import namespace Varigence.Biml.Extensions]
GetTag(String,Boolean)
Gets the first annotation with a matching tag and returns the value. If the tag is not found, returns an empty string.
[Extension Method: Import namespace Varigence.Biml.Extensions]
GetTag(String,Boolean,Boolean)
Gets the first annotation with a matching tag and returns the value. If the tag is not found, returns an empty string.
[Extension Method: Import namespace Varigence.Biml.Extensions]
.NET API Metadata
Assembly:
Biml
Friendly Name:
TransferSQLServerObjectsTask
Abstract:
False
Referenceable:
True
Root Item:
False
Scope Boundary:
False
Symbol Table Provider:
False
Xml Schema Name:
Varigence.Languages.Biml.Task.AstTransferSqlServerObjectsTaskNode
Xsd Namespace:
http://schemas.varigence.com/biml.xsd
Referenceable:
True
Scope Boundary:
False