catalog.create_environment_variable (база данных SSISDB)

Статья
11/19/2024

Область применения: среда выполнения интеграции SSIS SQL Server в Фабрика данных Azure

Область применения: 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 имеет тип nvarchar(128).

[@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.

Совет

Рекомендуется использовать тип данных Int16 в службах Integration Services вместо неподдерживаемого типа данных Sbyte .

Значение, переданное этой хранимой процедуре с параметром значения , преобразуется из типа данных Служб Integration Services в тип данных SQL Server в соответствии со следующей таблицей:

Тип данных служб Integration Services	Тип данных SQL Server
Boolean	bit
Byte	binary, varbinary
DateTime	datetime, datetime2, datetimeoffset, smalldatetime
Двойной	Точное числовое значение: decimal, numeric; приблизительное числовое значение: float, real
Int16	smallint
Int32	int
Int64	bigint
Один	Точное числовое значение: decimal, numeric; приблизительное числовое значение: float, real
String	varchar, nvarchar, char
UInt32	int (int — это наиболее близкое доступное сопоставление с Uint32.)
UInt64	bigint (int — это наиболее близкое доступное сопоставление с Uint64.)

Поделиться через