sp_startpublication_snapshot (Transact-SQL)

THIS TOPIC APPLIES TO:yesSQL Server (starting with 2008)noAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

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 icon Transact-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.

See Also

Create and Apply the Initial Snapshot
sp_addpublication_snapshot (Transact-SQL)
sp_changepublication_snapshot (Transact-SQL)