Export (0) Print
Expand All

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.

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

public class Transfer : DataTransferBase, ITransferMetadataProvider

The Transfer type exposes the following members.

  NameDescription
Public methodTransfer()Initializes a new instance of the Transfer class.
Public methodTransfer(Database)Initializes a new instance of the Transfer class that uses the specified database as the source of the transfer operation.
Top

  NameDescription
Public propertyBatchSizeGets or sets the batch size property.
Public propertyBulkCopyTimeoutGets or sets the operation to complete before it times out.
Public propertyCopyAllDatabaseTriggersGets 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 propertyCopyAllDefaultsGets 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 propertyCopyAllFullTextCatalogsGets 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 propertyCopyAllFullTextStopListsGets 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 propertyCopyAllLoginsGets 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 propertyCopyAllObjectsGets 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 propertyCopyAllPartitionFunctionsGets 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 propertyCopyAllPartitionSchemesGets 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 propertyCopyAllPlanGuidesGets 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 propertyCopyAllRolesGets 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 propertyCopyAllRulesGets 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 propertyCopyAllSchemasGets 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 propertyCopyAllSearchPropertyListsGets 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 propertyCopyAllSequencesGets 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 propertyCopyAllSqlAssembliesGets 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 propertyCopyAllStoredProceduresGets 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 propertyCopyAllSynonymsGets 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 propertyCopyAllTablesGets 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 propertyCopyAllUserDefinedAggregatesGets 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 propertyCopyAllUserDefinedDataTypesGets 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 propertyCopyAllUserDefinedFunctionsGets 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 propertyCopyAllUserDefinedTableTypesGets 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 propertyCopyAllUserDefinedTypesGets 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 propertyCopyAllUsersGets 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 propertyCopyAllViewsGets 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 propertyCopyAllXmlSchemaCollectionsGets 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 propertyCopyDataGets 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 propertyCopySchemaGets 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 propertyCreateTargetDatabaseGets or sets a value that indicates whether the target database is created in the transfer operation. (Inherited from TransferBase.)
Public propertyDatabaseGets or sets the database from which schema or data is to be transferred to the target location. (Inherited from TransferBase.)
Public propertyDatabaseFileMappingsGets or sets the properties that are associated with flat file destination based on a dictionary. (Inherited from TransferBase.)
Public propertyDestinationDatabaseGets or sets the database that is the destination of the transfer operation. (Inherited from TransferBase.)
Public propertyDestinationLoginGets or sets the logon for the instance of SQL Server to which the destination database belongs. (Inherited from TransferBase.)
Public propertyDestinationLoginSecureGets 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 propertyDestinationPasswordGets or sets the logon password for the instance of SQL Server to which the destination database belongs. (Inherited from TransferBase.)
Public propertyDestinationServerGets or sets the instance of SQL Server that owns the database that is the destination of the transfer operation. (Inherited from TransferBase.)
Public propertyDestinationTranslateCharGets or sets a value that indicates whether the transfer operation translates the code page for characters on the destination database. (Inherited from TransferBase.)
Public propertyDropDestinationObjectsFirstGets or sets a value that indicates whether to drop the objects in the destination database before the transfer operation. (Inherited from TransferBase.)
Public propertyObjectListGets or sets the objects copied from the source to destination in the transfer operation. (Inherited from TransferBase.)
Public propertyOptionsGets or sets the options for the transfer operation. (Inherited from TransferBase.)
Public propertyPrefetchObjectsGets or sets a value that indicates whether to prefetch the objects before the transfer operation. (Inherited from TransferBase.)
Public propertyPreserveDboGets or sets a value that indicates whether DBO ownerships are retained through the transfer process. (Inherited from TransferBase.)
Public propertyPreserveLoginsGets or sets a value that indicates whether to preserve logins in the transfer operation. (Inherited from TransferBase.)
Protected propertyScripterGets the scripter for the transfer operation. (Inherited from TransferBase.)
Public propertySourceTranslateCharGets or sets a value that indicates whether the transfer operation translates the code page for characters on the source database. (Inherited from TransferBase.)
Public propertyTargetDatabaseFilePathGets or sets the path to where the database files will be copied. (Inherited from TransferBase.)
Public propertyTargetLogFilePathGets or sets the path to where the log files will be copied. (Inherited from TransferBase.)
Public propertyTemporaryPackageDirectoryFor internal use only. The value of this property is ignored if set by a caller.
Public propertyUseDestinationTransactionGets or sets a value that indicates whether to use the destination transaction. (Inherited from TransferBase.)
Top

  NameDescription
Public methodEnumObjectsReturns an enumerated list of Uniform Resource Name (URN) values that represent the objects included in the transfer operation. (Inherited from TransferBase.)
Public methodEnumScriptTransferCreates a Transact-SQL command batch script used to transfer database objects or database objects and data to another database instance. (Inherited from TransferBase.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetTransferProviderFor internal use only. Throws a System.NotSupportedException if invoked by a caller.
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodStatic memberProcessDependencyChainReturns a URN array with options.
Public methodScriptTransferCreates a Transact-SQL command batch script that creates database objects that are transferred by the transfer operation. (Inherited from TransferBase.)
Protected methodSetTargetServerInfoSets the target server version based on the SQL Server version. (Inherited from TransferBase.)
Public methodToString (Inherited from Object.)
Public methodTransferDataTransfers data as specified by the Transfer object.
Top

  NameDescription
Public eventDataTransferEventReports that data has been transferred.
Public eventDiscoveryProgressMarks the progress of the discovery process. (Inherited from TransferBase.)
Public eventScriptingErrorReports that an error occurred during the scripting process. (Inherited from TransferBase.)
Public eventScriptingProgressMarks the progress of the scripting process. (Inherited from TransferBase.)
Top

  NameDescription
Explicit interface implemetationPrivate methodITransferMetadataProviderGetOptionsThe ITransferMetadataProvider class represents an interface that implements the transfer metadata process on the referenced connection.
Explicit interface implemetationPrivate methodITransferMetadataProviderSaveMetadataSaves metadata when transferring databases across instances.
Top

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.  

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft