Export (0) Print
Expand All

ReplicationServer Class

Represents an instance of Microsoft SQL Server that is involved in replication. It can take the role of Distributor, Publisher, Subscriber, or any combination of them.

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)

[GuidAttribute("5B213416-FA88-41bd-A8D5-B019888FDF47")]
public sealed class ReplicationServer : ReplicationObject

This namespace, class, or member is supported only in version 2.0 of the .NET Framework.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.

This example shows how a ReplicationServer object is used to enable publishing.

			// Set the server and database names
			string distributionDbName = "distribution";
			string publisherName = publisherInstance;
			string publicationDbName = "AdventureWorks";

			DistributionDatabase distributionDb;
			ReplicationServer distributor;
			DistributionPublisher publisher;
			ReplicationDatabase publicationDb;

			// Create a connection to the server using Windows Authentication.
			ServerConnection conn = new ServerConnection(publisherName);

			try
			{
				// Connect to the server acting as the Distributor 
				// and local Publisher.
				conn.Connect();

				// Define the distribution database at the Distributor,
				// but do not create it now.
				distributionDb = new DistributionDatabase(distributionDbName, conn);
				distributionDb.MaxDistributionRetention = 96;
				distributionDb.HistoryRetention = 120;

				// Set the Distributor properties and install the Distributor.
				// This also creates the specified distribution database.
				distributor = new ReplicationServer(conn);
				distributor.InstallDistributor((string)null, distributionDb);

				// Set the Publisher properties and install the Publisher.
				publisher = new DistributionPublisher(publisherName, conn);
				publisher.DistributionDatabase = distributionDb.Name;
				publisher.WorkingDirectory = @"\\" + publisherName + @"\repldata";
				publisher.PublisherSecurity.WindowsAuthentication = true;
				publisher.Create();

				// Enable AdventureWorks as a publication database.
				publicationDb = new ReplicationDatabase(publicationDbName, conn);

				publicationDb.EnabledTransPublishing = true;
				publicationDb.EnabledMergePublishing = true;
			}
			catch (Exception ex)
			{
				// Implement appropriate error handling here.
				throw new ApplicationException("An error occured when installing distribution and publishing.", ex);
			}
			finally
			{
				conn.Disconnect();
			}


' Set the server and database names
Dim distributionDbName As String = "distribution"
Dim publisherName As String = publisherInstance
Dim publicationDbName As String = "AdventureWorks"

Dim distributionDb As DistributionDatabase
Dim distributor As ReplicationServer
Dim publisher As DistributionPublisher
Dim publicationDb As ReplicationDatabase

' Create a connection to the server using Windows Authentication.
Dim conn As ServerConnection = New ServerConnection(publisherName)

Try
    ' Connect to the server acting as the Distributor 
    ' and local Publisher.
    conn.Connect()

    ' Define the distribution database at the Distributor,
    ' but do not create it now.
    distributionDb = New DistributionDatabase(distributionDbName, conn)
    distributionDb.MaxDistributionRetention = 96
    distributionDb.HistoryRetention = 120

    ' Set the Distributor properties and install the Distributor.
    ' This also creates the specified distribution database.
    distributor = New ReplicationServer(conn)
    distributor.InstallDistributor((CType(Nothing, String)), distributionDb)

    ' Set the Publisher properties and install the Publisher.
    publisher = New DistributionPublisher(publisherName, conn)
    publisher.DistributionDatabase = distributionDb.Name
    publisher.WorkingDirectory = "\\" + publisherName + "\repldata"
    publisher.PublisherSecurity.WindowsAuthentication = True
    publisher.Create()

    ' Enable AdventureWorks as a publication database.
    publicationDb = New ReplicationDatabase(publicationDbName, conn)

    publicationDb.EnabledTransPublishing = True
    publicationDb.EnabledMergePublishing = True

Catch ex As Exception
    ' Implement appropriate error handling here.
    Throw New ApplicationException("An error occured when installing distribution and publishing.", ex)

Finally
    conn.Disconnect()

End Try


