sp_MSchange_スナップショット_agent_properties (Transact-SQL)

適用対象:SQL Server

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

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 であり、これらの値のいずれかになります。

Value	説明設定
1	1 回。
2	オンデマンド
4	毎日
8	週次
"10"	月 1 回
20	frequency_interval を基準とした月単位
40	SQL Server エージェントの起動時

[ @frequency_interval = ] frequency_intervalfrequency_typeによって設定された頻度に適用する値です。 frequency_intervalは int で、既定値はありません。

[ @frequency_subday = ] frequency_subdayfreq_subday_intervalの単位です。 frequency_subdayは int であり、これらの値のいずれかになります。

Value	説明設定
1	1 回。
2	Second
4	分
8	時間

[ @frequency_subday_interval = ] frequency_subday_intervalfrequency_subdayの間隔です。 frequency_subday_intervalは int で、既定値はありません。

[ @frequency_relative_interval = ] frequency_relative_intervalスナップショット エージェントが実行される日付です。 frequency_relative_intervalは int で、既定値はありません。

[ @frequency_recurrence_factor = ] frequency_recurrence_factorfrequency_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'既存のジョブが使用されている場合は、既存のスナップショット エージェント ジョブ名の名前です。 スナップショット_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 であり、次のいずれかの値を指定できます。

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

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

リターン コードの値

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

解説

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

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

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

アクセス許可

sp_MSchange_スナップショット_agent_propertiesを実行できるのは、ディストリビューターの sysadmin 固定サーバー ロールのメンバーだけです。

参照

sp_addpublication_スナップショット (Transact-SQL)