catalog.create_environment_variable (database SSISDB)

Viene creata una variabile di ambiente nel catalogo di Integration Services.

Sintassi

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

Argomenti

• [ @folder\_name = ] folder_name
  Nome della cartella in cui è contenuto l'ambiente. folder_name è di tipo nvarchar(128).

• [ @environment\_name = ] environment_name
  Nome dell'ambiente. environment_name è di tipo nvarchar(128).

• [ @variable\_name = ] variable_name
  Nome della variabile di ambiente. variable_name è di tipo nvarchar(128).

• [ @data\_type = ] data_type
  Tipo di dati della variabile. Tra i tipi di dati della variabile di ambiente supportati sono inclusi Boolean, Byte, DateTime, Double, Int16, Int32, Int64, Single, String, UInt32 e UInt64. Tra i tipi di dati della variabile di ambiente non supportati sono inclusi Char, DBNull, Object e Sbyte. Il tipo di dati del parametro data_type è nvarchar(128).

• [ @sensitive = ] sensitive
  Viene indicato se nella variabile è contenuto o meno un valore importante. Utilizzare un valore pari a 1, per indicare che il valore della variabile di ambiente è importante o, in caso contrario, un valore pari a 0. Un valore, se importante, viene crittografato quando viene archiviato; altrimenti, viene archiviato non crittografato. Sensitive è di tipo bit.

• [ @value = ] value
  Valore della variabile di ambiente. value è di tipo sql_variant.

• [ @description = ] description
  Descrizione della variabile di ambiente. value è di tipo nvarchar(1024).

Valore del codice restituito

0 (esito positivo)

Set di risultati

Nessuno

Autorizzazioni

Per questa stored procedure è necessaria una delle autorizzazioni seguenti:

• Autorizzazioni READ e MODIFY sull'ambiente

• Appartenenza al ruolo del database ssis_admin

• Appartenenza al ruolo server sysadmin

Errori e avvisi

Nell'elenco seguente vengono descritte alcune condizioni che possono generare un errore o un avviso:

• Nome della cartella, nome dell'ambiente o nome della variabile di ambiente non valido

• Nome della variabile già esistente nell'ambiente

• Utente senza autorizzazioni appropriate.

Osservazioni

Una variabile di ambiente può essere utilizzata per assegnare in modo efficace un valore a un parametro del progetto o a un parametro del pacchetto da utilizzare nell'esecuzione di un pacchetto. Le variabili di ambiente consentono l'organizzazione dei valori del parametro. I nomi della variabile devono essere univoci all'interno di un ambiente.

La stored procedure consente di convalidare il tipo di dati della variabile per assicurarsi che sia supportato dal catalogo di Integration Services.

Suggerimento
In Integration Services si consideri di utilizzare il tipo di dati Int16 anziché il tipo di dati Sbyte non supportato.

Il valore passato a questa stored procedure con il parametro value sarà convertito da un tipo di dati di Integration Services in un tipo di dati di SQL Server in base alla tabella seguente: