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

  • 出力

  • 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_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 固定サーバー ロールのメンバーだけです。

関連項目

参照

レプリケーション エージェント プロファイル

レプリケーション ディストリビューション エージェント

レプリケーション ログ リーダー エージェント

レプリケーション マージ エージェント

レプリケーション キュー リーダー エージェント

レプリケーション スナップショット エージェント

sp_add_agent_parameter (Transact-SQL)

sp_drop_agent_parameter (Transact-SQL)

sp_help_agent_parameter (Transact-SQL)

システム ストアド プロシージャ (Transact-SQL)