sp_startpublication_snapshot (Transact-SQL)

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.

Topic link iconTransact-SQL Syntax Conventions

Syntax

sp_startpublication_snapshot [ @publication= ] 'publication' 
    [ , [ @publisher= ] 'publisher' ]

Arguments

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

  • [ **@publisher=** ] 'publisher'
    Is the name of a non-SQL Server Publisher. publisher is sysname, with a default value of NULL. You should not 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.