Export (0) Print
Expand All

ReplicationDatabase Class

 

Applies To: SQL Server 2016 Preview

Represents a publication or subscription database in a replication topology.

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

System.Object
  Microsoft.SqlServer.Replication.ReplicationObject
    Microsoft.SqlServer.Replication.ReplicationDatabase

public sealed class ReplicationDatabase : ReplicationObject

NameDescription
System_CAPS_pubmethodReplicationDatabase()

Initializes a new instance of the ReplicationDatabase class.

System_CAPS_pubmethodReplicationDatabase(String, ServerConnection)

Initializes a new instance of the ReplicationDatabase class with the specified database name, providing a connection to the server on which the database exists.

NameDescription
System_CAPS_pubpropertyAllowMergePublication

Specifies whether or not the database can be published using merge replication.

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_pubpropertyCompatibilityLevel

Gets the minimum version of SQL Server with which the database has compatible behavior.

System_CAPS_pubpropertyConnectionContext

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

System_CAPS_pubpropertyDBOwner

Gets if the login used by the current connection has ownership rights to the database.

System_CAPS_pubpropertyDBReadOnly

Gets whether the database is read-only or not.

System_CAPS_pubpropertyEnabledMergePublishing

Gets or sets whether the database is enabled for merge publishing or not.

System_CAPS_pubpropertyEnabledTransPublishing

Gets or sets whether the database is enabled for transactional or snapshot publishing or not.

System_CAPS_pubpropertyHasPublications

Gets whether or not the database has existing publications.

System_CAPS_pubpropertyHasPullSubscriptions

Gets whether or not the database has existing pull subscriptions.

System_CAPS_pubpropertyIsExistingObject

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

System_CAPS_pubpropertyLogReaderAgentExists

Gets whether or not the Log Reader Agent has been created for the publication database.

System_CAPS_pubpropertyLogReaderAgentName

Gets the name of an existing Log Reader Agent or sets the name when creating a new Log Reader Agent for a published database.

System_CAPS_pubpropertyLogReaderAgentProcessSecurity

Gets the Microsoft Windows account under which the Log Reader Agent job runs at the Distributor.

System_CAPS_pubpropertyLogReaderAgentPublisherSecurity

Gets the login used by the Log Reader Agent to connect to the Publisher.

System_CAPS_pubpropertyMergePublications

Returns the merge publications defined on the replication database.

System_CAPS_pubpropertyMergePullSubscriptions

Returns the merge pull subscriptions defined on the replication database.

System_CAPS_pubpropertyName

Gets or sets the name of the replication database.

System_CAPS_pubpropertyQueueReaderAgentExists

Gets whether or not a Queue Reader Agent job exists for the database.

System_CAPS_pubpropertyQueueReaderAgentProcessSecurity

Gets the Microsoft Windows account under which the Queue Reader Agent job runs at the Distributor.

System_CAPS_pubpropertySqlServerName

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

System_CAPS_pubpropertyTransPublications

Returns the transactional or snapshot publications defined on the replication database.

System_CAPS_pubpropertyTransPullSubscriptions

Represents the pull subscriptions to a transactional or snapshot publication defined on the replication database.

System_CAPS_pubpropertyUserData

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

NameDescription
System_CAPS_pubmethodCommitPropertyChanges()

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

System_CAPS_pubmethodCreateLogReaderAgent()

Creates a Log Reader Agent job for a database published with transactional replication.

System_CAPS_pubmethodCreateQueueReaderAgent()

Creates a Queue Reader Agent job for the distribution database.

System_CAPS_pubmethodDecouple()

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

System_CAPS_pubmethodEnumConflictTables(String)

Returns conflict information for all merge publications and subscriptions that use the replication database.

System_CAPS_pubmethodEnumMergeConflictCounts(String, String, String)

Returns information on conflicts stored in a merge publication or subscription database.

System_CAPS_pubmethodEnumMergePublications()

Returns a list of merge publications that use the replication database.

System_CAPS_pubmethodEnumMergePullSubscriptions()

Returns all merge pull subscriptions that use this replication database.

System_CAPS_pubmethodEnumPublicationArticles(String)

Returns replication information for published objects in the replication database.

System_CAPS_pubmethodEnumReplicationSchemaBoundViews()

Returns all user-defined schema-bound view objects in the database.

System_CAPS_pubmethodEnumReplicationStoredProcedures()

Returns all user-defined stored procedure objects in the database.

System_CAPS_pubmethodEnumReplicationTables()

Returns all user-defined table objects in the database.

System_CAPS_pubmethodEnumReplicationUserDefinedAggregates()

Returns a list of user-defined aggregates in the database.

System_CAPS_pubmethodEnumReplicationUserDefinedFunctions()

Returns a list of user-defined functions in the database.

System_CAPS_pubmethodEnumReplicationViews()

Returns a list of the user-defined views objects in the database.

System_CAPS_pubmethodEnumTransConflictCounts(String, String, String)

Returns information on conflicts stored in an updating transactional publication or subscription database.

System_CAPS_pubmethodEnumTransPublications()

Returns a list of transactional and snapshot publications that use the database.

System_CAPS_pubmethodEnumTransPullSubscriptions()

Returns a list of transactional and snapshot pull subscriptions that use the database.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodLinkPublicationForUpdateableSubscription(String, String, String, String, PublisherConnectionSecurityContext)

Sets the configuration and security information used by synchronization triggers of updatable subscriptions when connecting to the Publisher.

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_pubmethodReadSubscriptionFailoverMode(String, String, String)

Returns the failover mode for an updating subscription to a transactional or snapshot publication.

System_CAPS_pubmethodRefresh()

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

System_CAPS_pubmethodScript(ScriptOptions)

Returns a Transact-SQL script to enable or disable replication publishing and subscriptions on the database based on the properties of ReplicationDatabase.

System_CAPS_pubmethodScriptReplicationDBOption(ScriptOptions)

Returns a Transact-SQL script to enable or disable replication options on the database based on the properties of ReplicationDatabase.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodWriteSubscriptionFailoverMode(String, String, String, FailoverMode)

Sets the failover mode for an updating subscription to a transactional or snapshot publication.

ReplicationDatabase can be used to represent a publication or subscription database. ReplicationDatabase cannot be used to represent system databases, such as master, tempdb, msdb, and model. A distribution database is represented by DistributionDatabase.

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 creates the distribution database when the Distributor is installed. It also enables merge and transactional publishing on the AdventureWorks database.

			// 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 changes properties on the distribution database.

			// 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 disables merge and transactional publishing on the AdventureWorks database and drops the distribution database.

			// 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
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2015 Microsoft