catalog.create_environment_variable (Banco de Dados SSISDB)

Aplica-se a:SQL Server SSIS Integration Runtime no Azure Data Factory

Aplica-se a:SQL Server

Cria uma variável de ambiente no catálogo do Integration Services.

Sintaxe

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  

Argumentos

[@folder_name =] folder_name
O nome da pasta que contém o ambiente. O folder_name é nvarchar(128) .

[@environment_name =] environment_name
O nome do ambiente. O environment_name é nvarchar(128) .

[@variable_name =] variable_name
O nome da variável de ambiente. O variable_name é nvarchar(128).

[@data_type =] data_type
O tipo de dados da variável. Os tipos de dados de variável de ambiente com suporte incluem booliano, Byte, DateTime, Double, Int16, Int32, Int64, Single, String, UInt32 e UInt64. Os tipos de dados de variável de ambiente sem suporte incluem Char, DBNull, Object e Sbyte. O tipo de dados do parâmetro data_type é nvarchar(128).

[@sensitive =] sensitive
Indica se a variável contém um valor confidencial ou não. Use um valor de 1 para indicar que o valor da variável de ambiente é confidencial ou um valor de 0 para indicar que não é. Um valor confidencial é criptografado quando é armazenado. Um valor que não é confidencial é armazenado em texto não criptografado. Sensitive é bit.

[@value =] value
O valor da variável de ambiente. O value é sql_variant.

[@description =] description
A descrição da variável do ambiente. O value é nvarchar(1024).

Valor do código de retorno

0 (êxito)

Conjuntos de resultados

Nenhum

Permissões

Este procedimento armazenado exige uma das seguintes permissões:

• Permissões READ e MODIFY no ambiente

• Associação à função de banco de dados ssis_admin

• Associação à função de servidor sysadmin

Erros e avisos

A lista a seguir descreve algumas condições que podem gerar um erro ou um aviso:

• O nome de pasta, nome de ambiente, ou nome de variável de ambiente não é válido

• O nome da variável já existe no ambiente

• O usuário não tem as permissões apropriadas

Comentários

Uma variável de ambiente pode ser usada para atribuir um valor com eficiência a um parâmetro de projeto ou parâmetro de pacote para uso na execução de um pacote. As variáveis de ambiente habilitam a organização de valores de parâmetros. Os nomes de variável devem ser exclusivos dentro de um ambiente.

O procedimento armazenado valida o tipo de dados da variável para ter certeza de que tem suporte pelo catálogo do Integration Services.

Dica

Considere usar o tipo de dados Int16 em Integration Services no lugar do tipo de dados Sbyte sem suporte.

O valor passado a este procedimento armazenado com o parâmetro value será convertido de um tipo de dados do Integration Services para um tipo de dados SQL Server de acordo com a tabela a seguir:

Tipo de Dados do Integration Services	Tipo de dados do SQL Server
Booliano	bit
Byte	binary, varbinary
DateTime	datetime, datetime2, datetimeoffset, smalldatetime
Double	Numérico exato: decimal, numeric; Numérico aproximado: float, real
Int16	smallint
Int32	int
Int64	bigint
Single	Numérico exato: decimal, numeric; Numérico aproximado: float, real
Cadeia de caracteres	varchar, nvarchar, char
UInt32	int (int é o mapeamento disponível mais próximo para Uint32.)
UInt64	bigint (int é o mapeamento disponível mais próximo para Uint64.)