Biml Language Reference
TransferSQLServerObjectsTask Element
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.
Attributes
  Attribute API Type Default Description
CopyAllDefaults Boolean
This value specifies whether all SQL Server default objects are copied, or only those specified.

[.NET API Property: CopyAllDefaults]

CopyAllDriObjects Boolean
This value specifies whether all declarative referential integrity (DRI) objects are copied, or only those specified.

[.NET API Property: CopyAllDriObjects]

CopyAllLogins Boolean
This value indicates whether all SQL Server logins are copied, or only those specified.

[.NET API Property: CopyAllLogins]

CopyAllObjects Boolean
This value indicates whether all SQL Server database objects are copied, or only those specified.

[.NET API Property: CopyAllObjects]

CopyAllPartitionFunctions Boolean
This value indicates whether all SQL Server partitions are copied, or only those specified.

[.NET API Property: CopyAllPartitionFunctions]

CopyAllPartitionSchemes Boolean
This value indicates whether all SQL Server partition schemes are copies, or only those specified.

[.NET API Property: CopyAllPartitionSchemes]

CopyAllRules Boolean
This value indicates whether all SQL Server rules are copied, or only those specified.

[.NET API Property: CopyAllRules]

CopyAllSchemas Boolean
This value indicates whether all SQL Server schemas are copied, or only those specified.

[.NET API Property: CopyAllSchemas]

CopyAllSqlAssemblies Boolean
This value indicates whether all SQL Server assemblies are copied, or only those specified.

[.NET API Property: CopyAllSqlAssemblies]

CopyAllStoredProcedures Boolean
This value indicates whether all SQL Server stored procedures are copied, or only those specified.

[.NET API Property: CopyAllStoredProcedures]

CopyAllTables Boolean
This value indicates whether all SQL Server tables are copied, or only those indicated.

[.NET API Property: CopyAllTables]

CopyAllUserDefinedAggregates Boolean
This value indicates whether all user-defined aggregates are transferred, or only those specified.

[.NET API Property: CopyAllUserDefinedAggregates]

CopyAllUserDefinedDataTypes Boolean
This value indicates whether all user-defined data types are copied, or only those specified.

[.NET API Property: CopyAllUserDefinedDataTypes]

CopyAllUserDefinedFunctions Boolean
This value indicates whether all user-defined functions are copied, or only those specified.

[.NET API Property: CopyAllUserDefinedFunctions]

CopyAllUserDefinedTypes Boolean
This value indicates whether all user-defined types are copied, or only those specified.

[.NET API Property: CopyAllUserDefinedTypes]

CopyAllUsers Boolean
This value indicates whether all SQL Server database users are copied, or only those specified.

[.NET API Property: CopyAllUsers]

CopyAllViews Boolean
This value indicates whether all SQL Server views are copied, or only those specified.

[.NET API Property: CopyAllViews]

CopyAllXmlSchemaCollections Boolean
This value indicates whether all XML schema collections are copied, or only those specified.

[.NET API Property: CopyAllXmlSchemaCollections]

CopyData Boolean
This value specifies whether data is included when tables and views are copied.

[.NET API Property: CopyData]

CopyDatabaseRoles Boolean
This value specifies whether database roles are copied.

[.NET API Property: CopyDatabaseRoles]

CopyDatabaseUsers Boolean
This value specifies whether database users are copied.

[.NET API Property: CopyDatabaseUsers]

CopyForeignKeys Boolean
This value specifies whether foreign keys are copied.

[.NET API Property: CopyForeignKeys]

CopyFullTextIndexes Boolean
This value specifies whether full-text properties are copied.

[.NET API Property: CopyFullTextIndexes]

CopyIndexes Boolean
This value specifies whether indexes are copied.

[.NET API Property: CopyIndexes]

CopyObjectLevelPermissions Boolean
This value specifies whether indexes are copied.

[.NET API Property: CopyObjectLevelPermissions]

