catalog.create_environment_variable (base de données SSISDB)

  • Article

S’applique à :SQL Server SSIS Integration Runtime dans Azure Data Factory

S’applique à :SQL Server

Crée une variable d'environnement dans le catalogue Integration Services.

Syntaxe

catalog.create_environment_variable [ @folder_name = ] folder_name  
    , [ @environment_name = ] environment_name  
    , [ @variable_name = ] variable_name  
    , [ @data_type = ] data_type  
    , [ @sensitive = ] sensitive  
    , [ @value = ] value  
    , [ @description = ] description

Arguments

[@folder_name =] nom_dossier
Nom du dossier qui contient l'environnement. folder_name est de type nvarchar(128) .

[@environment_name =] nom_environnement
Nom de l’environnement. environment_name est de type nvarchar(128) .

[@variable_name =] nom_variable
Nom de la variable d’environnement. variable_name est de type nvarchar(128).

[@data_type =] type_données
Type de données de la variable. Les types de données de variable d’environnement pris en charge incluent Boolean, Byte, DateTime, Double, Int16, Int32, Int64, Single, String, UInt32 et UInt64. Les types de données de variable d’environnement non pris en charge incluent Char, DBNull, Object et Sbyte. Le type de données du paramètre data_type est nvarchar (128).

[@sensitive =] sensible
Indique si la variable contient une valeur sensible ou pas. Utilisez une valeur de 1 pour indiquer que la valeur de la variable d'environnement est sensible ou une valeur de 0 pour indiquer qu'elle n'est pas sensible. Une valeur sensible est chiffrée lorsqu'elle est stockée. Une valeur qui n’est pas sensible est stockée en texte en clair. Sensitive est de type bit.

[@value =] valeur
Valeur de la variable d’environnement. value est de type sql_variant.

[@description =] description
Description de la variable d'environnement. value est de type nvarchar(1024).

Valeur du code de retour

0 (succès)

Jeux de résultats

None

Autorisations

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

  • Autorisations READ et MODIFY sur l'environnement

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

  • Appartenance au rôle serveur sysadmin

Erreurs et avertissements

La liste suivante décrit quelques conditions qui peuvent générer une erreur ou un avertissement :

  • Le nom du dossier, le nom de l'environnement ou la variable d'environnement n'est pas valide

  • Le nom de variable existe déjà dans l'environnement

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

Notes

Une variable d'environnement peut être utilisée pour affecter efficacement une valeur à un paramètre du projet ouà un paramètre du package pour une utilisation dans l'exécution d'un package. Les variables d'environnement permettent d'organiser les valeurs de paramètre. Les noms de variable doivent être uniques dans un environnement.

La procédure stockée valide le type de données de la variable pour s'assurer qu'elle est prise en charge par le catalogue Integration Services.

Conseil

Envisagez d’utiliser le type de données Int16 dans Integration Services au lieu du type de données Sbyte non pris en charge.

La valeur passée à cette procédure stockée avec le paramètre value est convertie d’un type de données Integration Services en un type de données SQL Server selon le tableau suivant :

Type de données Integration Services Type de données de SQL Server
Booléen bit
Byte binary, varbinary
DateTime datetime, datetime2, datetimeoffset, smalldatetime
Double Valeur numérique exacte : decimal, numeric ; Valeur numérique approchée : float, real
Int16 smallint
Int32 int
Int64 bigint
Unique Valeur numérique exacte : decimal, numeric ; Valeur numérique approchée : float, real
Chaîne varchar, nvarchar, char
UInt32 int (int est le mappage le plus proche de Uint32.)
UInt64 bigint (int est le mappage le plus proche de Uint64.)