sp_add_agent_profile (Transact-SQL)

Cria um perfil novo para um agente de replicação. Esse procedimento armazenado é executado no Distribuidor, em qualquer banco de dados.

Ícone de vínculo de tópicoConvenções de sintaxe Transact-SQL

Sintaxe

sp_add_agent_profile [ [ @profile_id= ] profile_id OUTPUT ]
        , [ @profile_name= ] 'profile_name' 
        , [ @agent_type= ] 'agent_type' ] 
    [ , [ @profile_type= ] profile_type ]
    [ , [ @description= ] 'description' ]
    [ , [ @default= ] default ]

Argumentos

  • [ @profile_id= ] profile_id
    É a ID associada ao perfil recém-inserido. profile_id é int e é um parâmetro OUTPUT opcional. Se especificado, o valor será definido como a nova ID do perfil.

  • [ @profile_name= ] 'profile_name'
    É o nome do perfil. profile_name é sysname, sem padrão.

  • [ @agent_type= ] 'agent_type'
    É o tipo de agente de replicação. agent_type é int, sem padrão, e pode ser um dos valores a seguir.

    Valor

    Descrição

    1

    Snapshot Agent

    2

    Log Reader Agent

    3

    Distribution Agent

    4

    Merge Agent

    9

    Queue Reader Agent

  • [ @profile_type= ] profile_type
    É o tipo de perfil.profile_type é int, com um padrão de 1.

    0 indica um perfil de sistema. 1 indica um perfil personalizado. Somente perfis personalizados podem ser criados usando esse procedimento armazenado; portanto, o único valor válido é 1. Somente o Microsoft SQL Server cria perfis de sistema.

  • [ @description= ] 'description'
    É uma descrição do perfil. description é nvarchar(3000), sem padrão.

  • [ @default= ] default
    Indica se o perfil é padrão para agent_type*.* default é bit, com um padrão de 0. 1 indica que o perfil que está sendo adicionado se tornará o novo perfil padrão para o agente especificado por agent_type.

Valores de código de retorno

0 (êxito) ou 1 (falha)

Comentários

sp_add_agent_profile é usado em replicação de instantâneo, replicação transacional e de mesclagem.

Perfis de agente personalizados são adicionados com os valores de parâmetro de agente padrão. Use sp_change_agent_parameter (Transact-SQL) para alterar esses valores padrão ou sp_add_agent_parameter (Transact-SQL) para adicionar parâmetros adicionais.

Quando sp_add_agent_profile é executado, uma linha é adicionada para o novo perfil de cliente na tabela MSagent_profiles (Transact-SQL) e os parâmetros padrão associados a esse perfil são adicionados à tabela MSagent_parameters (Transact-SQL).

Permissões

Somente membros da função de servidor fixa sysadmin podem executar sp_add_agent_profile.