catalog.create_environment_variable (SSISDB-Datenbank)

Erstellt eine Umgebungsvariable im Integration Services-Katalog.

Syntax

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

Argumente

• [ @folder\_name = ] folder_name
  Der Name des Ordners, der die Umgebung enthält. Der folder_name ist nvarchar(128).

• [ @environment\_name = ] environment_name
  Der Name der Umgebung. Der environment_name ist nvarchar(128).

• [ @variable\_name = ] variable_name
  Der Name der Umgebungsvariablen. Der variable_name ist nvarchar(128).

• [ @data\_type = ] data_type
  Der Datentyp der Variablen. Unterstützte Umgebungsvariablendatentypen sind Boolean, Byte, DateTime, Double, Int16, Int32, Int64, Single, String, UInt32 und UInt64. Die Umgebungsvariablendatentypen Char, DBNull, Object und Sbyte werden nicht unterstützt. Der data_type-Parameter ist nvarchar(128).

• [ @sensitive = ] sensitive
  Gibt an, ob die Variable einen vertraulichen Wert enthält. Verwenden Sie den Wert 1, um anzugeben, dass der Wert der Umgebungsvariablen vertraulich ist, oder den Wert 0, um anzugeben, dass er nicht vertraulich ist. Ein vertraulicher Wert wird verschlüsselt, wenn er gespeichert wird. Ein Wert, der nicht vertraulich ist, wird als Nur-Text gespeichert. Sensitive ist vom Datentyp bit.

• [ @value = ] value
  Der Wert der Umgebungsvariablen. Der value ist sql_variant.

• [ @description = ] description
  Die Beschreibung der Umgebungsvariablen. Der value ist nvarchar(1024).

Rückgabecodewert

0 (Erfolg)

Resultsets

Keine

Berechtigungen

Diese gespeicherte Prozedur erfordert eine der folgenden Berechtigungen:

• READ-Berechtigung und MODIFY-Berechtigung für die Umgebung

• Mitgliedschaft in der Datenbankrolle ssis_admin

• Mitgliedschaft in der Serverrolle sysadmin

Fehler und Warnungen

In der folgenden Liste werden einige Bedingungen beschrieben, die möglicherweise einen Fehler oder eine Warnung auslösen:

• Der Name des Ordners, der Umgebung oder der Umgebungsvariablen ist ungültig.

• Der Variablenname ist bereits in der Umgebung vorhanden.

• Der Benutzer verfügt nicht über die entsprechenden Berechtigungen.

Hinweise

Mit einer Umgebungsvariablen kann zur Ausführung eines Pakets einem Projektparameter oder Paketparameter effizient ein Wert zugewiesen werden. Umgebungsvariablen ermöglichen die Organisation von Parameterwerten. Variablennamen müssen innerhalb einer Umgebung eindeutig sein.

Die gespeicherte Prozedur überprüft den Datentyp der Variablen, um sicherzustellen, dass sie vom Integration Services-Katalog unterstützt wird.

Tipp
Verwenden Sie ggf. statt des nicht unterstützten Sbyte-Datentyps den Int16-Datentyp in Integration Services.

Der mit dem value-Parameter an diese gespeicherte Prozedur übergebene Wert wird gemäß der folgenden Tabelle aus dem Integration Services-Datentyp in den SQL Server-Datentyp konvertiert: