Skip to main content

Class AstTransferSqlServerObjectsTaskNode

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.

Namespace: Varigence.Languages.Biml.Task

Assembly: Biml.dll

C#


public class AstTransferSqlServerObjectsTaskNode : AstTaskBaseNode, 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

ConstructorsDescription
AstTransferSqlServerObjectsTaskNode(IFrameworkItem)Initializes a new instance of the AstTransferSqlServerObjectsTaskNode class with the specified parent node.

Fields

FieldsDescription
ScopedNamePrefixBackingStore
IsScopeImported

Properties

PropertiesDescription
CopyAllDefaultsThis value specifies whether all SQL Server default objects are copied, or only those specified.
CopyAllDefaultsDefaultValueGets the default value for the CopyAllDefaults property
CopyAllDriObjectsThis value specifies whether all declarative referential integrity (DRI) objects are copied, or only those specified.
CopyAllDriObjectsDefaultValueGets the default value for the CopyAllDriObjects property
CopyAllLoginsThis value indicates whether all SQL Server logins are copied, or only those specified.
CopyAllLoginsDefaultValueGets the default value for the CopyAllLogins property
CopyAllObjectsThis value indicates whether all SQL Server database objects are copied, or only those specified.
CopyAllObjectsDefaultValueGets the default value for the CopyAllObjects property
CopyAllPartitionFunctionsThis value indicates whether all SQL Server partitions are copied, or only those specified.
CopyAllPartitionFunctionsDefaultValueGets the default value for the CopyAllPartitionFunctions property
CopyAllPartitionSchemesThis value indicates whether all SQL Server partition schemes are copies, or only those specified.
CopyAllPartitionSchemesDefaultValueGets the default value for the CopyAllPartitionSchemes property
CopyAllRulesThis value indicates whether all SQL Server rules are copied, or only those specified.
CopyAllRulesDefaultValueGets the default value for the CopyAllRules property
CopyAllSchemasThis value indicates whether all SQL Server schemas are copied, or only those specified.
CopyAllSchemasDefaultValueGets the default value for the CopyAllSchemas property
CopyAllSqlAssembliesThis value indicates whether all SQL Server assemblies are copied, or only those specified.
CopyAllSqlAssembliesDefaultValueGets the default value for the CopyAllSqlAssemblies property
CopyAllStoredProceduresThis value indicates whether all SQL Server stored procedures are copied, or only those specified.
CopyAllStoredProceduresDefaultValueGets the default value for the CopyAllStoredProcedures property
CopyAllTablesThis value indicates whether all SQL Server tables are copied, or only those indicated.
CopyAllTablesDefaultValueGets the default value for the CopyAllTables property
CopyAllUserDefinedAggregatesThis value indicates whether all user-defined aggregates are transferred, or only those specified.
CopyAllUserDefinedAggregatesDefaultValueGets the default value for the CopyAllUserDefinedAggregates property
CopyAllUserDefinedDataTypesThis value indicates whether all user-defined data types are copied, or only those specified.
CopyAllUserDefinedDataTypesDefaultValueGets the default value for the CopyAllUserDefinedDataTypes property
CopyAllUserDefinedFunctionsThis value indicates whether all user-defined functions are copied, or only those specified.
CopyAllUserDefinedFunctionsDefaultValueGets the default value for the CopyAllUserDefinedFunctions property
CopyAllUserDefinedTypesThis value indicates whether all user-defined types are copied, or only those specified.
CopyAllUserDefinedTypesDefaultValueGets the default value for the CopyAllUserDefinedTypes property
CopyAllUsersThis value indicates whether all SQL Server database users are copied, or only those specified.
CopyAllUsersDefaultValueGets the default value for the CopyAllUsers property
CopyAllViewsThis value indicates whether all SQL Server views are copied, or only those specified.
CopyAllViewsDefaultValueGets the default value for the CopyAllViews property
CopyAllXmlSchemaCollectionsThis value indicates whether all XML schema collections are copied, or only those specified.
CopyAllXmlSchemaCollectionsDefaultValueGets the default value for the CopyAllXmlSchemaCollections property
CopyDataThis value specifies whether data is included when tables and views are copied.
CopyDatabaseRolesThis value specifies whether database roles are copied.
CopyDatabaseRolesDefaultValueGets the default value for the CopyDatabaseRoles property
CopyDatabaseUsersThis value specifies whether database users are copied.
CopyDatabaseUsersDefaultValueGets the default value for the CopyDatabaseUsers property
CopyDataDefaultValueGets the default value for the CopyData property
CopyForeignKeysThis value specifies whether foreign keys are copied.
CopyForeignKeysDefaultValueGets the default value for the CopyForeignKeys property
CopyFullTextIndexesThis value specifies whether full-text properties are copied.
CopyFullTextIndexesDefaultValueGets the default value for the CopyFullTextIndexes property
CopyIndexesThis value specifies whether indexes are copied.
CopyIndexesDefaultValueGets the default value for the CopyIndexes property
CopyObjectLevelPermissionsThis value specifies whether indexes are copied.
CopyObjectLevelPermissionsDefaultValueGets the default value for the CopyObjectLevelPermissions property
CopyPrimaryKeysThis value specifies whether indexes are copied.
CopyPrimaryKeysDefaultValueGets the default value for the CopyPrimaryKeys property
CopySchemaThis value specifies whether the schema is copied.
CopySchemaDefaultValueGets the default value for the CopySchema property
CopySqlServerLoginsThis value specifies whether SQL Server logins are copied.
CopySqlServerLoginsDefaultValueGets the default value for the CopySqlServerLogins property
CopyTriggersThis value specifies whether triggers are copied.
CopyTriggersDefaultValueGets the default value for the CopyTriggers property
DefaultsThis is a collection of the names of default objects to be copied when the value of CopyAllDefaults is set to False.
DefaultsDefaultValueGets the default value for the Defaults property
DestinationConnectionThis value specifies the SQL Server Management Objects (SMO) connection for the destination database.
DestinationDatabaseThis value specifies the name of the destination database to use.
DestinationDatabaseDefaultValueGets the default value for the DestinationDatabase property
DestinationTranslateCharThis 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.
DestinationTranslateCharDefaultValueGets the default value for the DestinationTranslateChar property
DropObjectsFirstThis value specifies whether objects selected for transfer are removed from the destination before the transfer begins.
DropObjectsFirstDefaultValueGets the default value for the DropObjectsFirst property
ExistingDataThis value specifies whether data copied from the source overwrites existing data in the destination database or is appended to the existing data.
ExistingDataDefaultValueGets the default value for the ExistingData property
FriendlyTypeNameStaticGets the friendly name of the type of this node
GenerateScriptsInUnicodeThis value specifies whether data copied from the source overwrites existing data in the destination database or is appended to the existing data.
GenerateScriptsInUnicodeDefaultValueGets the default value for the GenerateScriptsInUnicode property
IncludeDependentObjectsThis value specifies whether dependent objects are copied.
IncludeDependentObjectsDefaultValueGets the default value for the IncludeDependentObjects property
IncludeExtendedPropertiesThis value specifies whether extended properties are copied.
IncludeExtendedPropertiesDefaultValueGets the default value for the IncludeExtendedProperties property
LoginsThis is a collection of the SQL Server logins that are to be copied when the value of CopyAllLogins is set to False.
LoginsDefaultValueGets the default value for the Logins property
PartitionFunctionsThis is a collection of the partition functions that are to be copied when the value of CopyAllPartitionFunctions is set to False.
PartitionFunctionsDefaultValueGets the default value for the PartitionFunctions property
PartitionSchemesThis is a collection of the partition schemes that are to be copied when the value of CopyAllPartitionSchemes is set to False.
PartitionSchemesDefaultValueGets the default value for the PartitionSchemes property
RulesThis is a collection of the rules that are to be copied when the value of CopyAllRules is set to False.
RulesDefaultValueGets the default value for the Rules property
SchemasThis is a collection of the schemas that are to be copied when the value of CopyAllSchemas is set to False.
SchemasDefaultValueGets the default value for the Schemas property
SourceConnectionThis value specifies the SQL Server Management Objects (SMO) connection for the source database.
SourceDatabaseThis value specifies the name of the database from which objects will be copied.
SourceDatabaseDefaultValueGets the default value for the SourceDatabase property
SourceTranslateCharThis 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.
SourceTranslateCharDefaultValueGets the default value for the SourceTranslateChar property
SqlAssembliesThis is a collection of the SQL Server assemblies that are to be copied when the value of CopyAllSqlAssemblies is set to False.
SqlAssembliesDefaultValueGets the default value for the SqlAssemblies property
StoredProceduresThis is a collection of the stored procedures that are to be copied when the value of CopyAllStoredProcedures is set to False.
StoredProceduresDefaultValueGets the default value for the StoredProcedures property
TablesThis is a collection of the tables that are to be copied when the value of CopyAllTables is set to False.
TablesDefaultValueGets the default value for the Tables property
UseCollationThis 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.
UseCollationDefaultValueGets the default value for the UseCollation property
UserDefinedAggregatesThis is a collection of the user-defined aggregates that are to be copied when the value of CopyAllUserDefinedAggregates is set to False.
UserDefinedAggregatesDefaultValueGets the default value for the UserDefinedAggregates property
UserDefinedDataTypesThis is a collection of the user-defined data types that are to be copied when the value of CopyAllUserDefinedDataTypes is set to False.
UserDefinedDataTypesDefaultValueGets the default value for the UserDefinedDataTypes property
UserDefinedFunctionsThis is a collection of the user-defined functions that are to be copied when the value of CopyAllUserDefinedFunctions is set to False.
UserDefinedFunctionsDefaultValueGets the default value for the UserDefinedFunctions property
UserDefinedTypesThis is a collection of the user-defined types that are to be copied when the value of CopyAllUserDefinedTypes is set to False.
UserDefinedTypesDefaultValueGets the default value for the UserDefinedTypes property
UsersThis is a collection of the SQL Server database users that are to be copied when the value of CopyAllUsers is set to False.
UsersDefaultValueGets the default value for the Users property
ViewsThis is a collection of the views that are to be copied when the value of CopyAllViews is set to False.
ViewsDefaultValueGets the default value for the Views property
XmlSchemaCollectionsThis is a collection of the XML schema collections that are to be copied when the value of CopyAllXmlSchemaCollections is set to False.
XmlSchemaCollectionsDefaultValueGets the default value for the XmlSchemaCollections property
ExecutionValueVariableSpecifies a variable to hold the execution results of this component.
VisibleVariablesGets 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
VisiblePackageParametersGets a collection of all package parameter nodes that are available to be used by this task.
VisibleProjectParametersGets 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.
OutputPathGets a default OutputPath that all subsequent nodes will connect to, if they choose to create a precendence constraint
SystemVariablesGets a collection of all variables defined in this task that have been provided by SSIS as system variables
PrecedenceConstraintsThis is a container for task precedence constraint definitions.
EventsThis is a collection of event handlers that can respond to SQL Server Integration Services events that are raised on this task.
DelayValidationThis 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.
IsolationLevelSets the Isolation Level which controls how Transactions behave for this container.
ForcedExecutionValueIf 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.
ForceExecutionResultThis 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.
ForceExecutionValueGets 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.
ForcedExecutionValueDataTypeThis property specifies the data type of the value stored in the ForceExecutionValue property.
DisabledThis value specifies whether the item is disabled. The default value is False.
FailPackageOnFailureThis 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.
FailParentOnFailureThis value determines whether the parent container will fail when a child container failes. The default value is False.
MaximumErrorCountThis value specifies the maximum number of errors allowed to occur before a package is forced to stop running. The default value is 1.
LanguageThis specifies the default language to be used by this task and its descendants.
DisableEventHandlersThis value specifies whether the event handlers for this task, container, or package should be prevented from executing. The default value is False.
TransactionModeThis value specifies the transaction context in which this task will execute.
VariablesThis is a container for variable definitions that are specific to this task, container, or package.
LoggingModeThis value specifies whether logging is enabled or disabled by the container or by the parent container. The default value is UseParentSetting.
LogEventsThis is a container for log event definitions that are specific to this task, container, or package.
LogProvidersDefines the log providers to use for the SSIS task or container
ExpressionsThis is a collection of SSIS expression definitions for property value overrides that are specific to this task, container, or package.
IdAllows the developer to specify a unique identifier (GUID) for the package. This can be used to retain a consistent ID between builds.
DelayValidationDefaultValueGets the default value for the DelayValidation property
IsolationLevelDefaultValueGets the default value for the IsolationLevel property
ForcedExecutionValueDefaultValueGets the default value for the ForcedExecutionValue property
ForceExecutionResultDefaultValueGets the default value for the ForceExecutionResult property
ForceExecutionValueDefaultValueGets the default value for the ForceExecutionValue property
DisabledDefaultValueGets the default value for the Disabled property
FailPackageOnFailureDefaultValueGets the default value for the FailPackageOnFailure property
FailParentOnFailureDefaultValueGets the default value for the FailParentOnFailure property
MaximumErrorCountDefaultValueGets the default value for the MaximumErrorCount property
LanguageDefaultValueGets the default value for the Language property
DisableEventHandlersDefaultValueGets the default value for the DisableEventHandlers property
TransactionModeDefaultValueGets the default value for the TransactionMode property
LoggingModeDefaultValueGets the default value for the LoggingMode property
IdDefaultValueGets the default value for the Id property
ScopedNameGets the scoped name which can be used to uniquely identify this object among other objects of its type
SymbolTableGets a reference to the symbol table that stores a reference to this and all other named objects in the project
SsisSafeScopedNameReturns a version of the ScopedName that has been cleaned of invalid characters for SSIS.
SsisSafeNameReturns a version of the Name that has been cleaned of invalid characters for SSIS.
NameSpecifies the name of the object. This name can be used to reference this object from anywhere else in the program.
ReferencesGets collection of FrameworkItemReference objects, which track rich information about the properties that hold references to this node.
NameDefaultValueGets the default value for the Name property
Guid
AnnotationsThis 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.
ObjectTagThis 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.
BimlFileThis value specifies the BimlFile in which the Biml code that defines AstNode resides.
ItemLabelGets a label that can be used to identify this node
ParentItemThis 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

MethodsDescription
BindingScopeBoundaries()Retrieves the permitted scope boundaries to bind references from this 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
DefinedAstNodes()Retrieves a collection of nodes that have been defined as direct children of the current 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)