CopyPrimaryKeys Boolean
This value specifies whether indexes are copied.

[.NET API Property: CopyPrimaryKeys]

CopySchema Boolean
This value specifies whether the schema is copied.

[.NET API Property: CopySchema]

CopySqlServerLogins Boolean
This value specifies whether SQL Server logins are copied.

[.NET API Property: CopySqlServerLogins]

CopyTriggers Boolean
This value specifies whether triggers are copied.

[.NET API Property: CopyTriggers]

DelayValidation Boolean
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.

[.NET API Property: DelayValidation]

DestinationConnectionName AstSqlServerManagementConnectionNode
This value specifies the SQL Server Management Objects (SMO) connection for the destination database.

[.NET API Property: DestinationConnection]

DestinationDatabase String
This value specifies the name of the destination database to use.

[.NET API Property: DestinationDatabase]

DestinationTranslateChar Boolean
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.

[.NET API Property: DestinationTranslateChar]

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

[.NET API Property: Disabled]

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

[.NET API Property: DisableEventHandlers]

DropObjectsFirst Boolean
This value specifies whether objects selected for transfer are removed from the destination before the transfer begins.

[.NET API Property: DropObjectsFirst]

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

[.NET API Property: ExecutionValueVariable]

ExistingData TransferSqlServerObjectTaskExistingDataOption
This value specifies whether data copied from the source overwrites existing data in the destination database or is appended to the existing data.

[.NET API Property: ExistingData]

FailPackageOnFailure Boolean
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.

[.NET API Property: FailPackageOnFailure]

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

[.NET API Property: FailParentOnFailure]

ForcedExecutionValue String
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.

[.NET API Property: ForcedExecutionValue]

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

[.NET API Property: ForcedExecutionValueDataType]

ForceExecutionResult 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.

[.NET API Property: ForceExecutionResult]

ForceExecutionValue Boolean
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.

[.NET API Property: ForceExecutionValue]

GenerateScriptsInUnicode Boolean
This value specifies whether data copied from the source overwrites existing data in the destination database or is appended to the existing data.

[.NET API Property: GenerateScriptsInUnicode]

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

[.NET API Property: Id]

IncludeDependentObjects Boolean
This value specifies whether dependent objects are copied.

[.NET API Property: IncludeDependentObjects]

IncludeExtendedProperties Boolean
This value specifies whether extended properties are copied.

[.NET API Property: IncludeExtendedProperties]

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

[.NET API Property: IsolationLevel]

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

[.NET API Property: Language]

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

[.NET API Property: LoggingMode]

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

[.NET API Property: MaximumErrorCount]

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

[.NET API Property: Name]

SourceConnectionName AstSqlServerManagementConnectionNode
This value specifies the SQL Server Management Objects (SMO) connection for the source database.

[.NET API Property: SourceConnection]

SourceDatabase String
This value specifies the name of the database from which objects will be copied.

[.NET API Property: SourceDatabase]

SourceTranslateChar Boolean
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.

[.NET API Property: SourceTranslateChar]

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

[.NET API Property: TransactionMode]

UseCollation Boolean
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.

[.NET API Property: UseCollation]

Singleton Children
  Child API Type Description
<PrecedenceConstraints /> AstTaskflowPrecedenceConstraintsNode
This is a container for task precedence constraint definitions.

[.NET API Property: PrecedenceConstraints]

Collection Children
  Child API Type Description
<Annotations>
    <Annotation />
</Annotations>
AstAnnotationNode
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.

[.NET API Property: Annotations]

<LogProviders>
    Multiple Choices...
</LogProviders>
AstLogProviderBaseNode
Defines the log providers to use for the SSIS task or container

[.NET API Property: LogProviders]

<Defaults>
    <Default />
</Defaults>
String
This is a collection of the names of default objects to be copied when the value of CopyAllDefaults is set to False.

[.NET API Property: Defaults]

<Events>
    <Event />
