Share via


TransferSqlServerObjectsTask Class

Contains the methods and properties that allow you to copy various SQL Server objects from one server to another. This class cannot be inherited.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Task
      Microsoft.SqlServer.Dts.Tasks.TransferSqlServerObjectsTask.TransferSqlServerObjectsTask

Namespace:  Microsoft.SqlServer.Dts.Tasks.TransferSqlServerObjectsTask
Assembly:  Microsoft.SqlServer.TransferSqlServerObjectsTask (in Microsoft.SqlServer.TransferSqlServerObjectsTask.dll)

Syntax

'Declaration
<GuidAttribute("DB493BD0-194A-47BA-8084-511537354DD4")> _
Public NotInheritable Class TransferSqlServerObjectsTask _
    Inherits Task _
    Implements ITransferSqlServerObjectsTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
'Usage
Dim instance As TransferSqlServerObjectsTask
[GuidAttribute("DB493BD0-194A-47BA-8084-511537354DD4")]
public sealed class TransferSqlServerObjectsTask : Task, 
    ITransferSqlServerObjectsTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
[GuidAttribute(L"DB493BD0-194A-47BA-8084-511537354DD4")]
public ref class TransferSqlServerObjectsTask sealed : public Task, 
    ITransferSqlServerObjectsTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
[<SealedAttribute>]
[<GuidAttribute("DB493BD0-194A-47BA-8084-511537354DD4")>]
type TransferSqlServerObjectsTask =  
    class 
        inherit Task 
        interface ITransferSqlServerObjectsTask 
        interface IDTSBreakpointSite 
        interface IDTSSuspend 
        interface IDTSComponentPersist 
    end
public final class TransferSqlServerObjectsTask extends Task implements ITransferSqlServerObjectsTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

The TransferSqlServerObjectsTask type exposes the following members.

Constructors

  Name Description
Public method TransferSqlServerObjectsTask Initializes a new instance of the TransferSqlServerObjectsTask class.

Top

Properties

  Name Description
