Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

DistributionDatabase Class

Represents a distribution database at the Distributor.

System.Object
  Microsoft.SqlServer.Replication.ReplicationObject
    Microsoft.SqlServer.Replication.DistributionDatabase

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)
public sealed class DistributionDatabase : ReplicationObject

The DistributionDatabase type exposes the following members.

  NameDescription
Public methodDistributionDatabase()Creates a new instance of the DistributionDatabase class.
Public methodDistributionDatabase(String, ServerConnection)Creates a new instance of the DistributionDatabase class, with the specified database name and a connection to the Distributor.
Top
  NameDescription
Public propertyCachePropertyChangesGets or sets whether to cache changes made to the replication properties or to apply them immediately. (Inherited from ReplicationObject.)
Public propertyConnectionContextGets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public propertyDataFileGets or sets the name of the data file for the distribution database.
Public propertyDataFileSizeGets or sets the size of the primary database file for the distribution database.
Public propertyDataFolderGets or sets the path to the directory that contains the data file for the distribution database.
Public propertyDistributionCleanupTaskNameGets the name of the SQL Server Agent job that is responsible for cleaning up the replication tables in the distribution.
Public propertyDistributorSecurityGets the security context used to connect to the Distributor to create the distribution database.
Public propertyHistoryCleanupTaskNameGets the name of the SQL Server Agent job that is responsible for cleaning up replication history tables.
Public propertyHistoryRetentionGets or sets the length of time, in hours, replication agent history data is to be retained.
Public propertyIsExistingObjectGets whether the object exists on the server or not. (Inherited from ReplicationObject.)
Public propertyLogFileGets or sets the name of the file that stores database transaction log records.
Public propertyLogFileSizeGets or sets the size of the file that stores database transaction log records.
Public propertyLogFolderGets or sets the path to the directory where the file that stores database transaction log records is located.
Public propertyMaxDistributionRetentionGets or sets the maximum retention period, in hours, before transactions are deleted from the distribution database.
Public propertyMinDistributionRetentionGets or sets the minimum retention period, in hours, before transactions are deleted from the distribution database.
Public propertyNameGets or sets the name of the distribution database.
Public propertyQueueReaderAgentExistsGets or sets whether the Queue Reader Agent job has been created for this distribution database.
Public propertyQueueReaderAgentNameGets or sets the name of the Queue Reader Agent job created for this distribution database.
Public propertyQueueReaderAgentProcessSecurityGets the agent process security context for running the Queue Reader Agent job.
Public propertySqlServerNameGets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)
Public propertyUserDataGets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)
Top
  NameDescription
Public methodCleanUpAnonymousSubscriptionRemoves metadata for anonymous subscriptions at the Distributor.
Public methodCommitPropertyChangesSends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public methodCreateCreates the distribution database.
Public methodCreateQueueReaderAgentCreates the Queue Reader Agent job on the distribution database.
Public methodDecoupleDecouples the referenced replication object from the server. (Inherited from ReplicationObject.)
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodLoadLoads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Public methodLoadPropertiesLoads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Public methodRefreshReloads the properties of the object. (Inherited from ReplicationObject.)
Public methodRegisterBusinessLogicHandlerRegisters a business logic handler assembly at the Distributor.
Public methodRemoveDeletes the distribution database.
Public methodScriptGenerates a Transact-SQL script that can be used to create or delete the distribution database that the object represents.
Public methodToString (Inherited from Object.)
Public methodUnregisterBusinessLogicHandlerRemoves the registration for a business logic handler from the Distributor.
Top

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.

			// 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();
			}
' Set the server and database names
Dim distributionDbName As String = "distribution"
Dim publisherName As String = publisherInstance
Dim publicationDbName As String = "AdventureWorks2012"

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 AdventureWorks2012 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
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.