Transfer Class

  • Article

The Transfer object is a tool object that provides programmatic control over copying of schemas and data to other instances of SQL Server.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.TransferBase
    Microsoft.SqlServer.Management.Smo.DataTransferBase
      Microsoft.SqlServer.Management.Smo.Transfer

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.SmoExtended (in Microsoft.SqlServer.SmoExtended.dll)

Syntax

'Declaration
Public Class Transfer _
    Inherits DataTransferBase _
    Implements ITransferMetadataProvider
'Usage
Dim instance As Transfer

public class Transfer : DataTransferBase, ITransferMetadataProvider

public ref class Transfer : public DataTransferBase, 
    ITransferMetadataProvider

type Transfer =  
    class 
        inherit DataTransferBase 
        interface ITransferMetadataProvider 
    end

public class Transfer extends DataTransferBase implements ITransferMetadataProvider

The Transfer type exposes the following members.

Constructors

  Name Description
Public method Transfer() Initializes a new instance of the Transfer class.
Public method Transfer(Database) Initializes a new instance of the Transfer class that uses the specified database as the source of the transfer operation.

Top

Properties

  Name Description
Public property BatchSize Gets or sets the batch size property.
Public property BulkCopyTimeout Gets or sets the operation to complete before it times out.
Public property CopyAllDatabaseTriggers Gets or sets a value that indicates whether all the SQL Server database triggers are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllDefaults Gets or sets a value that indicates whether all the SQL Server defaults are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllFullTextCatalogs Gets or sets a value that indicates whether all the SQL Server full-text catalogs are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllFullTextStopLists Gets or sets a value that indicates whether all the SQL Server full-text stop lists are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllLogins Gets or sets a value that indicates whether all the SQL Server logins are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllObjects Gets or sets a value that indicates whether all the SQL Server objects are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllPartitionFunctions Gets or sets a value that indicates whether all the SQL Server partition functions are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllPartitionSchemes Gets or sets a value that indicates whether all the SQL Server partition schemes are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllPlanGuides Gets or sets a value that indicates whether all the SQL Server plan guides are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllRoles Gets or sets a value that indicates whether all the SQL Server roles are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllRules Gets or sets a value that indicates whether all the SQL Server rules are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllSchemas Gets or sets a value that indicates whether all the SQL Server schemas are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllSearchPropertyLists Gets or sets a value that indicates whether all the SQL Server search property lists are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllSequences Gets or sets a value that indicates whether all the SQL Server sequences are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllSqlAssemblies Gets or sets a value that indicates whether all the SQL Server assemblies are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllStoredProcedures Gets or sets a value that indicates whether all the SQL Server stored procedures are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllSynonyms Gets or sets a value that indicates whether all the SQL Server synonyms are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllTables Gets or sets a value that indicates whether all the SQL Server tables are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllUserDefinedAggregates Gets or sets a value that indicates whether all the SQL Server user-defined aggregates are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllUserDefinedDataTypes Gets or sets a value that indicates whether all the SQL Server user-defined data types are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllUserDefinedFunctions Gets or sets a value that indicates whether all the SQL Server user-defined functions are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllUserDefinedTableTypes Gets or sets a value that indicates whether all the SQL Server user-defined table types are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllUserDefinedTypes Gets or sets a value that indicates whether all the SQL Server user-defined types are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllUsers Gets or sets a value that indicates whether all the SQL Server database users are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllViews Gets or sets a value that indicates whether all the SQL Server views are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyAllXmlSchemaCollections Gets or sets a value that indicates whether all the SQL Server XML schema collections are copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopyData Gets or sets a value that indicates whether all the data is copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CopySchema Gets or sets a value that indicates whether the schema is copied from the source database to the target database in the transfer operation. (Inherited from TransferBase.)
Public property CreateTargetDatabase Gets or sets a value that indicates whether the target database is created in the transfer operation. (Inherited from TransferBase.)
Public property Database Gets or sets the database from which schema or data is to be transferred to the target location. (Inherited from TransferBase.)
Public property DatabaseFileMappings Gets or sets the properties that are associated with flat file destination based on a dictionary. (Inherited from TransferBase.)
Public property DestinationDatabase Gets or sets the database that is the destination of the transfer operation. (Inherited from TransferBase.)
Public property DestinationLogin Gets or sets the logon for the instance of SQL Server to which the destination database belongs. (Inherited from TransferBase.)
Public property DestinationLoginSecure Gets or sets a value that indicates whether the instance of SQL Server that contains the destination database is enabled for Windows Authentication or not. (Inherited from TransferBase.)
Public property DestinationPassword Gets or sets the logon password for the instance of SQL Server to which the destination database belongs. (Inherited from TransferBase.)
Public property DestinationServer Gets or sets the instance of SQL Server that owns the database that is the destination of the transfer operation. (Inherited from TransferBase.)
Public property DestinationTranslateChar Gets or sets a value that indicates whether the transfer operation translates the code page for characters on the destination database. (Inherited from TransferBase.)
Public property DropDestinationObjectsFirst Gets or sets a value that indicates whether to drop the objects in the destination database before the transfer operation. (Inherited from TransferBase.)
Public property ObjectList Gets or sets the objects copied from the source to destination in the transfer operation. (Inherited from TransferBase.)
Public property Options Gets or sets the options for the transfer operation. (Inherited from TransferBase.)
Public property PrefetchObjects Gets or sets a value that indicates whether to prefetch the objects before the transfer operation. (Inherited from TransferBase.)
Public property PreserveDbo Gets or sets a value that indicates whether DBO ownerships are retained through the transfer process. (Inherited from TransferBase.)
Public property PreserveLogins Gets or sets a value that indicates whether to preserve logins in the transfer operation. (Inherited from TransferBase.)
Protected property Scripter Gets the scripter for the transfer operation. (Inherited from TransferBase.)
Public property SourceTranslateChar Gets or sets a value that indicates whether the transfer operation translates the code page for characters on the source database. (Inherited from TransferBase.)
Public property TargetDatabaseFilePath Gets or sets the path to where the database files will be copied. (Inherited from TransferBase.)
Public property TargetLogFilePath Gets or sets the path to where the log files will be copied. (Inherited from TransferBase.)
Public property TemporaryPackageDirectory For internal use only. The value of this property is ignored if set by a caller.
Public property UseDestinationTransaction Gets or sets a value that indicates whether to use the destination transaction. (Inherited from TransferBase.)

