catalog.create_environment_variable（SSISDB 数据库）

在 Integration Services 目录中创建环境变量。

语法

create_environment_variable [ @folder_name = ] folder_name
    , [ @environment_name = ] environment_name
    , [ @variable_name = ] variable_name
    , [ @data_type = ] data_type
    , [ @sensitive = ] sensitive
    , [ @value = ] value
    , [ @description = ] description

参数

• [ @folder\_name = ] folder_name
  包含环境的文件夹的名称。 folder_name 的数据类型为 nvarchar(128)。

• [ @environment\_name = ] environment_name
  环境的名称。 environment_name 的数据类型为 nvarchar(128)。

• [ @variable\_name = ] variable_name
  环境变量的名称。 variable_name 的数据类型为 nvarchar(128)。

• [ @data\_type = ] data_type
  变量的数据类型。 支持的环境变量的数据类型包括：Boolean、Byte、DateTime、Double、Int16、Int32、Int64、Single、String、UInt32 和 UInt64。 不支持的环境变量的数据类型包括：Char、DBNull、Object 和 Sbyte。 data_type 参数的数据类型为 nvarchar(128)。

• [ @sensitive = ] sensitive
  指示变量是否包含敏感值。 使用值 1 表示环境变量的值是敏感值，值为 0 表示该值不是敏感值。 存储敏感值时将对其加密。 不敏感的值以纯文本形式存储。Sensitive 的数据类型为 bit。

• [ @value = ] value
  环境变量的值。 value 的数据类型为 sql_variant。

• [ @description = ] description
  环境变量的描述。 value 的数据类型为 nvarchar(1024)。

返回代码值

0（成功）

结果集

无

权限

此存储过程需要下列权限之一：

• 针对环境的 READ 和 MODIFY 权限

• ssis_admin 数据库角色的成员身份

• sysadmin 服务器角色的成员身份

错误和警告

下面的列表描述了一些可能引发错误或警告的情况：

• 文件夹名称、环境名称或环境变量名无效

• 环境中已存在此变量名

• 用户不具备适当的权限

注释

可以使用环境变量高效地将值分配给项目参数或包参数，以用于执行包。 环境变量启用参数值的排列。 变量名在环境中必须是唯一的。

此存储过程验证变量的数据类型，以确保它受 Integration Services 目录支持。

提示
请考虑在 Integration Services 中使用 Int16 数据类型，而不使用不支持的 Sbyte 数据类型。

使用 value 参数传递给此存储过程的值将根据下表，从 Integration Services 数据类型转换为 SQL Server 数据类型：

Integration Services 数据类型	SQL Server 数据类型
Boolean	bit
Byte	binary、varbinary
DateTime	datetime、datetime2、datetimeoffset、smalldatetime
Double	精确数值：decimal、numeric；近似数值：float、 real
Int16	smallint
Int32	int
Int64	bigint
Single	精确数值：decimal、numeric；近似数值：float、 real
String	varchar, nvarchar, char
UInt32	int（这是与 Uint32 最接近的可用映射）。
UInt64	bigint（这是与 Uint64 最接近的可用映射）。