catalog.validate_package (SSISDB Database)

  • Article

Asynchronously validates a package in the Integration Services catalog.

Syntax


validate_package [ @folder_name = ] folder_name
    , [ @project_name = ] project_name
    , [ @package_name = ] package_name
    , [ @validation_id = ] validation_id OUTPUT
 [  , [ @use32bitruntime = ] use32bitruntime ]
 [  , [ @target_environment = ] target_environment ]
 [  , [ @reference_id = ] reference_id ]

Arguments

  • [ @folder\_name = ] folder_name
    The name of the folder that contains the package. The folder_name is nvarchar(128).

  • [ @project\_name = ] project_name
    The name of the project that contains the package. The project_name is nvarchar(128).

  • [ @package\_name = ] package_name
    The name of the package. The package_name is nvarchar(260).

  • [ @validation\_id = ] validation_id
    Returns the unique identifier (ID) of the validation. The validation_id is bigint.

  • [ @use32bitruntime = ] use32bitruntime
    Indicates if the 32-bit runtime should be used to run the package on a 64-bit operating system. Use the value of 1 to execute the package with the 32-bit runtime when running on a 64-bit operating system. Use the value of 0 to execute the package with the 64-bit runtime when running on a 64-bit operating system. This parameter is optional. The use32bitruntime is bit.

  • [ @environment\_scope = ] environment_scope
    Indicates the environment references that are considered by the validation. When the value is A, all environment references associated with the project are included in the validation. When the value is S, only a single environment reference is included. When the value is D, no environment references are included and each parameter must have a literal default value in order to pass validation. This parameter is optional, the character D will be used by default. The environment_scope is Char(1).

  • [ @reference\_id = ] reference_id
    The unique ID of the environment reference. This parameter is required only when a single environment reference is included in the validation, when environment_scope is S. The reference_id is bigint.

Return Code Values

0 (success)

Result Sets

None

Permissions

This stored procedure requires one of the following permissions:

  • READ permissions on the project and, if applicable, READ permissions on the referenced environments

  • Membership to the ssis_admin database role

  • Membership to the sysadmin server role

Errors and Warnings

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

  • The project name or package name is not valid

  • The user does not have the appropriate permissions

  • One or more of the referenced environments included in the validation do not contain referenced variables

  • The validation of the package fails

  • The environment that is referenced does not exist

  • Referenced variables cannot be found in the referenced environments included in the validation

  • Variables are referenced in the package parameters, but no referenced environments have been included in the validation

Remarks

Validation helps identify issues that will prevent the package from running successfully. Use the catalog.validations or catalog.operations views to monitor for validation status.