TransferSqlServerObjectsTask Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Contains the methods and properties that allow you to copy various SQL Server objects from one server to another. This class cannot be inherited.
public ref class TransferSqlServerObjectsTask sealed : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist, Microsoft::SqlServer::Dts::Tasks::TransferSqlServerObjectsTask::ITransferSqlServerObjectsTask[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.transfersqlserverobjectstask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.TransferSqlServerObjectsTask.Localized), SamplesTag="SsisTransferSqlServerObjectsTask", TaskContact="Transfer Objects Task; Microsoft Corporation; SQL Server 2016; (c) Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.TransferSqlServerObjectsTaskUI.TransferSqlServerObjectsTaskUI, Microsoft.SqlServer.TransferSqlServerObjectsTaskUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("D68202B5-1E2C-4A8F-B63E-64B2DB3F9280")]
public sealed class TransferSqlServerObjectsTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.TransferSqlServerObjectsTask.ITransferSqlServerObjectsTask[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.transfersqlserverobjectstask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.TransferSqlServerObjectsTask.Localized), SamplesTag="SsisTransferSqlServerObjectsTask", TaskContact="Transfer Objects Task; Microsoft Corporation; SQL Server 2017; (c) Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.TransferSqlServerObjectsTaskUI.TransferSqlServerObjectsTaskUI, Microsoft.SqlServer.TransferSqlServerObjectsTaskUI, Version=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("6D7760F0-F3E4-4C1B-BBDC-A68A3AAAF6B2")]
public sealed class TransferSqlServerObjectsTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.TransferSqlServerObjectsTask.ITransferSqlServerObjectsTask[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.transfersqlserverobjectstask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.TransferSqlServerObjectsTask.Localized), SamplesTag="SsisTransferSqlServerObjectsTask", TaskContact="Transfer Objects Task; Microsoft Corporation; SQL Server 2019; (c) Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.TransferSqlServerObjectsTaskUI.TransferSqlServerObjectsTaskUI, Microsoft.SqlServer.TransferSqlServerObjectsTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("8E6F94C4-8098-4835-9948-AD10F9191B44")]
public sealed class TransferSqlServerObjectsTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.TransferSqlServerObjectsTask.ITransferSqlServerObjectsTask[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.transfersqlserverobjectstask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.TransferSqlServerObjectsTask.Localized), SamplesTag="SsisTransferSqlServerObjectsTask", TaskContact="Transfer Objects Task; Microsoft Corporation; SQL Server 2016; (c) Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.TransferSqlServerObjectsTaskUI.TransferSqlServerObjectsTaskUI, Microsoft.SqlServer.TransferSqlServerObjectsTaskUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("D68202B5-1E2C-4A8F-B63E-64B2DB3F9280")>]
type TransferSqlServerObjectsTask = class
inherit Task
interface ITransferSqlServerObjectsTask
interface IDTSBreakpointSite
interface IDTSSuspend
interface IDTSComponentPersist[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.transfersqlserverobjectstask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.TransferSqlServerObjectsTask.Localized), SamplesTag="SsisTransferSqlServerObjectsTask", TaskContact="Transfer Objects Task; Microsoft Corporation; SQL Server 2017; (c) Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.TransferSqlServerObjectsTaskUI.TransferSqlServerObjectsTaskUI, Microsoft.SqlServer.TransferSqlServerObjectsTaskUI, Version=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("6D7760F0-F3E4-4C1B-BBDC-A68A3AAAF6B2")>]
type TransferSqlServerObjectsTask = class
inherit Task
interface ITransferSqlServerObjectsTask
interface IDTSBreakpointSite
interface IDTSSuspend
interface IDTSComponentPersist[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.transfersqlserverobjectstask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.TransferSqlServerObjectsTask.Localized), SamplesTag="SsisTransferSqlServerObjectsTask", TaskContact="Transfer Objects Task; Microsoft Corporation; SQL Server 2019; (c) Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.TransferSqlServerObjectsTaskUI.TransferSqlServerObjectsTaskUI, Microsoft.SqlServer.TransferSqlServerObjectsTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("8E6F94C4-8098-4835-9948-AD10F9191B44")>]
type TransferSqlServerObjectsTask = class
inherit Task
interface ITransferSqlServerObjectsTask
interface IDTSBreakpointSite
interface IDTSSuspend
interface IDTSComponentPersistPublic NotInheritable Class TransferSqlServerObjectsTask
Inherits Task
Implements IDTSBreakpointSite, IDTSComponentPersist, ITransferSqlServerObjectsTask- Inheritance
- Attributes
- Implements
Constructors
| TransferSqlServerObjectsTask() |
Initializes a new instance of the TransferSqlServerObjectsTask class. |
Properties
| CopyAllDefaults |
Gets or sets a Boolean indicating that the transfer includes the SQL Server defaults. |
| CopyAllDRIObjects |
Gets or sets a value that indicates whether the task copies all objects that are related to declarative referential integrity (DRI). |
| CopyAllLogins |
Obsolete.
Gets or sets a Boolean indicating whether all the SQL Server logins are copied from the source database to the target database in the transfer operation, or only the specified logins. |
| CopyAllObjects |
Gets or sets a Boolean indicating whether all SQL Server database objects are transferred from the source to the target database, or only the specified objects. The following SQL Server database objects can be transferred: defaults, rules, stored procedures, tables, triggers, user-defined data types, and views. |
| CopyAllPartitionFunctions |
Gets or sets a Boolean indicating whether all SQL Server partitions are transferred from the source to the target database, or only the specified partitions. |
| CopyAllPartitionSchemes |
Gets or sets a Boolean indicating whether all SQL Server partition schemes are transferred from the source to the target database, or only the specified partition schemes. |
| CopyAllRules |
Gets or sets a Boolean indicating whether all SQL Server rules are transferred from the source to the target database, or only the specified rules. |
| CopyAllSchemas |
Gets or sets a Boolean indicating whether all SQL Server schemas are transferred from the source to the target database, or only the specified schemas. |
| CopyAllSqlAssemblies |
Gets or sets a Boolean indicating whether all SQL Server assemblies are transferred from the source to the target database, or only the specified assemblies. |
| CopyAllStoredProcedures |
Gets or sets a Boolean indicating whether all SQL Server stored procedures are transferred from the source to the target database, or only the specified stored procedures. |
| CopyAllTables |
Gets or sets a Boolean indicating whether all SQL Server tables are transferred from the source to the target database, or only the specified tables. |
| CopyAllUserDefinedAggregates |
Gets or sets a Boolean indicating whether all user-defined aggregates are transferred from the source to the target database, or only the specified user-defined aggregates. |
| CopyAllUserDefinedDataTypes |
Gets or sets a Boolean indicating whether all user-defined data types are transferred from the source to the target database, or only the specified user-defined data types. |
| CopyAllUserDefinedFunctions |
Gets or sets a Boolean indicating whether all user-defined functions are transferred from the source to the target database, or only the specified user-defined functions. |
| CopyAllUserDefinedTypes |
Gets or sets a Boolean indicating whether all user-defined types are transferred from the source to the target database, or only the specified user-defined types. |
| CopyAllUsers |
Obsolete.
Gets or sets a Boolean indicating whether all the SQL Server database users are copied from the source database to the target database, or only the specified users. |
| CopyAllViews |
Gets or sets a Boolean indicating whether all SQL Server views are transferred from the source to the target database, or only the specified views. |
| CopyAllXmlSchemaCollections |
Gets or sets a Boolean indicating whether all XML schema collections are transferred from the source to the target database, or only the specified XML schema collections. |
| CopyData |
Gets or sets a Boolean indicating whether data is included as part of the transfer of tables and views from the SQL Server source to the target database. |
| CopyDatabaseRoles |
Gets or sets a Boolean indicating whether database roles are transferred from the source to the target database. |
| CopyDatabaseUsers |
Gets or sets a Boolean indicating whether database users are transferred from the source to the target database. |
| CopyForeignKeys |
Gets or sets a Boolean indicating whether foreign keys are transferred from the source to the target database. |
| CopyFullTextIndexes |
Gets or sets a Boolean indicating whether full-text properties are transferred from the source to the target database. |
| CopyIndexes |
Gets or sets a Boolean indicating whether indexes are transferred from the source to the target database. |
| CopyObjectLevelPermissions |
Gets or sets a Boolean indicating whether securable objects are included in the transfer from the source to the target database. |
| CopyPrimaryKeys |
Gets or sets a Boolean indicating whether primary keys are transferred from the source to the target database. |
| CopySchema |
Gets or sets a Boolean that specifies whether the schema is copied in the transfer operation. This property is only available for SQL Server 2005 or later versions. |
| CopySqlServerLogins |
Gets or sets a Boolean indicating whether SQL Server logins are included in the transfer from the source to the target database. |
| CopyTriggers |
Gets or sets a Boolean indicating whether triggers are included in the transfer from the source to the target database. |
| DebugMode |
Gets or sets a Boolean that indicates whether a task should determine whether breakpoints are enabled. |
| DefaultsList |
Gets or sets a StringCollection containing the default objects to transfer when the CopyAllDefaults is set to false. |
| DestinationConnection |
Gets or sets a String containing the name of the SMO connection manager for the destination database. |
| DestinationDatabase |
Gets or sets a String containing the name of the destination database. |
| DestinationTranslateChar |
Gets or sets a Boolean indicating the value of AutoTranslate in the OLE DB destination connection string. |
| DropObjectsFirst |
Gets or sets a Boolean that indicates whether the objects that have been selected for transfer from the source are dropped first on the destination server before the transfer begins. |
| ExecutionValue |
Returns an object containing the count of the number of objects transferred. |
| ExistingData |
Gets or sets a value from the ExistingData enumeration to determine whether data should be appended to existing data, or have the existing data replaced by being overwritten. |
| GenerateScriptsInUnicode |
Gets or sets a Boolean that indicates whether the script generated is in Unicode format. |
| IncludeDependentObjects |
Gets or sets a Boolean that indicates whether the dependent objects are included in the transfer. |
| IncludeExtendedProperties |
Gets or sets a Boolean indicating whether extended properties are transferred from the source to the target database. |
| LoginsList |
Gets or sets a StringCollection containing the SQL Server logins to transfer from the source database to the destination database when CopyAllLogins is false. |
| PartitionFunctionsList |
Gets or sets a StringCollection containing the partition functions to transfer from the source database to the destination database when the CopyAllPartitionFunctions is false. |
| PartitionSchemesList |
Gets or sets a StringCollection containing the partition schemes to transfer from the source database to the destination database when CopyAllPartitionSchemes is false. |
| RulesList |
Gets or sets a StringCollection containing the rules to transfer from the source database to the destination database when CopyAllRules is false. |
| SchemasList |
Gets or sets a StringCollection containing the list of schemas to transfer from the source database to the destination database when CopyAllSchemas is false. |
| SourceConnection |
Gets or sets a String containing the name of the SMO connection manager for the source database. |
| SourceDatabase |
Gets or sets a String containing the name of the database from which objects will be transferred. |
| SourceTranslateChar |
Gets or sets a Boolean indicating the value of AutoTranslate in the OLE DB source connection string. |
| SqlAssembliesList |
Gets or sets a StringCollection listing the SQL Server assemblies to transfer when CopyAllSqlAssemblies is false. |
| StoredProceduresList |
Gets or sets a StringCollection listing the stored procedures to transfer when CopyAllStoredProcedures is false. |
| SuspendRequired |
Gets or sets a Boolean that indicates whether tasks should suspend when they encounter a breakpoint. This value is set by the run-time engine for tasks and containers when a breakpoint is encountered. |
| TablesList |
Gets or sets a StringCollection listing the tables to transfer when CopyAllTables is false. |
| TargetServerVersion | (Inherited from Task) |
| UseCollation |
Gets or sets a Boolean indicating whether the transfer should use collations. |
| UserDefinedAggregatesList |
Gets or sets a StringCollection listing the user-defined aggregates to transfer when CopyAllUserDefinedAggregates is false. |
| UserDefinedDataTypesList |
Gets or sets a StringCollection listing the user-defined data types to transfer when CopyAllUserDefinedDataTypes is false. |
| UserDefinedFunctionsList |
Gets or sets a StringCollection listing the user-defined functions to transfer when CopyAllUserDefinedFunctions is false. |
| UserDefinedTypesList |
Gets or sets a StringCollection listing the user-defined types to transfer when CopyAllUserDefinedTypes is false. |
| UsersList |
Gets or sets a StringCollection containing the SQL Server database users to transfer from the source database to the destination database when CopyAllUsers is false. |
| Version |
*** Member deprecated; see Remarks. *** Returns the version of the task. This property is read-only. (Inherited from Task) |
| ViewsList |
Gets or sets a StringCollection listing the views to transfer when CopyAllViews is false. |
| XmlSchemaCollectionsList |
Gets or sets a StringCollection listing the XML schema collections to transfer when CopyAllXmlSchemaCollections is false. |
Methods
| AcceptBreakpointManager(BreakpointManager) |
Passes a BreakpointManager to a task. This method is called by the runtime and is not used in code. |
| CanUpdate(String) |
*** Member deprecated; see Remarks. *** A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task) |
| Equals(Object) |
Determines whether two object instances are equal. (Inherited from DtsObject) |
| Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object) |
Runs the task. |
| GetConnectionID(Connections, String) |
Gets a String containing the ID of the connection. (Inherited from Task) |
| GetConnectionName(Connections, String) |
Gets a String containing the name of the connection. (Inherited from Task) |
| GetHashCode() |
Returns the hash code for this instance. (Inherited from DtsObject) |
| InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker) |
Initializes the properties associated with the task. This method is called by the runtime and is not used in code. |
| LoadFromXML(XmlElement, IDTSInfoEvents) |
This method is not callable by your application code. To load a package saved as .xml, use the LoadPackage(String, IDTSEvents) method. |
| ResumeExecution() |
Resumes execution of the task after pausing. The task or container is resumed by the run-time engine. |
| SaveToXML(XmlDocument, IDTSInfoEvents) |
This method is not callable by your application code. To save a package as .xml, use the SaveToXml(String, Package, IDTSEvents) method. |
| SuspendExecution() |
Indicates that the executable needs to suspend. This method is called by the run-time engine. |
| Update(String) |
*** Member deprecated; see Remarks. *** This method updates the old package XML with the new package XML if CanUpdate(String) is set to true. (Inherited from Task) |
| Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging) |
Verifies that the task is properly configured. |