catalog.set_object_parameter_value (base de données SSISDB)catalog.set_object_parameter_value (SSISDB Database)

CETTE RUBRIQUE S’APPLIQUE À : ouiSQL Server (à partir de la version 2012)nonAzure SQL DatabasenonAzure SQL Data WarehousenonParallel Data Warehouse THIS TOPIC APPLIES TO: yesSQL Server (starting with 2012)noAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

Définit la valeur d'un paramètre dans le catalogue Integration ServicesIntegration Services.Sets the value of a parameter in the Integration ServicesIntegration Services catalog. Associe la valeur à une variable d’environnement ou affecte une valeur littérale qui est utilisée par défaut quand aucune autre valeur n’est affectée.Associates the value to an environment variable or assigns a literal value that is used by default when no other values are assigned.

SyntaxeSyntax

catalog.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 ]  

ArgumentsArguments

[@object_type =] object_type[@object_type =] object_type
Type de paramètre.The type of parameter. Utilisez la valeur 20 pour indiquer un paramètre du projet ou la valeur 30 pour indiquer un paramètre du package.Use the value 20 to indicate a project parameter or the value 30 to indicate a package parameter. object_type est de type smallInt.The object_type is smallInt.

[@folder_name =] folder_name[@folder_name =] folder_name
Nom du dossier qui contient le paramètre.The name of the folder that contains the parameter. folder_name est de type nvarchar(128).The folder_name is nvarchar(128).

[@project_name =] project_name[@project_name =] project_name
Nom du projet qui contient le paramètre.The name of the project that contains the parameter. project_name est de type nvarchar(128).The project_name is nvarchar(128).

[@parameter_name =] parameter_name[@parameter_name =] parameter_name
Nom du paramètre.The name of the parameter. parameter_name est de type nvarchar(128).The parameter_name is nvarchar(128).

[@parameter_value =] parameter_value[@parameter_value =] parameter_value
Valeur du paramètre.The value of the parameter. parameter_value est de type sql_variant.The parameter_value is sql_variant.

[@object_name =] object_name[@object_name =] object_name
Nom du package.The name of the package. Cet argument est obligatoire lorsque le paramètre est un paramètre du package.This argument required when the parameter is a package parameter. object_name est de type nvarchar(260).The object_name is nvarchar(260).

[@value_type =] value_type[@value_type =] value_type
Type de valeur du paramètre.The type of parameter value. Utilisez le caractère V pour indiquer que parameter_value est une valeur littérale qui est utilisée par défaut quand aucune autre valeur n’est affectée avant l’exécution.Use the character V to indicate that parameter_value is a literal value that is used by default when no other values are assigned prior to execution. Utilisez le caractère R pour indiquer que parameter_value est une valeur référencée et qu’elle a été définie sur le nom d’une variable d’environnement.Use the character R to indicate that parameter_value is a referenced value and has been set to the name of an environment variable. Cet argument est facultatif, le caractère V est utilisé par défaut.This argument is optional, the character V is used by default. value_type est de type char(1).The value_type is char(1).

Valeur du code de retourReturn Code Value

0 (succès)0 (success)

Jeux de résultatsResult Sets

AucuneNone

PermissionsPermissions

Cette procédure stockée requiert l'une des autorisations suivantes :This stored procedure requires one of the following permissions:

  • Autorisations READ et MODIFY sur le projetREAD and MODIFY permissions on the project

  • Appartenance au rôle de base de données ssis_adminMembership to the ssis_admin database role

  • Appartenance au rôle serveur sysadminMembership to the sysadmin server role

Erreurs et avertissementsErrors and Warnings

La liste suivante décrit quelques conditions qui peuvent générer une erreur de procédure stockée :The following list describes some conditions that may cause the stored procedure to raise an error:

  • Le type de paramètre n'est pas valide.The parameter type is not valid

  • Le nom du projet n'est pas valide.The project name is not valid

  • Pour les paramètres du package, le nom du package n'est pas valideFor package parameters, the package name is not valid

  • Le type de valeur n'est pas valide.The value type is not valid

  • L’utilisateur n’a pas les autorisations appropriéesThe user does not have the appropriate permissions

NotesRemarks

  • Si aucun value_type n’est spécifié, une valeur littérale pour parameter_value est utilisée par défaut.If no value_type is specified, a literal value for parameter_value is used by default. Quand une valeur littérale est utilisée, le value_set dans la vue object_parameters est défini sur 1.When a literal value is used, the value_set in the object_parameters view is set to 1. Une valeur de paramètre NULL n'est pas autorisée.A NULL parameter value is not allowed.

  • Si value_type contient le caractère R, qui dénote une valeur référencée, parameter_value fait référence au nom d’une variable d’environnement.If value_type contains the character R, which denotes a referenced value, parameter_value refers to the name of an environment variable.

  • La valeur 20 peut être utilisée pour object_type afin de dénoter un paramètre du projet.The value 20 may be used for object_type to denote a project parameter. Dans ce cas, une valeur pour object_name n’est pas nécessaire, et toute valeur spécifiée pour object_name est ignorée.In this case, a value for object_name is not necessary, and any value specified for object_name is ignored. Cette valeur est utilisée lorsque l'utilisateur souhaite définir un paramètre du projet.This value is used when the user wants to set a project parameter.

  • La valeur 30 peut être utilisée pour object_type afin de dénoter un paramètre du package.The value 30 may be used for object_type to denote a package parameter. Dans ce cas, une valeur pour object_name est utilisée pour dénoter le package correspondant.In this case, a value for object_name is used to denote the corresponding package. Si object_name n’est pas spécifié, la procédure stockée retourne une erreur et termine.If object_name is not specified, the stored procedure returns an error and terminates.