TechNet
Export (0) Print
Expand All
Collapse the table of content
Expand the table of content
Expand Minimize

sp_changepublication_snapshot (Transact-SQL)

 

Applies To: SQL Server

Changes properties of the Snapshot Agent for the specified publication. This stored procedure is executed at the Publisher on the publication database.

System_CAPS_ICON_important.jpg Important


When configuring a Publisher with a remote Distributor, the values supplied for all parameters, including job_login and job_password, are sent to the Distributor as plain text. You should encrypt the connection between the Publisher and its remote Distributor before executing this stored procedure. For more information, see Enable Encrypted Connections to the Database Engine (SQL Server Configuration Manager).

Topic link icon Transact-SQL Syntax Conventions

  
sp_changepublication_snapshot [ @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 = ] 'publisher' ]  

[ @publication =] 'publication'
Is the name of the publication. publication is sysname, with no default.

[ @frequency_type =] frequency_type
Is the frequency with which to schedule the agent. frequency_type is int, and can be one of the following values.

ValueDescription
1One time
2On demand
4Daily
8Weekly
16Monthly
32Monthly relative
64Autostart
128Recurring
NULL (default)

[ @frequency_interval =] frequency_interval
Specifies the days that the agent runs. frequency_interval is int, and can be one of the following values.

ValueDescription
1Sunday
2Monday
3Tuesday
4Wednesday
5Thursday
6Friday
7Saturday
8Day
9Weekdays
10Weekend days
NULL (default)

[ @frequency_subday =] frequency_subday
Is the units for freq_subday_interval. frequency_subday is int, and can be one of these values.

ValueDescription
1Once
2Second
4Minute
8Hour
NULL (default)

[ @frequency_subday_interval =] frequency_subday_interval
Is the interval for frequency_subday. frequency_subday_interval is int, with a default of NULL.

[ @frequency_relative_interval =] frequency_relative_interval
Is the date the Snapshot Agent runs. frequency_relative_interval is int, with a default of NULL.

[ @frequency_recurrence_factor =] frequency_recurrence_factor
Is the recurrence factor used by frequency_type. frequency_recurrence_factor is int, with a default of NULL.

[ @active_start_date =] active_start_date
Is the date when the Snapshot Agent is first scheduled, formatted as YYYYMMDD. active_start_date is int, with a default of NULL.

[ @active_end_date =] active_end_date
Is the date when the Snapshot Agent stops being scheduled, formatted as YYYYMMDD. active_end_date is int, with a default of NULL.

[ @active_start_time_of_day =] active_start_time_of_day
Is the time of day when the Snapshot Agent is first scheduled, formatted as HHMMSS. active_start_time_of_day is int, with a default of NULL.

[ @active_end_time_of_day =] active_end_time_of_day
Is the time of day when the Snapshot Agent stops being scheduled, formatted as HHMMSS. active_end_time_of_day is int, with a default of NULL.

[ @snapshot_job_name = ] 'snapshot_agent_name'
Is the name of an existing Snapshot Agent job name if an existing job is being used. snapshot_agent_name is nvarchar(100) with a default value of NULL.

[ @publisher_security_mode = ] publisher_security_mode
Is the security mode used by the agent when connecting to the Publisher. publisher_security_mode is smallint, with a default of NULL. 0 specifies SQL Server Authentication, and 1 specifies Windows Authentication. A value of 0 must be specified for non-SQL Server Publishers.

System_CAPS_ICON_important.jpg Important


When possible, use Windows Authentication.

[ @publisher_login = ] 'publisher_login'
Is the login used when connecting to the Publisher. publisher_login is sysname, with a default of NULL. publisher_login must be specified when publisher_security_mode is 0. If publisher_login is NULL and publisher_security_mode is 1, then the Windows account specified in job_login is used when connecting to the Publisher.

[ @publisher_password = ] 'publisher_password'
Is the password used when connecting to the Publisher. publisher_password is sysname, with a default of NULL.

System_CAPS_ICON_important.jpg Important


Do not use a blank password. Use a strong password. When possible, prompt users to enter security credentials at runtime. If you must store credentials in a script file, you must secure the file to prevent unauthorized access.

[ @job_login = ] 'job_login'
Is the login for the Windows account under which the agent runs. job_login is nvarchar(257), with a default of NULL. This Windows account is always used for agent connections to the Distributor. You must supply this parameter when creating a new Snapshot Agent job. This cannot be changed for a non-SQL Server publisher.

[ @job_password = ] 'job_password'
Is the password for the Windows account under which the agent runs. job_password is sysname, with a default of NULL. You must supply this parameter when creating a new Snapshot Agent job.

System_CAPS_ICON_important.jpg Important


When possible, prompt users to enter security credentials at runtime. If you must store credentials in a script file, you must secure the file to prevent unauthorized access.

[ @publisher = ] 'publisher'
Specifies a non-SQL Server publisher. publisher is sysname, with a default of NULL.

System_CAPS_ICON_note.jpg Note


publisher should not be used when creating a Snapshot Agent at a SQL Server Publisher.

0 (success) or 1 (failure)

sp_changepublication_snapshot is used in snapshot replication, transactional replication, and merge replication.

Only members of the sysadmin fixed server role or db_owner fixed database role can execute sp_changepublication_snapshot.

View and Modify Publication Properties
Change Publication and Article Properties
sp_addpublication_snapshot (Transact-SQL)
System Stored Procedures (Transact-SQL)

Community Additions

ADD
Show:
© 2016 Microsoft