Transfer Class
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 | |
---|---|---|
Transfer() | Initializes a new instance of the Transfer class. | |
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 | |
---|---|---|
BatchSize | Gets or sets the batch size property. | |
BulkCopyTimeout | Gets or sets the operation to complete before it times out. | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
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.) | |
CreateTargetDatabase | Gets or sets a value that indicates whether the target database is created in the transfer operation. (Inherited from TransferBase.) | |
Database | Gets or sets the database from which schema or data is to be transferred to the target location. (Inherited from TransferBase.) | |
DatabaseFileMappings | Gets or sets the properties that are associated with flat file destination based on a dictionary. (Inherited from TransferBase.) | |
DestinationDatabase | Gets or sets the database that is the destination of the transfer operation. (Inherited from TransferBase.) | |
DestinationLogin | Gets or sets the logon for the instance of SQL Server to which the destination database belongs. (Inherited from TransferBase.) | |
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.) | |
DestinationPassword | Gets or sets the logon password for the instance of SQL Server to which the destination database belongs. (Inherited from TransferBase.) | |
DestinationServer | Gets or sets the instance of SQL Server that owns the database that is the destination of the transfer operation. (Inherited from TransferBase.) | |
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.) | |
DropDestinationObjectsFirst | Gets or sets a value that indicates whether to drop the objects in the destination database before the transfer operation. (Inherited from TransferBase.) | |
ObjectList | Gets or sets the objects copied from the source to destination in the transfer operation. (Inherited from TransferBase.) | |
Options | Gets or sets the options for the transfer operation. (Inherited from TransferBase.) | |
PrefetchObjects | Gets or sets a value that indicates whether to prefetch the objects before the transfer operation. (Inherited from TransferBase.) | |
PreserveDbo | Gets or sets a value that indicates whether DBO ownerships are retained through the transfer process. (Inherited from TransferBase.) | |
PreserveLogins | Gets or sets a value that indicates whether to preserve logins in the transfer operation. (Inherited from TransferBase.) | |
Scripter | Gets the scripter for the transfer operation. (Inherited from TransferBase.) | |
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.) | |
TargetDatabaseFilePath | Gets or sets the path to where the database files will be copied. (Inherited from TransferBase.) | |
TargetLogFilePath | Gets or sets the path to where the log files will be copied. (Inherited from TransferBase.) | |
TemporaryPackageDirectory | For internal use only. The value of this property is ignored if set by a caller. | |
UseDestinationTransaction | Gets or sets a value that indicates whether to use the destination transaction. (Inherited from TransferBase.) |
Top
Methods
Name | Description | |
---|---|---|
EnumObjects | Returns an enumerated list of Uniform Resource Name (URN) values that represent the objects included in the transfer operation. (Inherited from TransferBase.) | |
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.) | |
Equals | (Inherited from Object.) | |
Finalize | (Inherited from Object.) | |
GetHashCode | (Inherited from Object.) | |
GetTransferProvider | For internal use only. Throws a System.NotSupportedException if invoked by a caller. | |
GetType | (Inherited from Object.) | |
MemberwiseClone | (Inherited from Object.) | |
ProcessDependencyChain | Returns a URN array with options. | |
ScriptTransfer | Creates a Transact-SQL command batch script that creates database objects that are transferred by the transfer operation. (Inherited from TransferBase.) | |
SetTargetServerInfo | Sets the target server version based on the SQL Server version. (Inherited from TransferBase.) | |
ToString | (Inherited from Object.) | |
TransferData | Transfers data as specified by the Transfer object. |
Top
Events
Name | Description | |
---|---|---|
DataTransferEvent | Reports that data has been transferred. | |
DiscoveryProgress | Marks the progress of the discovery process. (Inherited from TransferBase.) | |
ScriptingError | Reports that an error occurred during the scripting process. (Inherited from TransferBase.) | |
ScriptingProgress | Marks the progress of the scripting process. (Inherited from TransferBase.) |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
ITransferMetadataProvider.GetOptions | The ITransferMetadataProvider class represents an interface that implements the transfer metadata process on the referenced connection. | |
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
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.