Implementing Master-Subordinate Snapshot Replication Using SQL Server
This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist. Please see the patterns & practices guidance for the most current information.
You want to implement the design pattern Master-Subordinate Snapshot Replication. You are replicating between two Microsoft SQL Server databases, and you want to take advantage of the integrated functionality of SQL Server. The replication set consists of entire rows, not just changes that have occurred to rows since the last replication. Any changes to the replication data at the target that may have occurred since the last transmission will be overwritten by a new transmission.
Note: This pattern uses terms and concepts introduced in the following patterns:
Before introducing the implementation with SQL Server, this pattern covers the following topics:
A summary of the replication building block as described in the Master-Subordinate Replication pattern
The SQL Server replication services that this pattern uses (SQL Server snapshot replication)
The mapping of the elements of the replication building block to the services of SQL Server
Replication Building Block
The replication building block used in the Master-Subordinate Snapshot Replication pattern consists of a source and a target that are connected by a replication link, as Figure 1 shows.
Figure 1: Replication building block for Master-Subordinate Snapshot Replication
The source contains the replication set, which is the data to be copied from the source and sent across a data movement link to the target.
The Acquire service reads the rows to be replicated.
The Manipulate service performs simple data transformations, such as data type conversions and splitting or combining columns.
The Write service updates the target with the manipulated rows.
The target is the database where the replication set is to be written.
Moving the replication set from source to target according to defined functional and operational requirements is called a transmission.
SQL Server Snapshot Replication
SQL Server replication uses several standard services to move data from a publication database to a subscription database. Figure 2 shows the services and processes involved in SQL Server snapshot replication.
Figure 2: SQL Server snapshot replication
SQL Server defines three roles for the platforms involved in the replication:
Publisher. The Publisher contains the source. In this environment, the Subscriber defines the replication set (publication) to be replicated.
Distributor. The Distributor holds a distribution database that is used for storing replication metadata. The Snapshot Agent runs on the Distributor and creates the snapshot files from the publication. In a push subscription, the Distributor also runs the Distribution Agent. Additionally, the cleanup jobs for managing the distribution database run here.
Subscriber. The Subscriber contains the target and creates a subscription for the publication. In a pull subscription, the Subscriber runs the Distribution Agent.
The Distributor does not necessarily need to be a separate platform. Its role can also be assigned to the Publisher, where it is called a local Distributor. Otherwise, it is called a remote Distributor.
SQL Server snapshot replication contains two processes:
Snapshot Agent. The Snapshot Agent reads all the articles of a publication and writes the schema and data to a set of snapshot files. The snapshot files are stored in a shared snapshot folder. The folder is typically located on the Distributor, but in general it can be any shared folder that is accessible by both source and target.
Distribution Agent. The Distribution Agent may run on the Subscriber (pull subscription), or it may run on the distributor (push subscription). The Distribution Agent reads the snapshot file from the shared snapshot folder and writes its content to the target. Before actually writing the data, it can be manipulated by using a data transmission service (DTS) package that the Subscriber defines.
Note: The Distribution Agent may serve several Subscribers, but this pattern considers only a single Subscriber.
Independent of the replication processes, cleanup jobs run on the distribution database and perform the following tasks:
Agent History Clean Up: Distribution. Removes replication agent history from the distribution database.
Distribution Clean Up: Distribution. Removes replicated transactions from the distribution database.
Expired Subscription Clean Up. Detects and removes expired subscriptions from publication databases.
Reinitialize Subscriptions Having Data Validation Failures. Reinitializes all subscriptions that have data validation failures.
Replication Agents Checkup. Detects replication agents that are not actively logging history.
Mapping the Replication Building Block to SQL Server
Figure 3 shows how the elements of the replication building block correspond to those of a SQL Server snapshot replication.
Figure 3: SQL Server implementation of the replication building block
The source is the publication database that contains the publication to be replicated and takes on the role of the Publisher.
In SQL Server, the replication set to be transmitted from the Publisher to the Subscriber is called a publication. A publication consists of one or more tables, or only parts of tables. Parts of tables can be defined by:
Filtering the rows to be replicated by defining a search condition.
In the theory of relational databases, the result is called a restriction.
Filtering the columns to be replicated as a subset of the table's columns.
In the theory of relational databases, the result is called a projection.
The Snapshot Agent reads all of the data from the defined publication into snapshot files and stores them in a shared snapshot folder.
The Distribution Agent can manipulate data before the data is written to the target. When the target registers its subscription to the Distributor, it can define a DTS package that the Distributor will call before sending the data to the Subscriber. Each Subscriber can use its own package; different Subscribers can get various views of the same data.
Within a DTS package, you can define any manipulations using the data of the current row and the possibilities of an ActiveX script language. Each row from the source can result in only one row at the target, or it can be skipped. Fields can be split or combined. Additionally, any kind of data type conversions and changes of field names can be done.
The Distribution Agent writes the contents of the snapshot file to the target. The agent reads the snapshot file from the shared snapshot folder and applies the schema and the data to the target. Name conflicts during the write can be resolved in different ways. The default option in a snapshot replication is to drop the existing table and recreate it from the snapshot file. Another option is to leave the table on the target unchanged and reject the relevant data in the snapshot file. The last option is to delete the data on the target and use the empty table to write only the data from the snapshot file. In the case of using the existing table, the schema information from the snapshot file is not needed.
The target is the subscription database, where the transmitted and possibly manipulated replication set is written. The target takes on the role of the Subscriber.
To set up a new replication link, follow these steps:
1.Configure the Distributor:
a.Create the distribution database. This is an internal SQL Server database used from the Distributor. In most cases, you use the default options to create this database, but you can also customize it.
b.Choose the snapshot folder. You can either choose the default folder for exchanging the initial snapshot files or use a custom folder.
c.Set up the Subscriber parameter: To define the default parameter for all Subscribers, you can confirm the offered configuration options or customize them.
2.Define the publication:
a.Select the publication database that includes the publication.
b.Decide if you want to transform the data during the transmission. If so, any Subscriber must have a DTS package for the transformation.
c.Select the possible database systems the Subscribers will use: SQL Server 2000 or earlier versions of SQL Server.
d.For each table, specify whether the entire table should be replicated, or restrict the table by specifying horizontal and vertical filters.
e.Decide whether anonymous Subscribers are allowed to subscribe to the publication.
f.Decide how often the Snapshot Agent creates new snapshots.
3.Create a DTS package for the transformation, if you have decided to use one.
4.Define the subscription:
a.Decide if you want a pull or a push subscription.
b.Select the publication you want to subscribe to.
c.Choose the subscription database.
d.If you want to start the transmission automatically, define a schedule.
e.Specify the DTS package you want to use for this subscriber.
f.Verify that all required services are started.
At this point, all elements of the replication link have been configured. From now on, both the publication database and the subscription database will log all changes to the specified replication set using triggers.
The SQL Server snapshot replication runs different jobs:
Snapshot Agent: Creates the initial snapshot from the Publisher.
Distribution Agent: Applies the snapshots on the Subscriber.
Cleanup jobs: Clean up the distribution database on the Distributor.
The example that follows describes in detail how to use the SQL Server wizards to set up such a replication link.
This example shows how to configure snapshot replication based on a particular replication set. The replication set used here is the authors table from the pubs sample database, which is delivered with SQL Server.
The environment has two SQL Server computers: PUB_SERVER and SUBS_SERVER. The Publisher has a database, PUB_DB, that contains the authors table from the pubs sample database. The Subscriber has an empty database, SUBS_DB. (See Figure 4.)
Figure 4: Example environment
The introduced configuration describes a snapshot replication using pull subscription where the Subscriber initiates the replication every two hours. The data from the Publisher will be manipulated during the replication. The first and the last name from the authors table will be converted to uppercase.
Configuring the Publisher and the Distributor
To set up the example environment, follow these steps in the Configure Publishing and Distribution Wizard.
1.In SQL Server Enterprise Manager, select the publication database server, right-click Replication, and then click Configure Publishing, Subscribers and Distribution.
2.On the Select Distributor page, select Make Pub_Server its own Distributor, where Pub_Server is the name of the server you want to configure as a Distributor. Click Next.
Note: The Distributor can be located on the same server as the Publisher, in which case it is called a local Distributor, or on a remote server. This example uses a local Distributor.
3.On the Specify Snapshot Folder page, type the name of a shared folder on the Distributor where the Snapshot Agent can store snapshot files.
Note: It is recommended that you use a manually defined snapshot folder because the default uses a system internal share, such as C$. These shares are used for administrative purposes.
4.On the Customize the Configuration page, select No, use the following default settings to create a default distribution database.
Note: In this simple example, it is sufficient to use the default settings. In a more complex environment, you should manually configure the distribution database.
Creating a Publication
Next, use the Create Publication Wizard to create a publication on the Publisher.
1.In SQL Server Enterprise Manager, select the publication database server, expand Replication, right-click Publications, and then click New Publication.
2.On the Welcome Screen, check the Show advanced options check box to use this wizard with the advanced options needed to enable a transformation of the data.
3.On the Choose Publication Database page, select Pub_DBas the publication database, where Pub_DB is the name of your database for the replication.
4.On the Select Publication Type page, select Snapshot Publication to create a publication for a snapshot replication.
5.You do not want to allow the replication of changes from the subscriber to the publisher; therefore, ensure that no option is selected on the Updateable Subscription page.
6.On the Transform Published Data page, select Yes, transform the data to enable the transformation during the replication.
7.On the Specify Subscriber Types page, select only Servers running SQL Server 2000.
8.The Specify Articles page shows possible objects for replication in the publication database. From the Object Type Tables list, select the table authors.
Note: Clicking the ellipses ( ... ) button for each object shows additional properties for the replication. You do not need them in this example.
9.On the Select Publication Name and Description page, specify the Publication name as example. The default publication description can be used.
10.On the Customize the Properties of the Publication page, select the option beginning with Yes, I will define, because you need a special schedule for the Snapshot Agent.
11.The Filter Data page allows you to specify filters for the data. Since this is not necessary in this example, click Next.
12.On the Allow Anonymous Subscriptions page, select No, allow only named subscriptions to prohibit anonymous access in this example.
Note: Anonymous subscriptions are pull subscriptions from Subscribers that are not registered on the Publisher. If you want to allow anonymous subscriptions, you must change this option.
13.On the Set Snapshot AgentSchedule page, click Change to specify a new schedule for the Snapshot Agent.
14.On the Edit Recurring Job Schedule page, define the schedule for the Snapshot Agent as a daily run with an interval of two hours. (See Figure 5.)
Figure 5: Edit Recurring Job Schedule page
15.On the Completing the Create Publication Wizard page, review the options for the specified publication. Click Finish to create the publication with these options.
Defining a DTS Package for the Transformation
Before you can create a subscription to the defined publication, you must create a DTS package for the transformation.
1.In SQL Server Enterprise Manager, select the publication database server, expand Replication, open Publications, right-click the example:pub_db replication, and then click Properties.
2.On the Publication Properties page, click the Subscriptions tab, and then click Transformations.
3.On the Welcome Screen, click Next.
4.On the Choose a Destination page, select the target server and database. (See Figure 6.)
Figure 6: Choose a Destination page
5.On the Define Transformations page, click the ellipses ( ... ) button from the article authors.
6.On the Column Mappings tab of the Column Mappings and Transformations page, select Drop the existing table and recreate it from the list box. Leave the mappings unchanged. (See Figure 7.)
Figure 7: Column Mappings tab on the Column Mappings and Transformations page
7.Click the Transformations tab. Click Transform data using the following script and select VB Script Language from the list box. (See Figure 8.)
Figure 8: Transformations tab on the Column Mappings and Transformations page
8.Use the following code to transform the first and the last name of the author to uppercase:
Function Main() DTSDestination("au_id") = DTSSource("au_id") DTSDestination("au_lname") = UCase(DTSSource("au_lname")) DTSDestination("au_fname") = UCase(DTSSource("au_fname")) DTSDestination("phone") = DTSSource("phone") DTSDestination("address") = DTSSource("address") DTSDestination("city") = DTSSource("city") DTSDestination("state") = DTSSource("state") DTSDestination("zip") = DTSSource("zip") DTSDestination("contract") = DTSSource("contract") Main = DTSTransformStat_OK End Function
9.On the DTS Package Location page, select the option to save the package on the Distributor. Use the SQL Server authentication option, and insert the user and the password to connect to the Distributor.
10.On the DTS Package Identification page, specify the name of the package. In this example, the name should be transform_sub. You do not need to define an owner password.
11.,On the Completing the Transform Published Data Wizard page, click Finish to save the package as specified.
Creating a Subscription
To complete the configuration, you must create a pull subscription of the defined publication on the target.
1.In SQL Server Enterprise Manager, select the target database server, expand Replication, right-click Subscriptions, and then click New Pull Subscription.
2.On the Welcome Screen, click Next.
3.On the Look for Publications page, select Look at publications from registered servers.
4.On the Choose Publication page, expand PUB_SERVER and select the publication named example:pub_db, where PUB_SERVER is the name of your Publisher and example:pub_db is the name of your publication. (See Figure 9.)
Figure 9: Choose Publication page
5.On the Specify Synchronization Agent Login page, select Use SQL Server Authentication. Enter the login and the password of a user account that is used to connect to the Publisher during the replication.
6.On the Choose Destination Database page, select Subs_DB as the database for the subscription, where Subs_DB is the name of your target database.
7.On the Initialize Subscription page, the option Yes, initialize the schema and the data cannot be changed because you use a snapshot replication.
8.On the Snapshot Delivery page, specify the snapshot folder. This example uses the default folder of the publication.
9.On the Set Distribution AgentSchedule page, select Using the following schedule and click Change to specify a new schedule for the Distribution Agent.
10.On the Edit Recurring Job Schedule page, define the schedule for the Distribution Agent as a daily run with an interval of two hours. (See Figure 10.)
Figure 10: Edit Recurring Job Schedule page
11.On the Specify DTS Package page, select Distributor and click List packages. For the transformation, select the transform_sub package you created previously. (See Figure 11.)
Figure 11: Specify DTS Package page
12.The Start Required Services page shows the status of the SQL Server Agent on the Subscriber. If the SQL Server Agent is not running, select the check box next to the entry for the agent. The agent will be started after the wizard creates the subscription.
13.On the Completing the Pull Subscription Wizard page, review the options for the specified subscription. Click Finish to create the subscription with these options.
Starting and Restarting the Snapshot Replication
To start or restart the snapshot replication manually for testing purposes, follow these steps:
1.In SQL Server Enterprise Manager, select the publication database server, open Replication Monitor, select Publishers, Pub_Server, and open the publication example:pub_db.
2.Right-click Snapshot Agent and click Start Agent to create an initial snapshot.
3.Right-click SUBS_Server:subs_db and select Start Synchronizing to start the replication.
The replication usually runs on a defined schedule. If you want to test the replication or start the snapshot replication immediately, however, you need to start the replication manually.
Testing the Example
You can easily test the functionality of the implemented snapshot replication by changing some data in the publication, starting the replication process, and checking to see if the subscription database has changed accordingly.
To check various kinds of data changes, perform INSERT, UPDATE, and DELETE operations on the data in the publication.
1.Change data in the publication. For example:
UPDATE authors SET au_lname = 'Smith' WHERE au_id = '807-91-6654' INSERT INTO authors (au_id, au_lname, au_fname, phone, contract) VALUES ('453-12-3255', 'Smith', 'John', '400 486-234', 1) DELETE FROM authors WHERE au_id = '672-71-3249'
2.Manually start the replication process.
3.Check to see if the rows changed in the subscription database. For example:
SELECT * FROM authors
This implementation has all benefits and liabilities of the Snapshot Replication pattern. This section describes additional benefits and liabilities.
Compressed snapshots. SQL Server gives you the option of compressing the snapshot file. This option is useful when you have to transmit the snapshot over a slow communications link, or when the snapshot file will not fit on removable media. Using compressed snapshots saves disk space, which decreases transmission time and network load.
Integrated into SQL Server Enterpise Manager. The configuration and execution of a replication in SQL Server is integrated into the SQL Server administration and can be easily done with SQL Server Enterprise Manager.
Disk space requirements for snapshots. Because SQL Server stores the snapshot file in a separate folder and the file grows with the volume of the replication set, you must provide an appropriate amount of free disk space.
Overhead of compressing snapshots. The disadvantage of compressing snapshots is that this option increases the time required to generate and apply snapshots.
Additional database to be managed. The implementation requires the distribution database as an additional database that must be managed.
Hint: This pattern is appropriate for replication sets that change infrequently, or for those with a substantial amount of changed data. It is also often used to distribute read-only copies of data as it appears at a specific moment in time (for example, for analytical purposes such as decision support).
This pattern is also frequently used to populate a database for the first time. In cases where you must transmit a large volume of data to the target, you can use removable media instead of a communications link.
After you set up the replication link as described in pattern, you must test it thoroughly. Your test cases should cover the following scenarios at a minimum:
Correct transmission of the snapshot that includes the replication set
Network interruption between the distribution database and the subscription database during a running transmission
A hard abort of the subscription database during a running transmission
After each test, make sure that the subscription database is in the correct state.
To secure the connection between the Distributor and the Subscribers, do one of the following:
Use a SQL Server user account to connect to the Distributor.
Place all computers in one Windows domain, or have a common user with the same password on all computers. Then use a trusted Windows connection between Distributor and Subscribers.
Note: The SQL Server Agents on all systems must run on a local or a domain account, not on the local system account. Otherwise, the replication will not work.
Snapshot data can reside in places other than the source and target data. Use the same security standards for snapshot data that you use for other data in the replication.
The SQL Server Agent manages the different jobs of the replication. Schedules for these jobs are defined during the configuration. Alternatively, you can start each job manually using the SQL Server Enterprise Manager.
The Replication Monitor in SQL Server Enterprise Manager provides the following information:
A list of all publications and attached agents with the time and the duration of the last execution and information about the last action
A list of all agents grouped by task with current status and a history of actions
The event log entries created by Replication Alerts, which monitor the replication process
If the replication fails, do the following:
Check to see if the accounts have network access rights.
Check the history of the subscription to determine the reason the synchronization failed.
Check the Replication Monitor for highlighted replication failures.
The connections between the Publisher and its Subscribers must be able to manage the load. If the Publisher sends its data to Subscribers over a slow or expensive communications link, using the republisher model will improve replication. In any case, the Publisher must be connected to remote Distributors by reliable, high-speed communications links.
Hint: An alternative for the transmission of the replication set to use removable media to transmit the snapshot from source to target.
For more information, see the following related patterns.
Patterns that May Have Led You Here
Move Copy of Data. This pattern is the root pattern of this cluster; it presents the overall architecture for maintaining copies of data.
Data Replication. This pattern presents the architecture of data replication, which is a particular way of moving copies of data.
Master-Subordinate Replication. This pattern describes design considerations for transmitting data from the source to the target by overwriting potential changes in the target on a higher level than the Master-Subordinate Snapshot Replication.
Master-Subordinate Snapshot Replication. This pattern presents a solution that transmits the whole replication set from the source to the target on each transmission.
Other Patterns of Interest
Implementing Master-Subordinate Transactional Incremental Replication Using SQL Server. This pattern uses a snapshot replication to prepare the target.
Implementing Master-Master Row-Level Synchronization Using SQL Server. This pattern uses a snapshot replication to prepare the target.
This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.