sp_change_agent_parameter (Transact-SQL)

適用対象: SQL Server Azure SQL Managed Instance

MSagent_parameters システム テーブルに格納されているレプリケーション エージェント プロファイルのパラメーターを変更します。 このストアド プロシージャは、エージェントが実行されているディストリビューターで、任意のデータベースで実行されます。

Transact-SQL 構文表記規則

構文

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

引数

[ @profile_id = ] profile_id

プロファイルの ID。 @profile_id は int で、既定値はありません。

[ @parameter_name = ] N'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 = ] N'parameter_value'

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

リターン コードの値

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

解説

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

アクセス許可

sysadmin固定サーバー ロールのメンバーのみがsp_change_agent_parameterを実行できます。

関連するコンテンツ

• レプリケーション エージェント プロファイル
• Replication Distribution Agent
• レプリケーション ログ リーダー エージェント
• Replication Merge Agent
• レプリケーション キュー リーダー エージェント
• Replication Snapshot Agent
• sp_add_agent_parameter (Transact-SQL)
• sp_drop_agent_parameter (Transact-SQL)
• sp_help_agent_parameter (Transact-SQL)
• システム ストアド プロシージャ (Transact-SQL)