catalog.set_object_parameter_value(SSISDB 数据库)

在 Integration Services 目录中设置参数的值。 将值与环境变量关联,或者如果未指定任何其他值,则分配默认情况下使用的文本值。

语法

set_object_parameter_value [ @object_type = ] object_type 
    , [ @folder_name = ] folder_name 
    , [ @project_name = ] project_name 
    , [ @parameter_name = ] parameter _name 
    , [ @parameter_value = ] parameter_value 
 [  , [ @object_name = ] object_name ]
 [  , [ @value_type = ] value_type ]

参数

  • [ @object\_type = ] object_type
    参数的类型。 使用值 20 表示项目参数,使用值 30 表示包参数。 object_type 的数据类型为 smallInt。

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

  • [ @project\_name = ] project_name
    包含参数的项目的名称。 project_name 的数据类型为 nvarchar(128)。

  • [ @parameter\_name = ] parameter_name
    参数的名称。 parameter_name 的数据类型为 nvarchar(128)。

  • [ @parameter\_value = ] parameter_value
    参数值。 parameter_value 的数据类型为 sql_variant。

  • [ @object\_name = ] object_name
    包的名称。 当参数为包参数时,需要此参数。 object_name 的数据类型为 nvarchar(260)。

  • [ @value\_type = ] value_type
    参数值的类型。 使用字符 V 指示 parameter_value 是文本值,在执行之前未分配其他值时,将默认使用此值。 使用字符 R 指示 parameter_value 是一个被引用的值,并已设置为环境变量的名称。 此参数是可选的,默认情况下,将使用 V 字符。 value_type 的数据类型为 char(1)。

返回代码值

0(成功)

结果集

权限

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

  • 针对项目的 READ 和 MODIFY 权限

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

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

错误和警告

下面的列表描述了一些可能导致此存储过程引发错误的情况:

  • 参数类型无效。

  • 项目名称无效

  • 对于包参数,项目名称无效

  • 值类型无效

  • 用户不具备适当的权限

注释

  • 如果未指定任何 value_type 值,则默认情况下对 parameter_value 使用文本值。 当使用文本值时,object_parameters 视图中的 value_set 设置为 1。 不允许 NULL 参数值。

  • 如果 value_type 包含字符 R(指示引用值),则 parameter_value 将引用环境变量的名称。

  • 值 20 可以用于 object_type 以表示项目参数。 在此情况下,object_name 的值不是必需的,将忽略为 object_name 指定的任何值。 当用户要设置项目参数时,将使用此值。

  • 值 30 可以用于 object_type 以表示包参数。 在这种情况下,将使用 object_name 的值来表示相应的包。 如果未指定 object_name,则存储过程返回一个错误并且终止。