catalog.get_parameter_values(SSISDB 数据库)catalog.get_parameter_values (SSISDB Database)

适用范围:SQL Server,包括 Linux Azure SQL 数据库yesAzure SQL 数据仓库no并行数据仓库 APPLIES TO: yesSQL Server, including on Linux yesAzure SQL Database yesAzure SQL Data Warehouse noParallel Data Warehouse

适用对象: yesSQL ServeryesAzure SQL 数据库noAzure SQL 数据仓库no并行数据仓库APPLIES TO: yesSQL Server noAzure SQL Database noAzure SQL Data Warehouse noParallel Data Warehouse

Integration ServicesIntegration Services 目录中的项目和对应包中解析和检索默认参数值。Resolves and retrieves the default parameter values from a project and corresponding packages in the Integration ServicesIntegration Services catalog.

语法Syntax

catalog.get_parameter_values [ @folder_name = ] folder_name  
     , [ @project_name = ] project_name  
     , [ @package_name = ] package_name  
  [  , [ @reference_id = ] reference_id  ]  
  

参数Arguments

[ @folder_name = ] folder_name [ @folder_name = ] folder_name
包含项目的文件夹的名称。The name of the folder that contains the project. folder_namenvarchar(128)The folder_name is nvarchar(128).

[ @project_name = ] project_name [ @project_name = ] project_name
参数所在的项目的名称。The name of the project where the parameters resides. project_namenvarchar(128)The project_name is nvarchar(128).

[ @package_name = ] package_name [ @package_name = ] package_name
包的名称。The name of the package. 指定包名称,以便从特定包中检索所有项目参数和参数。Specify the package name to retrieve all project parameters and the parameters from a specific package. 使用 NULL 可以从所有包中检索所有项目参数和参数。Use NULL to retrieve all project parameters and the parameters from all packages. package_name 为 nvarchar(260) 。The package_name is nvarchar(260).

[ @reference_id = ] reference_id [ @reference_id = ] reference_id
环境引用的唯一标识符。The unique identifier of an environment reference. 此参数可选。This parameter is optional. reference_id 为 bigint 。The reference_id is bigint.

返回代码值Return Code Value

0(成功)0 (success)

结果集Result Sets

返回具有以下格式的表:Returns a table that has the following format:

列名Column name 数据类型Data type 描述Description
object_typeobject_type smallintsmallint 参数的类型。The type of parameter. 对于项目参数,该值是 20;对于包参数,值是 30The value is 20 for a project parameter and the value is 30 for a package parameter.
parameter_data_typeparameter_data_type nvarchar(128)nvarchar(128) 参数的数据类型。The data type of the parameter.
parameter_nameparameter_name sysnamesysname 参数名。The name of the parameter.
parameter_valueparameter_value sql_variantsql_variant 参数的值。The value of the parameter.
sensitivesensitive bitbit 当值为 1 时,参数值是敏感的。When the value is 1, the parameter value is sensitive. 当值为 0 时,参数值是不敏感的。When the value is 0, the parameter value is not sensitive.
requiredrequired bitbit 如果值为 1,则需要参数值才能开始执行。When the value is 1, the parameter value is required in order to start the execution. 如果值为 0,则不需要参数值即可开始执行。When the value is 0, the parameter value is not required to start the execution.
value_setvalue_set bitbit 如果值为 1,则已分配参数值。When the value is 1, the parameter value has been assigned. 如果值为 0,则尚未分配参数值。When the value is 0, the parameter value has not been assigned.

备注

以纯文本形式显示文本值。Literal values are displayed in plaintext. 将显示 NULL 来替代敏感值。NULL is displayed in place of sensitive values.

权限Permissions

此存储过程需要下列权限之一:This stored procedure requires one of the following permissions:

  • 针对项目的 READ 权限,如果适用,则包含针对引用环境的 READ 权限READ permissions on the project and, if applicable, READ permission on the referenced environment

  • ssis_admin 数据库角色的成员资格Membership to the ssis_admin database role

  • sysadmin 服务器角色的成员资格Membership to the sysadmin server role

错误和警告Errors and Warnings

下面的列表描述了一些可能引发错误或警告的情况:The following list describes some conditions that may raise an error or warning:

  • 在指定的文件夹或项目中找不到该包The package cannot be found in the specified folder or project

  • 用户没有相应的权限The user does not have the appropriate permissions

  • 指定的环境引用不存在The specified environment reference does not exist