catalog.create_environment_variable (SSISDB データベース)

適用対象:SQL Server Azure Data Factory の SSIS Integration Runtime

適用対象:SQL Server

Integration Services カタログで環境変数を作成します。

構文

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  

引数

[@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 カタログでサポートされることを確認します。

ヒント

サポートされていない Sbyte データ型の代わりに、Integration Services の Int16 データ型を使用することを検討してください。

value パラメーターでこのストアド プロシージャに渡された値は、次の表に従って Integration Services データ型から SQL Server データ型に変換されます。

Integration Services データ型	SQL Server データ型
Boolean	bit
Byte	binary、varbinary
DateTime	datetime、datetime2、datetimeoffset、smalldatetime
Double	真数型: decimal、numeric。概数値: float、real
Int16	smallint
Int32	int
Int64	bigint
Single	真数型: decimal、numeric。概数値: float、real
String	varchar、nvarchar、char
UInt32	int (int は、使用可能なマッピングに最も近い Uint32)
UInt64	bigint (int は、使用可能なマッピングに最も近い Uint64)