sp_MSchange_snapshot_agent_properties (Transact-SQL)

適用対象: SQL Server

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

Transact-SQL 構文表記規則

構文

sp_MSchange_snapshot_agent_properties
    [ @publisher = ] N'publisher'
    , [ @publisher_db = ] N'publisher_db'
    , [ @publication = ] N'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 = ] N'snapshot_job_name'
    , [ @publisher_security_mode = ] publisher_security_mode
    , [ @publisher_login = ] N'publisher_login'
    , [ @publisher_password = ] N'publisher_password'
    , [ @job_login = ] N'job_login'
    , [ @job_password = ] N'job_password'
    , [ @publisher_type = ] N'publisher_type'
[ ; ]

引数

[ @publisher = ] N'publisher'

パブリッシャーの名前。 @publisher は sysname で、既定値はありません。

[ @publisher_db = ] N'publisher_db'

パブリケーション データベースの名前。 @publisher_db は sysname で、既定値はありません。

[ @publication = ] N'publication'

出版物の名前。 @publication は sysname で、既定値はありません。

[ @frequency_type = ] frequency_type

スナップショット エージェントを実行する頻度を指定します。 @frequency_type は int であり、これらの値のいずれかを指定できます。

Value	説明
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

@frequency_subday_intervalの単位。 @frequency_subday は int であり、これらの値のいずれかを指定できます。

Value	説明
1	1 回。
2	Second
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 = ] N'snapshot_job_name'

既存のジョブが使用されている場合は、既存のスナップショット エージェント ジョブ名の名前。 @snapshot_job_name は nvarchar(100)で、既定値はありません。

[ @publisher_security_mode = ] publisher_security_mode

パブリッシャーに接続するときにエージェントによって使用されるセキュリティ モード。 @publisher_security_mode は int で、既定値はありません。 SQL Server 以外のパブリッシャーには、 0 の値を指定する必要があります。

• 0 は SQL Server 認証を指定します
• 1Windows 認証を指定します

可能な場合は、Windows 認証を使用します。

[ @publisher_login = ] N'publisher_login'

パブリッシャーに接続するときに使用されるログイン。 @publisher_login は sysname で、既定値はありません。 @publisher_security_modeが0されている場合は、@publisher_loginを指定する必要があります。 @publisher_loginがNULLされ、@publisher_security_modeが1されている場合、@job_loginで指定された Windows アカウントがパブリッシャーに接続するときに使用されます。

[ @publisher_password = ] N'publisher_password'

パブリッシャーに接続するときに使用するパスワード。 @publisher_password は nvarchar(524)で、既定値はありません。

重要

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

[ @job_login = ] N'job_login'

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

[ @job_password = ] N'job_password'

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

重要

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

[ @publisher_type = ] N'publisher_type'

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

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

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

リターン コードの値

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

解説

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

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

パブリッシャーでsp_changepublication_snapshotを使用して、スナップショット エージェント ジョブのプロパティを変更できます。

アクセス許可

ディストリビューターの固定サーバー ロールsysadmin のメンバーのみがsp_MSchange_snapshot_agent_propertiesを実行できます。

関連するコンテンツ

• sp_addpublication_snapshot (Transact-SQL)