• [アーティクル]

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 を使用して sp_help_agent_parameters を実行し、プロファイルに関連付けられているパラメータを確認します。sp_add_agent_parameter を実行すると、プロファイルにパラメータを追加できます。

  • [ @parameter_value=] 'parameter_value'
    パラメータの新しい値を指定します。parameter_value のデータ型は nvarchar(255) で、既定値はありません。

戻り値

0 (成功) または 1 (失敗)

説明

sp_change_agent_parameter は、すべての種類のレプリケーションで使用できます。

権限

sp_change_agent_parameter を実行できるのは、sysadmin 固定サーバー ロールのメンバだけです。