This example shows how to use a ReplicationServer object to change Distributor properties.

			// Set the Distributor and distribution database names.
			string distributionDbName = "distribution";
			string distributorName = publisherInstance;

			ReplicationServer distributor;
			DistributionDatabase distributionDb;

			// Create a connection to the Distributor using Windows Authentication.
			ServerConnection conn = new ServerConnection(distributorName);

			try
			{
				// Open the connection. 
				conn.Connect();

				distributor = new ReplicationServer(conn);

				// Load Distributor properties, if it is installed.
				if (distributor.LoadProperties())
				{
					// Password supplied at runtime.
					distributor.ChangeDistributorPassword(password);
					distributor.AgentCheckupInterval = 5;

					// Save changes to the Distributor properties.
					distributor.CommitPropertyChanges();
				}
				else
				{
					throw new ApplicationException(
						String.Format("{0} is not a Distributor.", publisherInstance));
				}

				// Create an object for the distribution database 
				// using the open Distributor connection.
				distributionDb = new DistributionDatabase(distributionDbName, conn);

				// Change distribution database properties.
				if (distributionDb.LoadProperties())
				{
					// Change maximum retention period to 48 hours and history retention 
					// period to 24 hours.
					distributionDb.MaxDistributionRetention = 48;
					distributionDb.HistoryRetention = 24;

					// Save changes to the distribution database properties.
					distributionDb.CommitPropertyChanges();
				}
				else
				{
					// Do something here if the distribution database does not exist.
				}
			}
			catch (Exception ex)
			{
				// Implement the appropriate error handling here. 
				throw new ApplicationException("An error occured when changing Distributor " +
					" or distribution database properties.", ex);
			}
			finally
			{
				conn.Disconnect();
			}


' Set the Distributor and distribution database names.
Dim distributionDbName As String = "distribution"
Dim distributorName As String = publisherInstance

Dim distributor As ReplicationServer
Dim distributionDb As DistributionDatabase

' Create a connection to the Distributor using Windows Authentication.
Dim conn As ServerConnection = New ServerConnection(distributorName)

Try
    ' Open the connection. 
    conn.Connect()

    distributor = New ReplicationServer(conn)

    ' Load Distributor properties, if it is installed.
    If distributor.LoadProperties() Then
        ' Password supplied at runtime.
        distributor.ChangeDistributorPassword(password)
        distributor.AgentCheckupInterval = 5

        ' Save changes to the Distributor properties.
        distributor.CommitPropertyChanges()
    Else
        Throw New ApplicationException( _
            String.Format("{0} is not a Distributor.", publisherInstance))
    End If

    ' Create an object for the distribution database 
    ' using the open Distributor connection.
    distributionDb = New DistributionDatabase(distributionDbName, conn)

    ' Change distribution database properties.
    If distributionDb.LoadProperties() Then
        ' Change maximum retention period to 48 hours and history retention 
        ' period to 24 hours.
        distributionDb.MaxDistributionRetention = 48
        distributionDb.HistoryRetention = 24

        ' Save changes to the distribution database properties.
        distributionDb.CommitPropertyChanges()
    Else
        ' Do something here if the distribution database does not exist.
    End If
Catch ex As Exception
    ' Implement the appropriate error handling here. 
    Throw New ApplicationException("An error occured when changing Distributor " + _
        " or distribution database properties.", ex)
Finally
    conn.Disconnect()
End Try


This example shows how a ReplicationServer object is used to disable publishing.

			// Set the Distributor and publication database names.
			// Publisher and Distributor are on the same server instance.
			string publisherName = publisherInstance;
			string distributorName = publisherInstance;
			string distributionDbName = "distribution";
			string publicationDbName = "AdventureWorks";

			// Create connections to the Publisher and Distributor
			// using Windows Authentication.
			ServerConnection publisherConn = new ServerConnection(publisherName);
			ServerConnection distributorConn = new ServerConnection(distributorName);

			// Create the objects we need.
			ReplicationServer distributor =
				new ReplicationServer(distributorConn);
			DistributionPublisher publisher;
			DistributionDatabase distributionDb =
				new DistributionDatabase(distributionDbName, distributorConn);
			ReplicationDatabase publicationDb;
			publicationDb = new ReplicationDatabase(publicationDbName, publisherConn);

			try
			{
				// Connect to the Publisher and Distributor.
				publisherConn.Connect();
				distributorConn.Connect();

				// Disable all publishing on the AdventureWorks database.
				if (publicationDb.LoadProperties())
				{
					if (publicationDb.EnabledMergePublishing)
					{
						publicationDb.EnabledMergePublishing = false;
					}
					else if (publicationDb.EnabledTransPublishing)
					{
						publicationDb.EnabledTransPublishing = false;
					}
				}
				else
				{
					throw new ApplicationException(
						String.Format("The {0} database does not exist.", publicationDbName));
				}

				// We cannot uninstall the Publisher if there are still Subscribers.
				if (distributor.RegisteredSubscribers.Count == 0)
				{
					// Uninstall the Publisher, if it exists.
					publisher = new DistributionPublisher(publisherName, distributorConn);
					if (publisher.LoadProperties())
					{
						publisher.Remove(false);
					}
					else
					{
						// Do something here if the Publisher does not exist.
						throw new ApplicationException(String.Format(
							"{0} is not a Publisher for {1}.", publisherName, distributorName));
					}

					// Drop the distribution database.
					if (distributionDb.LoadProperties())
					{
						distributionDb.Remove();
					}
					else
					{
						// Do something here if the distribition DB does not exist.
						throw new ApplicationException(String.Format(
							"The distribution database '{0}' does not exist on {1}.",
							distributionDbName, distributorName));
					}

					// Uninstall the Distributor, if it exists.
					if (distributor.LoadProperties())
					{
						// Passing a value of false means that the Publisher 
						// and distribution databases must already be uninstalled,
						// and that no local databases be enabled for publishing.
						distributor.UninstallDistributor(false);
					}
					else
					{
						//Do something here if the distributor does not exist.
						throw new ApplicationException(String.Format(
							"The Distributor '{0}' does not exist.", distributorName));
					}
				}
				else
				{
					throw new ApplicationException("You must first delete all subscriptions.");
				}
			}
			catch (Exception ex)
			{
				// Implement appropriate error handling here.
				throw new ApplicationException("The Publisher and Distributor could not be uninstalled", ex);
			}
			finally
			{
				publisherConn.Disconnect();
				distributorConn.Disconnect();
			}


