Edit

Share via

sp_startpublication_snapshot (Transact-SQL)

  • Article

Applies to: SQL Server

Used to start the Snapshot Agent job that generates the initial snapshot for a publication. This stored procedure is executed at the Publisher on the publication database.

Transact-SQL syntax conventions

Syntax

sp_startpublication_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'

The name of a non-SQL Server Publisher. @publisher is sysname, with a default of NULL. You shouldn't specify this parameter for a SQL Server Publisher.

Return code values

0 (success) or 1 (failure).

Remarks

sp_startpublication_snapshot is used with all types of replication.

For a non-SQL Server Publisher, this stored procedure is executed at the Distributor on the distribution database.

Permissions

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

Related content