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

Статья
05/08/2013

Создайте переменную среды в каталоге служб Службы 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 его поддерживает.

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

Значение, передаваемое в хранимую процедуру с параметром 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 (Это наиболее близкое доступное сопоставление с Uint32.)
UInt64	bigint (Это наиболее близкое доступное сопоставление с Uint64.)

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