Хранимая процедура sp_change_agent_parameter (Transact-SQL)

Изменяет параметр профиля агента репликации, сохраненного в системной таблице MSagent_parameters. Эта хранимая процедура выполняется на распространителе в любой базе данных с запущенным агентом.

Значок ссылки на раздел Синтаксические обозначения Transact-SQL

Синтаксис

sp_change_agent_parameter [ @profile_id= ] profile_id, [ @parameter_name= ] 'parameter_name', [ @parameter_value= ] 'parameter_value'

Аргументы

  • [ @profile_id=] profile_id,
    Идентификатор профиля. Аргумент profile_id имеет тип int и не имеет значения по умолчанию.

  • [ @parameter_name=] 'parameter_name'
    Имя параметра. Аргумент parameter_name имеет тип sysname и не имеет значения по умолчанию. Для системных профилей параметры, которые могут быть изменены, зависят от типа агента. Чтобы выяснить, какой тип агента представляет профиль с аргументом profile_id, найдите столбец profile_id в таблице Msagent_profiles и посмотрите значение аргумента agent_type.

    ПримечаниеПримечание

    Если аргумент поддерживается для типа аргумента agent_type, но не был определен в профиле агента, будет возвращена ошибка. Чтобы добавить параметр к профилю агента, необходимо выполнить процедуру sp_add_agent_parameter.

    Для агента моментальных снимков (agent_type=1) могут быть изменены следующие свойства, если они определены в профиле:

    • 70Subscribers

    • BcpBatchSize

    • HistoryVerboseLevel

    • LoginTimeout

    • MaxBcpThreads

    • MaxNetworkOptimization

    • Output

    • OutputVerboseLevel

    • PacketSize

    • QueryTimeout

    • StartQueueTimeout

    • UsePerArticleContentsView

    Для агента чтения журнала (agent_type=2) могут быть изменены следующие свойства, если они определены в профиле:

    • HistoryVerboseLevel

    • LoginTimeout

    • MessageInterval

    • Выходные данные

    • OutputVerboseLevel

    • PacketSize

    • PollingInterval

    • QueryTimeout

    • ReadBatchSize

    • ReadBatchThreshold

    Для агента распространителя (agent_type=3) могут быть изменены следующие свойства, если они определены в профиле:

    • BcpBatchSize

    • CommitBatchSize

    • CommitBatchThreshold

    • FileTransferType

    • HistoryVerboseLevel

    • KeepAliveMessageInterval

    • LoginTimeout

    • MaxBcpThreads

    • MaxDeliveredTransactions

    • MessageInterval

    • Выходные данные

    • OutputVerboseLevel

    • PacketSize

    • PollingInterval

    • QueryTimeout

    • QuotedIdentifier

    • SkipErrors

    • TransactionsPerHistory

    Для агента слияния (agent_type=4) могут быть изменены следующие свойства, если они определены в профиле:

    • AltSnapshotFolder

    • BcpBatchSize

    • ChangesPerHistory

    • DestThreads

    • DownloadGenerationsPerBatch

    • DownloadReadChangesPerBatch

    • DownloadWriteChangesPerBatch

    • DynamicSnapshotLocation

    • ExchangeType

    • FastRowCount

    • FileTransferType

    • GenerationChangeThreshold

    • HistoryVerboseLevel

    • InputMessageFile

    • InteractiveResolution

    • InterruptOnMessagePattern

    • KeepAliveMessageInterval

    • LoginTimeout

    • MaxBcpThreads

    • MaxDownloadChanges

    • MaxUploadChanges

    • MetadataRetentionCleanup

    • NumDeadlockRetries

    • Выходные данные

    • OutputMessageFile

    • OutputVerboseLevel

    • PacketSize

    • ParallelUploadDownload

    • PauseOnMessagePattern

    • PauseTime

    • PollingInterval

    • ProcessMessagesAtPublisher

    • ProcessMessagesAtSubscriber

    • QueryTimeout

    • QueueSizeMultiplier

    • SrcThreads

    • StartQueueTimeout

    • SyncToAlternate

    • UploadGenerationsPerBatch

    • UploadReadChangesPerBatch

    • UploadWriteChangesPerBatch

    • UseInprocLoader

    • Validate

    • ValidateInterval

    Для агента чтения очереди (agent_type=9) могут быть изменены следующие свойства, если они определены в профиле:

    • HistoryVerboseLevel

    • LoginTimeout

    • Выходные данные

    • OutputVerboseLevel

    • PollingInterval

    • QueryTimeout

    • ResolverState

    • SQLQueueMode

    Чтобы посмотреть, какие параметры определены для данного профиля, выполните процедуру sp_help_agent_profile и найдите имя профиля profile_name, соответствующее аргументу profile_id. Затем выполните процедуру sp_help_agent_parameters, используя идентификатор profile_id для просмотра параметров, связанных с профилем. Параметры могут быть добавлены к профилю с помощью процедуры sp_add_agent_parameter.

  • [ @parameter_value=] 'parameter_value'
    Новое значение параметра. Аргумент parameter_value имеет тип nvarchar(255) и не имеет значения по умолчанию.

Значения кодов возврата

0 (успешное завершение) или 1 (неуспешное завершение)

Замечания

Процедура sp_change_agent_parameter используется во всех типах репликации.

Разрешения

Процедуру sp_change_agent_parameter могут выполнять только члены предопределенной роли сервера sysadmin.

См. также

Справочник

Профили агента репликации

Агент распространения репликации

Агент чтения журнала репликации

Агент слияния репликации

Агент чтения очереди репликации

Агент моментальных снимков репликации

sp_add_agent_parameter (Transact-SQL)

sp_drop_agent_parameter (Transact-SQL)

sp_help_agent_parameter (Transact-SQL)

Системные хранимые процедуры (Transact-SQL)