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,
    配置文件的 ID。profile_id 的数据类型为 int,无默认值。

  • [ @parameter_name=] 'parameter_name'
    参数的名称。parameter_name 的数据类型为 sysname,无默认值。 对于系统配置文件,可以更改的参数取决于代理的类型。 若要了解此 profile_id 表示的代理的类型,请在 Msagent_profiles 表中找到 profile_id 列,然后查看 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

    • Output

    • OutputVerboseLevel

    • PacketSize

    • PollingInterval

    • QueryTimeout

    • ReadBatchSize

    • ReadBatchThreshold

    对于分发代理 (agent_type=3),如果在配置文件中已定义了以下属性,则可更改这些属性:

    • BcpBatchSize

    • CommitBatchSize

    • -CommitBatchThreshold

    • FileTransferType

    • HistoryVerboseLevel

    • KeepAliveMessageInterval

    • LoginTimeout

    • MaxBcpThreads

    • MaxDeliveredTransactions

    • MessageInterval

    • Output

    • 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

    • Output

    • 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

    • Output

    • OutputVerboseLevel

    • PollingInterval

    • QueryTimeout

    • ResolverState

    • SQLQueueMode

    若要查看为给定配置文件定义的参数,请运行 sp_help_agent_profile,查看与 profile_id 关联的 profile_name。 然后,使用相应的 profile_id 运行使用该 profile_id 的 sp_help_agent_parameters,以查看与配置文件关联的参数。 可通过执行 sp_add_agent_parameter 向配置文件添加参数。

  • [ @parameter_value=] 'parameter_value'
    参数的新值。parameter_value 的数据类型为 nvarchar(255),无默认值。

返回代码值

0(成功)或 1(失败)

注释

sp_change_agent_parameter 用于所有类型的复制。

权限

只有 sysadmin 固定服务器角色的成员才能执行 sp_change_agent_parameter