| title | description | author | ms.author | ms.reviewer | ms.date | ms.service | ms.subservice | ms.topic | f1_keywords | helpviewer_keywords | dev_langs | ||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sp_addpublication_snapshot (Transact-SQL) |
sp_addpublication_snapshot creates the Snapshot Agent for the specified publication. |
markingmyname |
maghan |
randolphwest |
08/21/2024 |
sql |
replication |
reference |
|
|
|
[!INCLUDE SQL Server SQL MI]
Creates the Snapshot Agent for the specified publication. This stored procedure is executed at the Publisher on the publication database.
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 Configure SQL Server Database Engine for encrypting connections.
:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions
sp_addpublication_snapshot
[ @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 = ] N'publisher' ]
[ , [ @distributor_security_mode = ] distributor_security_mode ]
[ , [ @distributor_login = ] N'distributor_login' ]
[ , [ @distributor_password = ] N'distributor_password' ]
[ ; ]
The name of the publication. @publication is sysname, with no default.
The frequency with which the Snapshot Agent is executed. @frequency_type is int, and can be one of the following values.
| Value | Description |
|---|---|
1 |
Once |
4 (default) |
Daily |
8 |
Weekly |
16 |
Monthly |
32 |
Monthly, relative to the frequency interval |
64 |
When [!INCLUDE ssNoVersion] Agent starts |
128 |
Run when the computer is idle |
The value to apply to the frequency set by @frequency_type. @frequency_interval is int, and can be one of the following values.
| Value of frequency_type | Effect on frequency_interval |
|---|---|
1 |
@frequency_interval is unused. |
4 (default) |
Every @frequency_interval days, with a default of daily. |
8 |
@frequency_interval is one or more of the following (combined with a | (Bitwise OR) logical operator):1 = Sunday |2 = Monday |4 = Tuesday |8 = Wednesday |16 = Thursday |32 = Friday |64 = Saturday |
16 |
On the @frequency_interval day of the month. |
32 |
@frequency_interval is one of the following values:1 = Sunday |2 = Monday |3 = Tuesday |4 = Wednesday |5 = Thursday |6 = Friday |7 = Saturday |8 = Day |9 = Weekday |10 = Weekend day |
64 |
@frequency_interval is unused. |
128 |
@frequency_interval is unused. |
The unit for freq_subday_interval. @frequency_subday is int, and can be one of these values.
| Value | Description |
|---|---|
1 |
Once |
2 |
Second |
4 (default) |
Minute |
8 |
Hour |
The interval for frequency_subday, in minutes. @frequency_subday_interval is int, with a default of 5.
The date the Snapshot Agent runs. @frequency_relative_interval is int, with a default of 1.
The recurrence factor used by frequency_type. @frequency_recurrence_factor is int, with a default of 0.
The date when the Snapshot Agent is first scheduled, formatted as yyyyMMdd. @active_start_date is int, with a default of 0.
The date when the Snapshot Agent stops being scheduled, formatted as yyyyMMdd. @active_end_date is int, with a default of 99991231,which means December 31, 9999.
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 0.
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 235959, which means 11:59:59 P.M. as measured on a 24-hour clock.
The name of an existing Snapshot Agent job name if an existing job is being used. @snapshot_job_name is nvarchar(100), with a default of NULL. This parameter is for internal use and shouldn't be specified when creating a new publication. If @snapshot_agent_name is specified, then @job_login and @job_password must be NULL.
[!INCLUDE entra-id]
The the security mode used by the agent when connecting to the Publisher. @publisher_security_mode is int, with a default of 1. A value of 0 must be specified for non-[!INCLUDE ssNoVersion] Publishers. [!INCLUDE ssNoteWinAuthentication]. The following values define the security mode:
0specifies [!INCLUDE ssNoVersion] authentication.1specifies Windows authentication.2specifies Microsoft Entra password authentication, starting with [!INCLUDE sssql22-md] CU 6.3specifies Microsoft Entra integrated authentication, starting with [!INCLUDE sssql22-md] CU 6.4specifies Microsoft Entra token authentication, starting with [!INCLUDE sssql22-md] CU 6.
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 account specified in @job_login is used when connecting to the Publisher.
The password used when connecting to the Publisher. @publisher_password is sysname, with a default of NULL.
Important
Don't store authentication information in script files. To help improve security, we recommend that you provide login names and passwords at run time.
The login for the account under which the agent runs. On Azure SQL Managed Instance, use a SQL Server account. @job_login is nvarchar(257), with a default of NULL. This account is always used for agent connections to the Distributor. You must supply this parameter when creating a new Snapshot Agent job.
For non-[!INCLUDE ssNoVersion] Publishers, this must be the same login specified in sp_adddistpublisher.
The password for the Windows account under which the agent runs. @job_password is sysname, with no default. You must supply this parameter when creating a new Snapshot Agent job.
Important
Don't store authentication information in script files. To help improve security, we recommend that you provide login names and passwords at run time.
Specifies a non-[!INCLUDE ssNoVersion] Publisher. @publisher is sysname, with a default of NULL.
@publisher shouldn't be used when creating a Snapshot Agent at a [!INCLUDE ssNoVersion] Publisher.
[!INCLUDE ssinternalonly-md]
[!INCLUDE ssinternalonly-md]
[!INCLUDE ssinternalonly-md]
0 (success) or 1 (failure).
sp_addpublication_snapshot is used in snapshot replication, transactional replication, and merge replication.
:::code language="sql" source="../replication/codesnippet/tsql/sp-addpublication-snapsh_1.sql":::
Only members of the sysadmin fixed server role or db_owner fixed database role can execute sp_addpublication_snapshot.