catalog.create_environment_variable (SSISDB 資料庫)

在 Integration Services 目錄中建立環境變數。

語法

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

引數

• [ @folder\_name = ] folder_name
  包含環境之資料夾的名稱。 folder_name 為 nvarchar(128)。

• [ @environment\_name = ] environment_name
  環境的名稱。 environment_name 為 nvarchar(128)。

• [ @variable\_name = ] variable_name
  環境變數的名稱。 variable_name 為 nvarchar(128)。

• [ @data\_type = ] data_type
  變數的資料類型。 支援的環境變數資料類型包含 Boolean、Byte、DateTime、Double、Int16、Int32、Int64、Single、String、UInt32 和 UInt64。 不支援的環境變數資料類型包含 Char、DBNull、Object 和 Sbyte。 data_type 參數的資料類型為 nvarchar(128)。

• [ @sensitive = ] sensitive
  指出變數是否包含機密值。 使用 1 值表示環境變數的值是機密值，或者，使用 0 值則表示該值不是機密值。 機密值會在儲存時加密。 非機密值則會儲存為純文字。Sensitive 為 bit。

• [ @value = ] value
  環境變數的值。 value 為 sql_variant。

• [ @description = ] description
  環境變數的描述。 value 為 nvarchar(1024)。

傳回碼值

0 (成功)

結果集

無

權限

這個預存程序需要下列其中一個權限：

• 環境的 READ 和 MODIFY 權限

• ssis_admin 資料庫角色成員資格

• sysadmin 伺服器角色成員資格

錯誤和警告

下列清單將描述可能會引發錯誤或警告的某些條件：

• 資料夾名稱、環境名稱或環境變數名稱無效

• 變數名稱已經存在於環境中

• 使用者未具備適當的權限

備註

環境變數可以用來將值有效地指派給專案參數或封裝參數，以用於封裝的執行中。 環境變數啟用了參數值的組織。 變數名稱在環境中必須是唯一的。

預存程序會驗證變數的資料類型，以確定 Integration Services 目錄可支援該變數。

提示
請考慮使用 Integration Services 中的 Int16 資料類型，而非使用不受支援的 Sbyte 資料類型。

根據下表，傳遞到這個具有 value 參數之預存程序的值，將會從 Integration Services 資料類型轉換為 SQL Server 資料類型：