sp_helppublication_snapshot (Transact-SQL)
Applies to: SQL Server Azure SQL Managed Instance
Returns information on the Snapshot agent for a given publication. This stored procedure is executed at the Publisher on the publication database.
Transact-SQL syntax conventions
Syntax
sp_helppublication_snapshot
[ @publication = ] N'publication'
[ , [ @publisher = ] N'publisher' ]
[ ; ]
Arguments
[ @publication = ] N'publication'
The name of the publication. @publication is sysname, with no default.
[ @publisher = ] N'publisher'
Specifies a non-SQL Server publisher. @publisher is sysname, with a default of NULL
.
publisher shouldn't be used when adding an article to a SQL Server Publisher.
Result set
Column name | Data type | Description |
---|---|---|
id |
int | ID of the Snapshot Agent. |
name |
nvarchar(100) | Name of the Snapshot Agent. |
publisher_security_mode |
smallint | Security mode used by the agent when connecting to the Publisher, which can be one of the following:0 = SQL Server Authentication1 = Windows Authentication. |
publisher_login |
sysname | Login used when connecting to the Publisher. |
publisher_password |
nvarchar(524) | For security reasons, a value of ********** is always returned. |
job_id |
uniqueidentifier | Unique ID of the agent job. |
job_login |
nvarchar(512) | Is the Windows account under which the Snapshot agent runs, which is returned in the format <domain>\<username> . |
job_password |
sysname | For security reasons, a value of ********** is always returned. |
schedule_name |
sysname | Name of the schedule used for this agent job. |
frequency_type |
int | Is the frequency with which the agent is scheduled to run, which can be one of these values.1 = One time2 = On demand4 = Daily8 = Weekly16 = Monthly32 = Monthly relative64 = Autostart128 = Recurring |
frequency_interval |
int | The days that the agent runs, which can be one of these values.1 = Sunday2 = Monday3 = Tuesday4 = Wednesday5 = Thursday6 = Friday7 = Saturday8 = Day9 = Weekdays10 = Weekend days |
frequency_subday_type |
int | Is the type that defines how often the agent runs when frequency_type is 4 (daily), and can be one of these values.1 = At the specified time2 = Seconds4 = Minutes8 = Hours |
frequency_subday_interval |
int | Number of intervals of frequency_subday_type that occur between scheduled execution of the agent. |
frequency_relative_interval |
int | Is the week that the agent runs in a given month when frequency_type is 32 (monthly relative), and can be one of these values.1 = First2 = Second4 = Third8 = Fourth16 = Last |
frequency_recurrence_factor |
int | Number of weeks or months between the scheduled execution of the agent. |
active_start_date |
int | Date when the agent is first scheduled to run, formatted as yyyyMMdd . |
active_end_date |
int | Date when the agent is last scheduled to run, formatted as yyyyMMdd . |
active_start_time |
int | Time when the agent is first scheduled to run, formatted as HHmmss . |
active_end_time |
int | Time when the agent is last scheduled to run, formatted as HHmmss . |
Return code values
0
(success) or 1
(failure).
Remarks
sp_help_publication_snapshot
is used in all types of replication.
Permissions
Only members of the sysadmin fixed server role at the Publisher or members of the db_owner fixed database role on the publication database can execute sp_help_publication_snapshot
.