catalog.set_object_parameter_value (base de données SSISDB)

  • Article

Définit la valeur d'un paramètre dans le catalogue Integration Services. Associe la valeur à une variable d'environnement ou affecte une valeur littérale qui sera utilisée par défaut si aucune autre valeur n'est affectée.

Syntaxe

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 ]

Arguments

  • [ @object\_type = ] object_type
    Type de paramètre. Utilisez la valeur 20 pour indiquer un paramètre du projet ou la valeur 30 pour indiquer un paramètre du package. object_type est smallInt.

  • [ @folder\_name = ] folder_name
    Nom du dossier qui contient le paramètre. folder_name est nvarchar(128).

  • [ @project\_name = ] project_name
    Nom du projet qui contient le paramètre. project_name est nvarchar(128).

  • [ @parameter\_name = ] parameter_name
    Nom du paramètre. parameter_name est nvarchar(128).

  • [ @parameter\_value = ] parameter_value
    Valeur du paramètre. parameter_value est sql_variant.

  • [ @object\_name = ] object_name
    Nom du package. Cet argument est obligatoire lorsque le paramètre est un paramètre du package. Le paramètre object_name est de type nvarchar(260).

  • [ @value\_type = ] value_type
    Type de valeur du paramètre. Utilisez le caractère V pour indiquer que parameter_value est une valeur littérale qui sera utilisée par défaut si aucune autre valeur n'est affecté avant l'exécution. 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. Cet argument est facultatif, le caractère V est utilisé par défaut. value_type est char(1).

Valeurs des codes de retour

0 (succès)

Jeux de résultats

Aucun

Autorisations

Cette procédure stockée requiert l'une des autorisations suivantes :

  • Autorisations READ et MODIFY sur le projet

  • Appartenance au rôle de base de données ssis_admin

  • Appartenance au rôle de serveur sysadmin

Erreurs et avertissements

La liste suivante décrit quelques conditions qui peuvent générer une erreur de procédure stockée :

  • Le type de paramètre n'est pas valide.

  • Le nom du projet n'est pas valide.

  • Pour les paramètres du package, le nom du package n'est pas valide

  • Le type de valeur n'est pas valide.

  • L'utilisateur n'a pas les autorisations appropriées

Notes

  • Si aucun value_type n'est spécifié, la valeur littérale de parameter_value est utilisée par défaut. Lorsqu'une valeur littérale est utilisée, le value_set dans la vue object_parameters est défini sur 1. Une valeur de paramètre NULL n'est pas autorisée.

  • 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.

  • La valeur 20 peut être utilisée pour object_type pour dénoter un paramètre du projet. Dans ce cas, une valeur pour object_name n'est pas nécessaire, et toute valeur spécifiée pour object_name est ignoré. Cette valeur est utilisée lorsque l'utilisateur souhaite définir un paramètre du projet.

  • La valeur 30 peut être utilisée pour object_type pour dénoter un paramètre du package. Dans ce cas, une valeur pour object_name est utilisée pour dénoter le package correspondant. Si object_name n'est pas spécifié, la procédure stockée retourne une erreur et termine.