Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

ReplicationServer Class

 

Applies To: SQL Server 2016 Preview

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)

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

[GuidAttribute("1E1028E5-8DE4-4379-9F3C-A668F1D61D4F")]
public sealed class ReplicationServer : ReplicationObject

NameDescription
System_CAPS_pubmethodReplicationServer()

Initializes a new instance of the ReplicationServer class.

System_CAPS_pubmethodReplicationServer(ServerConnection)

Initializes a new instance of the ReplicationServer class with the specified connection context that is used to establish a connection with the instance of Microsoft SQL Server.

NameDescription
System_CAPS_pubpropertyAgentCheckupInterval

Gets or sets the interval for the Distribution Agent to perform a checkup.

System_CAPS_pubpropertyCachePropertyChanges

Gets or sets whether to cache changes made to the replication properties or to apply them immediately.(Inherited from ReplicationObject.)

System_CAPS_pubpropertyConnectionContext

Gets or sets the connection to an instance of Microsoft SQL Server.(Inherited from ReplicationObject.)

System_CAPS_pubpropertyDistributionDatabase

Gets the name of the distribution database for the currently connected instance of SQL Server. 

System_CAPS_pubpropertyDistributionDatabases

Gets the distribution databases defined on the replication server.

System_CAPS_pubpropertyDistributionPublishers

Gets the Publishers that use the currently connected instance of Microsoft SQL Server as a Distributor.

System_CAPS_pubpropertyDistributionServer

Gets or sets the name of the Distributor for the currently connected instance of SQL Server.

System_CAPS_pubpropertyDistributorAvailable

Gets whether the Distributor for the currently connected instance of Microsoft SQL Server is currently connected and available or not.

System_CAPS_pubpropertyDistributorInstalled

Gets whether the currently connected instance of SQL Server has a local or remote Distributor. 

System_CAPS_pubpropertyHasRemotePublisher

Gets whether or not the currently connected instance of Microsoft SQL Server is a Distributor with a remote Publisher. 

System_CAPS_pubpropertyIsDistributor

Gets whether the currently connected instance of SQL Server is a Distributor or not.

System_CAPS_pubpropertyIsExistingObject

Gets whether the object exists on the server or not.(Inherited from ReplicationObject.)

System_CAPS_pubpropertyIsPublisher

Gets whether or not the currently connected instance of Microsoft SQL Server is a Publisher.

System_CAPS_pubpropertyName

Gets the name of the instance of Microsoft SQL Server.

System_CAPS_pubpropertyRegisteredSubscribers

Gets the Subscribers registered with the Publisher.

System_CAPS_pubpropertyReplicationDatabases

Gets the databases enabled for replication in the connected instance of Microsoft SQL Server.

System_CAPS_pubpropertySqlServerName

Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)

System_CAPS_pubpropertyUserData

Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)

System_CAPS_pubpropertyWorkingDirectory

Gets the working directory used by a Publisher.

NameDescription
System_CAPS_pubmethodAttachSubscriptionDatabase(String, String, ConnectionSecurityContext)

Attaches a copied subscription database at the Subscriber.

System_CAPS_pubmethodChangeDistributorPassword(SecureString)

Changes the Distributor password, where the new password is supplied as a SecureString object.

System_CAPS_pubmethodChangeDistributorPassword(String)

Changes the Distributor password.

System_CAPS_pubmethodChangeReplicationServerPasswords(ReplicationSecurityMode, String, SecureString)

Changes all stored instances of the password for a login maintained on the replication server using a SecureString object.

System_CAPS_pubmethodChangeReplicationServerPasswords(ReplicationSecurityMode, String, String)

Changes all stored instances of the password for a login maintained on the replication server.

System_CAPS_pubmethodCommitPropertyChanges()

Sends all the cached property change statements to the instance of Microsoft SQL Server.(Inherited from ReplicationObject.)

System_CAPS_pubmethodCopySubscriptionDatabase(String, String, Boolean)

Copies an existing pull subscription database.

System_CAPS_pubmethodDecouple()

Decouples the referenced replication object from the server. (Inherited from ReplicationObject.)

System_CAPS_pubmethodEnumAgentProfiles(AgentType)

Returns the replication agent performance profiles supported on the server.

System_CAPS_pubmethodEnumBusinessLogicHandlers()

Returns the business logic handlers registered at the server.

System_CAPS_pubmethodEnumCurrentPrincipals()

Returns information for all published databases that are participating in database mirroring.

System_CAPS_pubmethodEnumCustomResolvers()

Returns all custom conflict resolvers registered on the connected instance of SQL Server.

System_CAPS_pubmethodEnumDistributionDatabases()

Returns the distribution databases installed when the currently connected instance of Microsoft SQL Server is a Distributor.

System_CAPS_pubmethodEnumDistributionPublishers()

Returns the Publishers using the currently connected instance of Microsoft SQL Server as their Distributor. 

System_CAPS_pubmethodEnumHeterogeneousColumns(String, String, String)

Returns the columns in a table on a non-SQL Server Publisher.

System_CAPS_pubmethodEnumHeterogeneousTables(String)

Returns the available tables on a non-SQL Server Publisher.

System_CAPS_pubmethodEnumLightPublications(String, Int32, Boolean, Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. Returns a light publications.

System_CAPS_pubmethodEnumRegisteredSubscribers()

Returns the Subscribers that are registered at a Publisher.

System_CAPS_pubmethodEnumReplicationDatabases()

Returns the databases enabled for replication.

System_CAPS_pubmethodEnumSubscriberSubscriptions(String, Int32)

Returns the subscriptions on a Subscriber server.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetCurrentPrincipal(String)

Returns the current database mirroring principal for the specified publication database.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetOriginalPublisher(String)

Returns the name of the originating Publisher for a published database participating in a database mirroring session.

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInstallDistributor(SecureString, DistributionDatabase)

Installs a Distributor on the currently connected instance of Microsoft SQL Server, where the password is specified using a SecureString object.

System_CAPS_pubmethodInstallDistributor(String, DistributionDatabase)

Installs a Distributor on the currently connected instance of Microsoft SQL Server.

System_CAPS_pubmethodInstallDistributor(String, SecureString)

Registers a remote Distributor, where the password is specified using a SecureString object.

System_CAPS_pubmethodInstallDistributor(String, String)

Registers a remote Distributor.

System_CAPS_pubmethodLoad()

Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)

System_CAPS_pubmethodLoadProperties()

Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)

System_CAPS_pubmethodRefresh()

Reloads the properties of the object. (Inherited from ReplicationObject.)

System_CAPS_pubmethodScript(ScriptOptions)

Returns a Transact-SQL script to install or uninstall replication on the server.

System_CAPS_pubmethodScriptInstallDistributor(String, ScriptOptions)

Returns a Transact-SQL script that installs the Distributor.

System_CAPS_pubmethodScriptUninstallDistributor(ScriptOptions)

Returns a Transact-SQL script that can be used to uninstall the Distributor.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUninstallDistributor(Boolean)

Uninstalls replication publishing and distribution on the currently connected instance of SQL Server. 

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.

Legacy Code Example

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 = "AdventureWorks2012";

			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 AdventureWorks2012 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();
			}

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();
			}

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 = "AdventureWorks2012";

			// 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 AdventureWorks2012 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();
			}

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

Return to top

Community Additions

Show:
© 2015 Microsoft