catalog.rename_environment (SSISDB Database)


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

Renames an environment in the Integration Services catalog.

rename_environment [ @folder_name = ] folder_name  
    , [ @environment_name = ] environment_name  
    , [ @new_environment_name= ] new_environment_name  

[ @folder_name = ] folder_name
The name of the folder that contains the environment. The folder_name is nvarchar(128).

[ @environment_name = ] environment_name
The original name of the environment. The environment_name is nvarchar(128).

[ @new_environment_name = ] new_environment_name
The new name of the environment. The new_environment_name is nvarchar(128).

0 (success)


This stored procedure requires one of the following permissions:

  • MODIFY permissions on the environment

  • Membership to the ssis_admin database role

  • Membership to the sysadmin server role

The following list describes some conditions that may raise an error or warning:

  • The original environment name is not valid

  • The new name has already been used on an existing environment

Environment references from projects are not automatically updated when you rename the environment. Environment references must be updated accordingly. This stored procedure will succeed even if environment references are broken by changing the environment name. Environment references must be updated after this stored procedure completes.

System_CAPS_ICON_note.jpg Note

When an environment reference is not valid, validation and execution of the corresponding packages that use those references will fail.

Community Additions