Top

Methods

  Name Description
Public method EnumObjects Returns an enumerated list of Uniform Resource Name (URN) values that represent the objects included in the transfer operation. (Inherited from TransferBase.)
Public method EnumScriptTransfer Creates a Transact-SQL command batch script used to transfer database objects or database objects and data to another database instance. (Inherited from TransferBase.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetTransferProvider For internal use only. Throws a System.NotSupportedException if invoked by a caller.
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Protected methodStatic member ProcessDependencyChain Returns a URN array with options.
Public method ScriptTransfer Creates a Transact-SQL command batch script that creates database objects that are transferred by the transfer operation. (Inherited from TransferBase.)
Protected method SetTargetServerInfo Sets the target server version based on the SQL Server version. (Inherited from TransferBase.)
Public method ToString (Inherited from Object.)
Public method TransferData Transfers data as specified by the Transfer object.

Top

Events

  Name Description
Public event DataTransferEvent Reports that data has been transferred.
Public event DiscoveryProgress Marks the progress of the discovery process. (Inherited from TransferBase.)
Public event ScriptingError Reports that an error occurred during the scripting process. (Inherited from TransferBase.)
Public event ScriptingProgress Marks the progress of the scripting process. (Inherited from TransferBase.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ITransferMetadataProvider.GetOptions The ITransferMetadataProvider class represents an interface that implements the transfer metadata process on the referenced connection.
Explicit interface implemetationPrivate method ITransferMetadataProvider.SaveMetadata Saves metadata when transferring databases across instances.

Top

Remarks

The following object types cannot be transferred:

  • All broker objects

  • All mail objects

  • Endpoint

  • ServerDdlTrigger

  • ExtendedStoredProcedure

  • FullTextCatalog

  • UserDefinedMessage

  • ApplicationRole

To get and set Transfer object properties, users can be a member of the public fixed server role.

To transfer data, users can be a member of the public fixed server role.

Thread Safety

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

Examples

Transferring Data

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.Management.Smo Namespace