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

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

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