</Events>
AstTaskEventHandlerNode
This is a collection of event handlers that can respond to SQL Server Integration Services events that are raised on this task.

[.NET API Property: Events]

<Expressions>
    <Expression />
</Expressions>
AstPropertyExpressionNode
This is a collection of SSIS expression definitions for property value overrides that are specific to this task, container, or package.

[.NET API Property: Expressions]

<LogEvents>
    <LogEvent />
</LogEvents>
AstLogEventNode
This is a container for log event definitions that are specific to this task, container, or package.

[.NET API Property: LogEvents]

<Logins>
    <Login />
</Logins>
String
This is a collection of the SQL Server logins that are to be copied when the value of CopyAllLogins is set to False.

[.NET API Property: Logins]

<PartitionFunctions>
    <PartitionFunction />
</PartitionFunctions>
String
This is a collection of the partition functions that are to be copied when the value of CopyAllPartitionFunctions is set to False.

[.NET API Property: PartitionFunctions]

<PartitionSchemes>
    <PartitionScheme />
</PartitionSchemes>
String
This is a collection of the partition schemes that are to be copied when the value of CopyAllPartitionSchemes is set to False.

[.NET API Property: PartitionSchemes]

<Rules>
    <Rule />
</Rules>
String
This is a collection of the rules that are to be copied when the value of CopyAllRules is set to False.

[.NET API Property: Rules]

<Schemas>
    <Schema />
</Schemas>
String
This is a collection of the schemas that are to be copied when the value of CopyAllSchemas is set to False.

[.NET API Property: Schemas]

<SqlAssemblies>
    <SqlAssembly />
</SqlAssemblies>
String
This is a collection of the SQL Server assemblies that are to be copied when the value of CopyAllSqlAssemblies is set to False.

[.NET API Property: SqlAssemblies]

<StoredProcedures>
    <StoredProcedure />
</StoredProcedures>
String
This is a collection of the stored procedures that are to be copied when the value of CopyAllStoredProcedures is set to False.

[.NET API Property: StoredProcedures]

<Tables>
    <Table />
</Tables>
String
This is a collection of the tables that are to be copied when the value of CopyAllTables is set to False.

[.NET API Property: Tables]

<Users>
    <User />
</Users>
String
This is a collection of the SQL Server database users that are to be copied when the value of CopyAllUsers is set to False.

[.NET API Property: Users]

<UserDefinedAggregates>
    <UserDefinedAggregate />
</UserDefinedAggregates>
String
This is a collection of the user-defined aggregates that are to be copied when the value of CopyAllUserDefinedAggregates is set to False.

[.NET API Property: UserDefinedAggregates]

<UserDefinedDataTypes>
    <UserDefinedDataType />
</UserDefinedDataTypes>
String
This is a collection of the user-defined data types that are to be copied when the value of CopyAllUserDefinedDataTypes is set to False.

[.NET API Property: UserDefinedDataTypes]

<UserDefinedFunctions>
    <UserDefinedFunction />
</UserDefinedFunctions>
String
This is a collection of the user-defined functions that are to be copied when the value of CopyAllUserDefinedFunctions is set to False.

[.NET API Property: UserDefinedFunctions]

<UserDefinedTypes>
    <UserDefinedType />
</UserDefinedTypes>
String
This is a collection of the user-defined types that are to be copied when the value of CopyAllUserDefinedTypes is set to False.

[.NET API Property: UserDefinedTypes]

<Variables>
    <Variable />
</Variables>
AstVariableNode
This is a container for variable definitions that are specific to this task, container, or package.

[.NET API Property: Variables]

<Views>
    <View />
</Views>
String
This is a collection of the views that are to be copied when the value of CopyAllViews is set to False.

[.NET API Property: Views]

<XmlSchemaCollections>
    <XmlSchemaCollection />
</XmlSchemaCollections>
String
This is a collection of the XML schema collections that are to be copied when the value of CopyAllXmlSchemaCollections is set to False.

[.NET API Property: XmlSchemaCollections]