Partilhar via


catalog.create_environment_variable (Banco de Dados SSISDB)

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

Aplica-se a:SQL Server

Crie 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áveis de ambiente suportados incluem Boolean, Byte, DateTime, Double, Int16, Int32, Int64, Single, String, UInt32e UInt64. Os tipos de dados de variáveis de ambiente sem suporte incluem Char, DBNull, Objecte Sbyte. O tipo de dados do parâmetro data_type é nvarchar(128).

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

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

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

Valor do código de retorno

0 (sucesso)

Conjuntos de resultados

Nenhum

Permissões

Este procedimento armazenado requer uma das seguintes permissões:

  • Permissões LER e MODIFICAR 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 aviso:

  • O nome da pasta, o nome do ambiente ou o nome da 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 eficientemente um valor a um parâmetro de projeto ou parâmetro de pacote para uso na execução de um pacote. As variáveis de ambiente permitem a organização dos valores dos parâmetros. Os nomes das variáveis devem ser exclusivos dentro de um ambiente.

O procedimento armazenado valida o tipo de dados da variável para garantir que ela seja suportada pelo catálogo do Integration Services.

Dica

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

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

Tipo de dados do Integration Services Tipo de dados do SQL Server
Boolean pouco
Byte binário, varbinary
DateTime datetime, datetime2, datetimeoffset, smalldatetime
Duplo Números exatos: decimal, numéricos; Numérico aproximado: flutuar, real
Int16 pequeno
Int32 int
Int64 bigint
Single Números exatos: decimal, numéricos; Numérico aproximado: flutuar, real
String varchar, nvarchar, char
UInt32 int (int é o mapeamento disponível mais próximo de Uint32.)
UInt64 bigint (int é o mapeamento disponível mais próximo de Uint64.)