sp_add_agent_profile (Transact-SQL)

Crée un nouveau profil pour un Agent de réplication. Cette procédure stockée est exécutée sur n'importe quelle base de données du serveur de distribution.

Icône Lien de rubriqueConventions de la syntaxe de Transact-SQL

Syntaxe

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 ]

Arguments

  • [ @profile_id= ] profile_id
    Numéro d'identification associé au profil nouvellement inséré. profile_id est de type int et est un paramètre OUTPUT facultatif. Si vous l'indiquez, la valeur définie est égale au numéro d'identification du nouveau profil.

  • [ @profile_name= ] 'profile_name'
    Nom du profil. profile_name est de type sysname et n'a pas de valeur par défaut.

  • [ @agent_type= ] 'agent_type'
    Type d'agent de réplication. agent_type est de type int, sans valeur par défaut, et peut prendre l'une des valeurs suivantes.

    Valeur

    Description

    1

    Agent de capture instantanée

    2

    Agent de lecture du journal

    3

    Agent de distribution

    4

    Agent de fusion

    9

    Agent de lecture de la file d'attente

  • [ @profile_type= ] profile_type
    Type de profil.profile_type est de type int, avec 1 comme valeur par défaut.

    La valeur 0 indique un profil système. La valeur 1 indique un profil personnalisé. Cette procédure stockée permet uniquement de créer des profils personnalisés. La seule valeur valide est donc 1. Seul Microsoft SQL Server permet de créer des profils système.

  • [ @description= ] 'description'
    Description du profil. description est de type nvarchar(3000) et n'a pas de valeur par défaut.

  • [ @default= ] default
    Indique si le profil est la valeur par défaut de l'argument agent_type*.* default est de type bit, avec 0 comme valeur par défaut. 1 indique que le profil ajouté deviendra le nouveau profil par défaut de l'Agent spécifié par le paramètre agent_type.

Valeurs des codes renvoyés

0 (succès) ou 1 (échec)

Notes

La procédure sp_add_agent_profile est utilisée lors d'une réplication transactionnelle, de capture instantanée ou de fusion.

Les profils d'agent personnalisés sont ajoutés avec les valeurs par défaut. Utilisez sp_change_agent_parameter (Transact-SQL) pour modifier ces valeurs par défaut ou sp_add_agent_parameter (Transact-SQL) pour ajouter des paramètres supplémentaires.

Lors de l'exécution de la procédure sp_add_agent_profile, une ligne est ajoutée pour le nouveau profil personnalisé dans la table MSagent_profiles (Transact-SQL) et les paramètres par défaut associés à ce profil sont ajoutés à cette table MSagent_parameters (Transact-SQL).

Autorisations

Seuls les membres du rôle serveur fixe sysadmin peuvent exécuter la procédure sp_add_agent_profile.