' Set the Distributor and publication database names.
' Publisher and Distributor are on the same server instance.
Dim publisherName As String = publisherInstance
Dim distributorName As String = subscriberInstance
Dim distributionDbName As String = "distribution"
Dim publicationDbName As String = "AdventureWorks"

' Create connections to the Publisher and Distributor
' using Windows Authentication.
Dim publisherConn As ServerConnection = New ServerConnection(publisherName)
Dim distributorConn As ServerConnection = New ServerConnection(distributorName)

' Create the objects we need.
Dim distributor As ReplicationServer
distributor = New ReplicationServer(distributorConn)
Dim publisher As DistributionPublisher
Dim distributionDb As DistributionDatabase
distributionDb = New DistributionDatabase(distributionDbName, distributorConn)
Dim publicationDb As ReplicationDatabase
publicationDb = New ReplicationDatabase(publicationDbName, publisherConn)

Try
    ' Connect to the Publisher and Distributor.
    publisherConn.Connect()
    distributorConn.Connect()

    ' Disable all publishing on the AdventureWorks database.
    If publicationDb.LoadProperties() Then
        If publicationDb.EnabledMergePublishing Then
            publicationDb.EnabledMergePublishing = False
        ElseIf publicationDb.EnabledTransPublishing Then
            publicationDb.EnabledTransPublishing = False
        End If
    Else
        Throw New ApplicationException( _
            String.Format("The {0} database does not exist.", publicationDbName))
    End If

    ' We cannot uninstall the Publisher if there are still Subscribers.
    If distributor.RegisteredSubscribers.Count = 0 Then
        ' Uninstall the Publisher, if it exists.
        publisher = New DistributionPublisher(publisherName, distributorConn)
        If publisher.LoadProperties() Then
            publisher.Remove(False)
        Else
            ' Do something here if the Publisher does not exist.
            Throw New ApplicationException(String.Format( _
                "{0} is not a Publisher for {1}.", publisherName, distributorName))
        End If

        ' Drop the distribution database.
        If distributionDb.LoadProperties() Then
            distributionDb.Remove()
        Else
            ' Do something here if the distribition DB does not exist.
            Throw New ApplicationException(String.Format( _
             "The distribution database '{0}' does not exist on {1}.", _
             distributionDbName, distributorName))
        End If

        ' Uninstall the Distributor, if it exists.
        If distributor.LoadProperties() Then
            ' Passing a value of false means that the Publisher 
            ' and distribution databases must already be uninstalled,
            ' and that no local databases be enabled for publishing.
            distributor.UninstallDistributor(False)
        Else
            'Do something here if the distributor does not exist.
            Throw New ApplicationException(String.Format( _
                "The Distributor '{0}' does not exist.", distributorName))
        End If
    Else
        Throw New ApplicationException("You must first delete all subscriptions.")
    End If

Catch ex As Exception
    ' Implement appropriate error handling here.
    Throw New ApplicationException("The Publisher and Distributor could not be uninstalled", ex)

Finally
    publisherConn.Disconnect()
    distributorConn.Disconnect()

End Try


System.Object
  Microsoft.SqlServer.Replication.ReplicationObject
    Microsoft.SqlServer.Replication.ReplicationServer

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft