sp_MSchange_snapshot_agent_properties (Transact-SQL)

Microsoft SQL Server 2005 以降のバージョンのディストリビューターで実行されるスナップショット エージェント ジョブのプロパティを変更します。 このストアド プロシージャは、パブリッシャーが Microsoft SQL Server 2000 インスタンスで実行されている場合に、プロパティを変更するときに使用します。 このストアド プロシージャは、ディストリビューター側でディストリビューション データベースについて実行されます。

Transact-SQL 構文表記規則

構文

sp_MSchange_snapshot_agent_properties [ @publisher = ] 'publisher' 
        , [ @publisher_db = ] 'publisher_db' 
        , [ @publication = ] 'publication'  
        , [ @frequency_type= ] frequency_type 
        , [ @frequency_interval= ] frequency_interval 
        , [ @frequency_subday= ] frequency_subday 
        , [ @frequency_subday_interval= ] frequency_subday_interval 
        , [ @frequency_relative_interval= ] frequency_relative_interval 
        , [ @frequency_recurrence_factor= ] frequency_recurrence_factor 
        , [ @active_start_date= ] active_start_date 
        , [ @active_end_date= ] active_end_date 
        , [ @active_start_time_of_day= ] active_start_time_of_day 
        , [ @active_end_time_of_day= ] active_end_time_of_day 
        , [ @snapshot_job_name = ] 'snapshot_agent_name' 
        , [ @publisher_security_mode = ] publisher_security_mode 
        , [ @publisher_login = ] 'publisher_login' 
        , [ @publisher_password = ] 'publisher_password'  
        , [ @job_login = ] 'job_login' 
        , [ @job_password = ] 'job_password' 
        , [ @publisher_type = ] 'publisher_type'

引数

• [ @publisher = ] 'publisher'
  パブリッシャーの名前です。 publisher のデータ型は sysname で、既定値はありません。

• [ @publisher_db= ] 'publisher_db'
  パブリケーション データベースの名前を指定します。 publisher_db のデータ型は sysname で、既定値はありません。

• [ @publication = ] 'publication'
  パブリケーションの名前です。 publication のデータ型は sysname で、既定値はありません。

• [ @frequency_type = ] frequency_type
  スナップショット エージェントの実行頻度を指定します。 frequency_type のデータ型は int で、次のいずれかの値を指定できます。

  値	説明
  1	1 回
  2	要求時
  4	毎日
  8	毎週
  10	毎月
  20	frequency_interval を基準とした月単位
  40	SQL Server エージェントの起動時

• [ @frequency_interval = ] frequency_interval
  frequency_type で設定した頻度に適用される値を指定します。 frequency_interval のデータ型は int で、既定値はありません。

• [ @frequency_subday = ] frequency_subday
  freq_subday_interval の単位を指定します。 frequency_subday のデータ型は int で、次のいずれかの値を指定できます。

  値	説明
  1	1 回
  2	秒
  4	分
  8	時

• [ @frequency_subday_interval=] frequency_subday_interval
  frequency_subday の間隔を指定します。 frequency_subday_interval のデータ型は int で、既定値はありません。

• [ @frequency_relative_interval = ] frequency_relative_interval
  スナップショット エージェントを実行する日付を指定します。 frequency_relative_interval のデータ型は int で、既定値はありません。

• [ @frequency_recurrence_factor = ] frequency_recurrence_factor
  frequency_type で使用される定期実行係数を指定します。 frequency_recurrence_factor のデータ型は int で、既定値はありません。

• [ @active_start_date = ] active_start_date
  スナップショット エージェントを最初にスケジュール設定する日付を、YYYYMMDD 形式で指定します。 active_start_date のデータ型は int で、既定値はありません。

• [ @active_end_date = ] active_end_date
  スナップショット エージェントのスケジュール設定を停止する日付を、YYYYMMDD 形式で指定します。 active_end_date のデータ型は int で、既定値はありません。

• [ @active_start_time_of_day=] active_start_time_of_day
  スナップショット エージェントを最初にスケジュール設定する時刻を HHMMSS 形式で指定します。 active_start_time_of_day のデータ型は int で、既定値はありません。

