catalog.remove_data_tap

THIS TOPIC APPLIES TO: yesSQL Server (starting with 2012)noAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

Removes a data tap from a component output that is in an execution. The unique identifier for the data tap is associated with an instance of the execution.

Syntax

remove_data_tap [ @data_tap_id = ] data_tap_id  

Arguments

[ @data_tap_id = ] data_tap_id
The unique identifier for the data tap that is created by using the catalog.add_data_tap stored procedure. The data_tap_id is bigint.

Remarks

When a package contains more than one data flow tasks that have the same name, the data tap is added to the first data flow task with the given name.

Return Codes

0 (success)

When the stored procedure fails, it throws an error.

Result Set

None

Remarks

To remove data taps, the instance of the execution must be in the created state (a value of 1 in the status column of the catalog.operations (SSISDB Database)view) .

Permissions

This stored procedure requires one of the following permissions:

  • MODIFY permissions on the instance of execution

  • Membership to the ssis_admin database role

  • Membership to the sysadmin server role

Errors and Warnings

The following list describes conditions that cause the stored procedure to fail.

  • The user does not have MODIFY permissions.

See Also

catalog.add_data_tap
catalog.add_data_tap_by_guid