Transfer Master Stored Procedures Task

Applies to: SQL Server SSIS Integration Runtime in Azure Data Factory

The Transfer Master Stored Procedures task transfers one or more user-defined stored procedures between master databases on instances of SQL Server. To transfer a stored procedure from the master database, the owner of the procedure must be dbo.

The Transfer Master Stored Procedures task can be configured to transfer all stored procedures or only specified stored procedures. This task does not copy system stored procedures.

The master stored procedures to be transferred may already exist on the destination. The Transfer Master Stored Procedures task can be configured to handle existing stored procedures in the following ways:

• Overwrite existing stored procedures.

• Fail the task when duplicate stored procedures exist.

• Skip duplicate stored procedures.

At run time, the Transfer Master Stored Procedures task connects to the source and destination servers by using two SMO connection managers. The SMO connection managers are configured separately from the Transfer Master Stored Procedures task, and then referenced in the Transfer Master Stored Procedures task. The SMO connection managers specify the server and the authentication mode to use when accessing the server. For more information, see SMO Connection Manager.

Transferring Stored Procedures Between Instances of SQL Server

The Transfer Master Stored Procedures task supports a SQL Server source and destination.

Events

The task raises an information event that reports the number of stored procedures transferred and a warning event when a stored procedure is overwritten.

The Transfer Master Stored Procedures task does not report incremental progress of the login transfer; it reports only 0% and 100 % completion.

Execution Value

The execution value, defined in the ExecutionValue property of the task, returns the number of stored procedures transferred. By assigning a user-defined variable to the ExecValueVariable property of the Transfer Master Stored Procedures task, information about the stored procedure transfer can be made available to other objects in the package. For more information, see Integration Services (SSIS) Variables and Use Variables in Packages.

Log Entries

The Transfer Master Stored Procedures task includes the following custom log entries:

• TransferStoredProceduresTaskStartTransferringObjects This log entry reports that the transfer has started. The log entry includes the start time.

• TransferSStoredProceduresTaskFinishedTransferringObjects This log entry reports that the transfer has finished. The log entry includes the end time.

In addition, a log entry for the OnInformation event reports the number of stored procedures that were transferred, and a log entry for the OnWarning event is written for each stored procedure on the destination that is overwritten.

Security and Permissions

The user must have permission to view the list of stored procedure in the master database on the source, and must be a member of the sysadmin server role or have permission to created stored procedures in the master database on the destination server.

Configuration of the Transfer Master Stored Procedures Task

You can set properties through SSIS Designer or programmatically.

For information about the properties that you can set in SSIS Designer, click the following topic:

• Expressions Page

For information about programmatically setting these properties, click the following topic:

• TransferStoredProceduresTask

Configuring the Transfer Master Stored Procedures Task Programmatically

Related Tasks

For more information about how to set these properties in SSIS Designer, click the following topic:

• Set the Properties of a Task or Container

Transfer Master Stored Procedures Task Editor (General Page)

Use the General page of the Transfer Master Stored Procedures Task Editor dialog box to name and describe the Transfer Master Stored Procedures task.

Options

Name
Type a unique name for the Transfer Master Stored Procedures task. This name is used as the label in the task icon.

Description
Type a description of the Transfer Master Stored Procedures task.

Transfer Master Stored Procedures Task Editor (Stored Procedures Page)

Use the Stored Procedures page of the Transfer Master Stored Procedures Task Editor dialog box to specify properties for copying one or more user-defined stored procedures from the master database in one instance of SQL Server instance to a master database in another instance of SQL Server.

Options

SourceConnection
Select a SMO connection manager in the list, or click <New connection...> to create a new connection to the source server.

DestinationConnection
Select a SMO connection manager in the list, or click <New connection...> to create a new connection to the destination server.

IfObjectExists
Select how the task should handle user-defined stored procedures of the same name that already exist in the master database on the destination server.

This property has the options listed in the following table:

TransferAllStoredProcedures
Select whether all user-defined stored procedures in the master database on the source server should be copied to the destination server.

StoredProceduresList
Select which user-defined stored procedures in the master database on the source server should be copied to the destination master database. This option is only available when TransferAllStoredProcedures is set to False.

See Also

Transfer SQL Server Objects Task
Integration Services Tasks
Control Flow