• [ @active_end_time_of_day=] active_end_time_of_day
  スナップショット エージェントのスケジュール設定を停止する時刻を HHMMSS 形式で指定します。 active_end_time_of_day のデータ型は int で、既定値はありません。

• [ @snapshot_job_name = ] 'snapshot_agent_name'
  既存のジョブが使用されている場合、既存のスナップショット エージェントのジョブ名を指定します。 snapshot_agent_name のデータ型は nvarchar(100) で、既定値はありません。

• [ @publisher_security_mode= ] publisher_security_mode
  パブリッシャーへの接続時にエージェントが使用するセキュリティ モードを指定します。 publisher_security_mode のデータ型は int で、既定値はありません。 0 は、SQL Server 認証を、1 は Windows 認証をそれぞれ指定します。 SQL Server 以外のパブリッシャーに対しては、値 0 を指定する必要があります。可能な場合は、Windows 認証を使用します。

• [ @publisher_login= ] 'publisher_login'
  パブリッシャーへの接続時に使用するログインを指定します。 publisher_login のデータ型は sysname で、既定値はありません。 publisher_security_mode が 0 の場合は、publisher_login を指定する必要があります。 publisher_login が NULL で publisher*_*security_mode が 1 の場合、パブリッシャーへの接続時には job_login で指定した Windows アカウントが使用されます。

• [ @publisher_password= ] 'publisher_password'
  パブリッシャーへの接続時に使用するパスワードを指定します。 publisher_password のデータ型は nvarchar(524) で、既定値はありません。

  セキュリティに関する注意
  スクリプト ファイルには認証情報を保存しないでください。 セキュリティを強化するため、実行時にログイン名とパスワードを指定することをお勧めします。

• [ @job_login= ] 'job_login'
  エージェントを実行する Windows アカウント用のログインを指定します。 job_login のデータ型は nvarchar(257) で、既定値はありません。 この Windows アカウントは、エージェントがディストリビューターに接続するときに常に使用されます。 新しいスナップショット エージェント ジョブを作成するときにはこのパラメーターを指定する必要があります。 SQL Server 以外のパブリッシャーの場合、これは変更できません。

• [ @job_password= ] 'job_password'
  エージェントを実行する Windows アカウント用のパスワードを指定します。 job_password のデータ型は sysname で、既定値はありません。 新しいスナップショット エージェント ジョブを作成するときにはこのパラメーターを指定する必要があります。

  セキュリティに関する注意
  スクリプト ファイルには認証情報を保存しないでください。 セキュリティを強化するため、実行時にログイン名とパスワードを指定することをお勧めします。

• [ @publisher_type= ] 'publisher_type'
  パブリッシャーが SQL Server のインスタンスで実行されていないときのパブリッシャーの種類を指定します。 publisher_type のデータ型は sysname で、次のいずれかの値を指定できます。

  値	説明
  MSSQLSERVER	SQL Server パブリッシャーを指定します。
  ORACLE	標準の Oracle パブリッシャーを指定します。
  ORACLE GATEWAY	Oracle ゲートウェイ パブリッシャーを指定します。

  Oracle パブリッシャーと Oracle ゲートウェイ パブリッシャーの相違点の詳細については、「Oracle パブリッシングの概要」を参照してください。

リターン コードの値

成功した場合は 0 を、失敗した場合は 1 をそれぞれ返します。

説明

sp_MSchange_snapshot_agent_properties は、スナップショット レプリケーション、トランザクション レプリケーション、マージ レプリケーションで使用されます。

sp_MSchange_snapshot_agent_properties を実行している場合は、すべてのパラメーターを指定する必要があります。 sp_helppublication_snapshot を実行して、スナップショット エージェント ジョブの現在のプロパティを返します。

パブリッシャーが SQL Server 2005 以降のバージョンのインスタンスで実行されている場合は、sp_changepublication_snapshot を使用してスナップショット エージェント ジョブのプロパティを変更する必要があります。

権限

sp_MSchange_snapshot_agent_properties を実行できるのは、ディストリビューターの固定サーバー ロール sysadmin のメンバーだけです。

関連項目

参照

sp_addpublication_snapshot (Transact-SQL)