catalog.set_object_parameter_value (Banco de dados SSISDB)

Define o valor de um parâmetro no catálogo do Integration Services. Associa o valor a uma variável de ambiente ou atribui um valor literal que será usado por padrão se nenhum outro valor for atribuído.

Sintaxe

set_object_parameter_value [ @object_type = ] object_type 
    , [ @folder_name = ] folder_name 
    , [ @project_name = ] project_name 
    , [ @parameter_name = ] parameter _name 
    , [ @parameter_value = ] parameter_value 
 [  , [ @object_name = ] object_name ]
 [  , [ @value_type = ] value_type ]

Argumentos

• [ @object\_type = ] object_type
  O tipo do parâmetro. Use o valor 20 para indicar um parâmetro de projeto ou o valor 30 para indicar um parâmetro de pacote. O object_type é smallInt.

• [ @folder\_name = ] folder_name
  O nome da pasta que contém o parâmetro. O folder_name é nvarchar(128).

• [ @project\_name = ] project_name
  O nome do projeto que contém o parâmetro. O project_name é nvarchar(128).

• [ @parameter\_name = ] parameter_name
  O nome do parâmetro. O parameter_name é nvarchar(128).

• [ @parameter\_value = ] parameter_value
  O valor do parâmetro. O parameter_value é sql_variant.

• [ @object\_name = ] object_name
  O nome do pacote. Esse argumento será exigido quando o parâmetro for um parâmetro de pacote. O object_name é nvarchar(260).

• [ @value\_type = ] value_type
  O tipo de valor do parâmetro. Use o caractere V para indicar que parameter_value é um valor literal que será usado por padrão se nenhum outro valor for atribuído antes da execução. Use o caractere R para indicar que parameter_value é um valor referenciado e não foi definido para o nome de uma variável de ambiente. Esse argumento é opcional, o caractere V é usado por padrão. O value_type é char(1).

Valor de código de retorno

0 (êxito)

Conjuntos de resultados

Nenhum

Permissões

Esse procedimento armazenado exige uma das seguintes permissões:

• Permissões READ e MODIFY no projeto

• 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 fazer com que o procedimento armazenado gere um erro:

• O tipo do parâmetro não é válido

• O nome do projeto não é válido

• Para os parâmetros de pacote, o nome do pacote não é válido

• O tipo de valor não é válido

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

Comentários

• Se nenhum value_type for especificado, um valor literal para parameter_value será usado por padrão. Quando um valor literal for usado, o value_set na exibição object_parameters será definido como 1. O valor de parâmetro NULL não é permitido.

• Se value_type contiver o caractere R, que denota um valor referenciado, parameter_value fará referência ao nome de uma variável de ambiente.

• O valor 20 pode ser usado para object_type a fim de denotar um parâmetro de projeto. Nesse caso, um valor para object_name não é necessário e qualquer valor especificado para object_name será ignorado. Esse valor será usado quando o usuário desejar definir um parâmetro de projeto.

• O valor 30 pode ser usado para object_type a fim de denotar um parâmetro de pacote. Nesse caso, um valor para object_name será usado para denotar o pacote correspondente. Se object_name não for especificado, o procedimento armazenado retornará um erro e será encerrado.