Transfer SQL Server Objects Task Element
X-Ref:
- Ast Transfer Sql Server Objects Task Node
- Ast Task Base Node
- Ast Task Node
- Ast Scope Boundary Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| DestinationConnectionName | AstSqlServerManagementConnectionNode | This value specifies the SQL Server Management Objects (SMO) connection for the destination database. This is a required reference to an existing definiton. | |
| DestinationDatabase | String | This value specifies the name of the destination database to use. This is a required property | |
| Name | String | Specifies the name of the object. This name can be used to reference this object from anywhere else in the program. This is a required property | |
| SourceConnectionName | AstSqlServerManagementConnectionNode | This value specifies the SQL Server Management Objects (SMO) connection for the source database. This is a required reference to an existing definiton. | |
| SourceDatabase | String | This value specifies the name of the database from which objects will be copied. This is a required property | |
| CopyAllDefaults | Boolean | False | This value specifies whether all SQL Server default objects are copied, or only those specified. |
| CopyAllDriObjects | Boolean | False | This value specifies whether all declarative referential integrity (DRI) objects are copied, or only those specified. |
| CopyAllLogins | Boolean | False | This value indicates whether all SQL Server logins are copied, or only those specified. |
| CopyAllObjects | Boolean | False | This value indicates whether all SQL Server database objects are copied, or only those specified. |
| CopyAllPartitionFunctions | Boolean | False | This value indicates whether all SQL Server partitions are copied, or only those specified. |
| CopyAllPartitionSchemes | Boolean | False | This value indicates whether all SQL Server partition schemes are copies, or only those specified. |
| CopyAllRules | Boolean | False | This value indicates whether all SQL Server rules are copied, or only those specified. |
| CopyAllSchemas | Boolean | False | This value indicates whether all SQL Server schemas are copied, or only those specified. |
| CopyAllSqlAssemblies | Boolean | False | This value indicates whether all SQL Server assemblies are copied, or only those specified. |
| CopyAllStoredProcedures | Boolean | False | This value indicates whether all SQL Server stored procedures are copied, or only those specified. |
| CopyAllTables | Boolean | False | This value indicates whether all SQL Server tables are copied, or only those indicated. |
| CopyAllUserDefinedAggregates | Boolean | False | This value indicates whether all user-defined aggregates are transferred, or only those specified. |
| CopyAllUserDefinedDataTypes | Boolean | False | This value indicates whether all user-defined data types are copied, or only those specified. |
| CopyAllUserDefinedFunctions | Boolean | False | This value indicates whether all user-defined functions are copied, or only those specified. |
| CopyAllUserDefinedTypes | Boolean | False | This value indicates whether all user-defined types are copied, or only those specified. |
| CopyAllUsers | Boolean | False | This value indicates whether all SQL Server database users are copied, or only those specified. |
| CopyAllViews | Boolean | False | This value indicates whether all SQL Server views are copied, or only those specified. |
| CopyAllXmlSchemaCollections | Boolean | False | This value indicates whether all XML schema collections are copied, or only those specified. |
| CopyData | Boolean | False | This value specifies whether data is included when tables and views are copied. |
| CopyDatabaseRoles | Boolean | False | This value specifies whether database roles are copied. |
| CopyDatabaseUsers | Boolean | False | This value specifies whether database users are copied. |
| CopyForeignKeys | Boolean | False | This value specifies whether foreign keys are copied. |
| CopyFullTextIndexes | Boolean | False | This value specifies whether full-text properties are copied. |
| CopyIndexes | Boolean | False | This value specifies whether indexes are copied. |
| CopyObjectLevelPermissions | Boolean | False | This value specifies whether indexes are copied. |
| CopyPrimaryKeys | Boolean | False | This value specifies whether indexes are copied. |
| CopySchema | Boolean | True | This value specifies whether the schema is copied. |
| CopySqlServerLogins | Boolean | False | This value specifies whether SQL Server logins are copied. |
| CopyTriggers | Boolean | False | This value specifies whether triggers are copied. |
| DelayValidation | Boolean | false | 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. |
| DestinationTranslateChar | Boolean | False | 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. |
| Disabled | Boolean | false | This value specifies whether the item is disabled. The default value is False. |
| DisableEventHandlers | Boolean | false | This value specifies whether the event handlers for this task, container, or package should be prevented from executing. The default value is False. |
| DropObjectsFirst | Boolean | False | This value specifies whether objects selected for transfer are removed from the destination before the transfer begins. |
| ExecutionValueVariableName | AstVariableBaseNode | Specifies a variable to hold the execution results of this component. This references an existing definiton. | |
| ExistingData | TransferSqlServerObjectTaskExistingDataOption | Replace | This value specifies whether data copied from the source overwrites existing data in the destination database or is appended to the existing data. |
| FailPackageOnFailure | Boolean | false | 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 | Boolean | false | This value determines whether the parent container will fail when a child container failes. The default value is False. |
| ForcedExecutionValue | String | "0" | 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. |
| ForcedExecutionValueDataType | TypeCode | Int32 | This property specifies the data type of the value stored in the ForceExecutionValue property. |
| ForceExecutionResult | ForceExecutionResult | None | 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 | Boolean | false | 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. |
| GenerateScriptsInUnicode | Boolean | False | This value specifies whether data copied from the source overwrites existing data in the destination database or is appended to the existing data. |
| Id | Guid | 00000000-0000-0000-0000-000000000000 | Allows the developer to specify a unique identifier (GUID) for the package. This can be used to retain a consistent ID between builds. |
| IncludeDependentObjects | Boolean | False | This value specifies whether dependent objects are copied. |
| IncludeExtendedProperties | Boolean | False | This value specifies whether extended properties are copied. |
| IsolationLevel | IsolationLevel | Serializable | Sets the Isolation Level which controls how Transactions behave for this container. |
| Language | Language | Inherited | This specifies the default language to be used by this task and its descendants. |
| LoggingMode | LoggingMode | Inherit | This value specifies whether logging is enabled or disabled by the container or by the parent container. The default value is UseParentSetting. |
| MaxErrorCount | Int32 | 1 | This value specifies the maximum number of errors allowed to occur before a package is forced to stop running. The default value is 1. |
| SourceTranslateChar | Boolean | False | 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. |
| TransactionMode | ContainerTransactionMode | Join | This value specifies the transaction context in which this task will execute. |
| UseCollation | Boolean | False | 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. |
Singleton Children
| Child | API Type | Description |
|---|---|---|
| <PrecedenceConstraints /> | AstTaskflowPrecedenceConstraintsNode | The AstTaskflowPrecedenceConstraintsNode type corresponds directly to a precedence constraint in a SQL Server Integration Services task control flow. |
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. |
| <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. |
| <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. |
| <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. |
| <LogEvents> <LogEvent /> </LogEvents> | AstLogEventNode | This is a container for log event definitions that are specific to this task, container, or package. |
| <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. |
| <LogProviders> Multiple Choices... </LogProviders> | AstLogProviderBaseNode | Defines the log providers to use for the SSIS task or container This is a container for log provider definitions that are specific to this task, container, or package. |
| <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. |
| <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. |
| <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. |
| <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. |
| <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. |
| <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. |
| <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. |
| <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. |
| <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. |
| <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. |
| <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. |
| <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. |
| <Variables> <Variable /> </Variables> | AstVariableNode | This is a container for variable definitions that are specific to this task, container, or package. |
| <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. |
| <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. |