Public property CopyAllDefaults Gets or sets a Boolean indicating that the transfer includes the SQL Server defaults.
Public property CopyAllDRIObjects Gets or sets a value that indicates whether the task copies all objects that are related to declarative referential integrity (DRI).
Public property 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.
Public property 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.
Public property 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.
Public property 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.
Public property 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.
Public property 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.
Public property 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.
Public property 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.
Public property 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.
Public property 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.
Public property 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.
Public property 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.
Public property 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.
Public property 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.
Public property 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.
Public property 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.
Public property 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.
Public property CopyDatabaseRoles Gets or sets a Boolean indicating whether database roles are transferred from the source to the target database.
Public property CopyDatabaseUsers Gets or sets a Boolean indicating whether database users are transferred from the source to the target database.
Public property CopyForeignKeys Gets or sets a Boolean indicating whether foreign keys are transferred from the source to the target database.
Public property CopyFullTextIndexes Gets or sets a Boolean indicating whether full-text properties are transferred from the source to the target database.
Public property CopyIndexes Gets or sets a Boolean indicating whether indexes are transferred from the source to the target database.
Public property CopyObjectLevelPermissions Gets or sets a Boolean indicating whether securable objects are included in the transfer from the source to the target database.
Public property CopyPrimaryKeys Gets or sets a Boolean indicating whether primary keys are transferred from the source to the target database.
Public property 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.
Public property CopySqlServerLogins Gets or sets a Boolean indicating whether SQL Server logins are included in the transfer from the source to the target database.
Public property CopyTriggers Gets or sets a Boolean indicating whether triggers are included in the transfer from the source to the target database.
Public property DebugMode Gets or sets a Boolean that indicates whether a task should determine whether breakpoints are enabled.
Public property DefaultsList Gets or sets a StringCollection containing the default objects to transfer when the CopyAllDefaults is set to false.
Public property DestinationConnection Gets or sets a String containing the name of the SMO connection manager for the destination database.
Public property DestinationDatabase Gets or sets a String containing the name of the destination database.
Public property DestinationTranslateChar Gets or sets a Boolean indicating the value of AutoTranslate in the OLE DB destination connection string.
Public property 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.
Public property ExecutionValue Returns an object containing the count of the number of objects transferred. (Overrides Task.ExecutionValue.)
Public property 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.
Public property GenerateScriptsInUnicode Gets or sets a Boolean that indicates whether the script generated is in Unicode format.
Public property IncludeDependentObjects Gets or sets a Boolean that indicates whether the dependent objects are included in the transfer.
Public property IncludeExtendedProperties Gets or sets a Boolean indicating whether extended properties are transferred from the source to the target database.
Public property 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.
Public property 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.
Public property PartitionSchemesList Gets or sets a StringCollection containing the partition schemes to transfer from the source database to the destination database when CopyAllPartitionSchemes is false.
Public property RulesList Gets or sets a StringCollection containing the rules to transfer from the source database to the destination database when CopyAllRules is false.
Public property 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.
Public property SourceConnection Gets or sets a String containing the name of the SMO connection manager for the source database.
Public property SourceDatabase Gets or sets a String containing the name of the database from which objects will be transferred.
Public property SourceTranslateChar Gets or sets a Boolean indicating the value of AutoTranslate in the OLE DB source connection string.
Public property SqlAssembliesList Gets or sets a StringCollection listing the SQL Server assemblies to transfer when CopyAllSqlAssemblies is false.
Public property StoredProceduresList Gets or sets a StringCollection listing the stored procedures to transfer when CopyAllStoredProcedures is false.
Public property 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.
Public property TablesList Gets or sets a StringCollection listing the tables to transfer when CopyAllTables is false.
Public property UseCollation Gets or sets a Boolean indicating whether the transfer should use collations.
Public property UserDefinedAggregatesList Gets or sets a StringCollection listing the user-defined aggregates to transfer when CopyAllUserDefinedAggregates is false.
Public property UserDefinedDataTypesList Gets or sets a StringCollection listing the user-defined data types to transfer when CopyAllUserDefinedDataTypes is false.
Public property UserDefinedFunctionsList Gets or sets a StringCollection listing the user-defined functions to transfer when CopyAllUserDefinedFunctions is false.
Public property UserDefinedTypesList Gets or sets a StringCollection listing the user-defined types to transfer when CopyAllUserDefinedTypes is false.
Public property 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.
Public property Version *** Member deprecated; see Remarks. ***    Returns the version of the task. This property is read-only. (Inherited from Task.)
Public property ViewsList Gets or sets a StringCollection listing the views to transfer when CopyAllViews is false.
Public property XmlSchemaCollectionsList Gets or sets a StringCollection listing the XML schema collections to transfer when CopyAllXmlSchemaCollections is false.

Top

Methods

  Name Description
Public method AcceptBreakpointManager Passes a BreakpointManager to a task. This method is called by the runtime and is not used in code.
Public method CanUpdate *** Member deprecated; see Remarks. ***    A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task.)
Public method Equals Determines whether two object instances are equal. (Inherited from DtsObject.)
Public method Execute Runs the task. (Overrides Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
Public method GetConnectionID Gets a String containing the ID of the connection. (Inherited from Task.)
Public method GetConnectionName Gets a String containing the name of the connection. (Inherited from Task.)
Public method GetHashCode Returns the hash code for this instance. (Inherited from DtsObject.)
Public method GetType (Inherited from Object.)
Public method InitializeTask Initializes the properties associated with the task. This method is called by the runtime and is not used in code. (Overrides Task.InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker).)
Public method LoadFromXML This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
Public method ResumeExecution Resumes execution of the task after pausing. The task or container is resumed by the run-time engine.
Public method SaveToXML This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Public method SuspendExecution Indicates that the executable needs to suspend. This method is called by the run-time engine.
Public method ToString (Inherited from Object.)
Public method Update *** Member deprecated; see Remarks. ***    This method updates the old package XML with the new package XML if CanUpdate is set to true. (Inherited from Task.)
Public method Validate Verifies that the task is properly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Dts.Tasks.TransferSqlServerObjectsTask Namespace