Share via

sp_copysnapshot (Transact-SQL)

  • Article

Copies the snapshot folder of the specified publication to the folder listed in the @destination_folder. This stored procedure is executed at the Publisher on the publication database. This stored procedure is useful for copying a snapshot to removable media, such as CD-ROM.

Topic link icon Transact-SQL Syntax Conventions

Syntax


sp_copysnapshot [ @publication = ] 'publication', [ @destination_folder = ] 'destination_folder' ]
    [ , [ @subscriber = ] 'subscriber' ]
    [ , [ @subscriber_db = ] 'subscriber_db' ]

Arguments

  • [ @publication=] 'publication'
    Is the name of the publication whose snapshot contents are to be copied. publication is sysname, with no default.

  • [ @destination_folder=] 'destination_folder'
    Is the name of the folder where the contents of the publication snapshot are to be copied. destination_folderis nvarchar(255), with no default. The destination_folder can be an alternate location such as on another server, on a network drive, or on removable media (such as CD-ROMs or removable disks).

  • [ @subscriber=] 'subscriber'
    Is the name of the Subscriber. subscriber is sysname, with a default of NULL.

  • [ @subscriber_db=] 'subscriber_db'
    Is the name of the subscription database. subscriber_db is sysname, with a default of NULL.

Return Code Values

0 (success) or 1 (failure)

Remarks

sp_copysnapshot is used in all types of replication. Subscribers running Microsoft SQL Server version 7.0 and earlier cannot use the alternate snapshot location.

Permissions

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

See Also

Reference

System Stored Procedures (Transact-SQL)

Concepts

Alternate Snapshot Folder Locations