Looking for ways to do things more quickly and efficiently, I thought I would talk a little bit about sp_addscriptexec and how it can be leveraged to expedite the process of executing SQL scripts in a replication topology. By creating and saving a SQL script on a publisher, it can then be distributed to and executed on UNC/FTP deployed subscribers using sp_addscriptexec.
The syntax for sp_addscriptexec per BOL
sp_addscriptexec [ @publication = ] publication
[ , [ @scriptfile = ] 'scriptfile' ]
[ , [ @skiperror = ] 'skiperror' ]
[ , [ @publisher = ] 'publisher' ]
The problem with numbers
If you’re dealing with a large number of subscribers, database administration can be tricky. Tasks such as adding logins and users, granting permissions, maintaining indexes, and managing constraints must be done individually at each node and deploying all of the scripts can be very time consuming. Rather than visit each node, sp_addscriptexec should be used to post the ad-hoc script to all subscribers in the topology, saving valuable time. Put simply – if you’re visiting each node to execute a script, you’re doing it wrong.
The benefit with using sp_addscriptexec is that the publisher can act as a centralized script repository. Scripts can be saved to the publisher and executed on demand for subscribers. This process is quicker and more efficient than copying, saving, and executing scripts directly at each subscriber. Not only does this save time, but space as well.
Applying scripts to subscribers from the publisher can be done by:
- Create and test the script
- Save the script to the publisher
- Execute sp_addscriptexec at the publisher to apply script to subscribers
From here, the script will be executed at each subscriber on the next synchronization. Taking this one step further — to limit a script to run on only certain subscribers, a check for HOST_NAME can be performed in the script.
-- Limit script to Subscriber1, Subscriber2, and Subscriber3 IF HOST_NAME() IN ('Subscriber1', 'Subscriber2', 'Subscriber3') -- script goes here
Something to consider
A caveat with sp_addscriptexec is that by default, if the script being executed encounters an error at the subscriber, the replication agent will fail and retry on subsequent syncs in an endless loop, be aware of this. This behavior can be overridden by passing a value of 1 for @skiperror which instructs the agent to skip errors. At the very least, SQL scripts should be tested thoroughly at the publisher before calling sp_addscriptexec to apply them to subscribers.