DistributionDatabase Class

Represents a distribution database at the Distributor.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public NotInheritable Class DistributionDatabase _
    Inherits ReplicationObject
'Usage
Dim instance As DistributionDatabase

public sealed class DistributionDatabase : ReplicationObject

public ref class DistributionDatabase sealed : public ReplicationObject

[<SealedAttribute>]
type DistributionDatabase =  
    class 
        inherit ReplicationObject 
    end

public final class DistributionDatabase extends ReplicationObject

The DistributionDatabase type exposes the following members.

Constructors

	Name	Description
	DistributionDatabase()	Creates a new instance of the DistributionDatabase class.
	DistributionDatabase(String, ServerConnection)	Creates a new instance of the DistributionDatabase class, with the specified database name and a connection to the Distributor.

Top

Properties

	Name	Description
	CachePropertyChanges	Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (Inherited from ReplicationObject.)
	ConnectionContext	Gets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
	DataFile	Gets or sets the name of the data file for the distribution database.
	DataFileSize	Gets or sets the size of the primary database file for the distribution database.
	DataFolder	Gets or sets the path to the directory that contains the data file for the distribution database.
	DistributionCleanupTaskName	Gets the name of the SQL Server Agent job that is responsible for cleaning up the replication tables in the distribution.
	DistributorSecurity	Gets the security context used to connect to the Distributor to create the distribution database.
	HistoryCleanupTaskName	Gets the name of the SQL Server Agent job that is responsible for cleaning up replication history tables.
	HistoryRetention	Gets or sets the length of time, in hours, replication agent history data is to be retained.
	IsExistingObject	Gets whether the object exists on the server or not. (Inherited from ReplicationObject.)
	LogFile	Gets or sets the name of the file that stores database transaction log records.
	LogFileSize	Gets or sets the size of the file that stores database transaction log records.
	LogFolder	Gets or sets the path to the directory where the file that stores database transaction log records is located.
	MaxDistributionRetention	Gets or sets the maximum retention period, in hours, before transactions are deleted from the distribution database.
	MinDistributionRetention	Gets or sets the minimum retention period, in hours, before transactions are deleted from the distribution database.
	Name	Gets or sets the name of the distribution database.
	QueueReaderAgentExists	Gets or sets whether the Queue Reader Agent job has been created for this distribution database.
	QueueReaderAgentName	Gets or sets the name of the Queue Reader Agent job created for this distribution database.
	QueueReaderAgentProcessSecurity	Gets the agent process security context for running the Queue Reader Agent job.
	SqlServerName	Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)
	UserData	Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)

Top

Methods

	Name	Description
	CleanUpAnonymousSubscription	Removes metadata for anonymous subscriptions at the Distributor.
	CommitPropertyChanges	Sends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
	Create	Creates the distribution database.
	CreateQueueReaderAgent	Creates the Queue Reader Agent job on the distribution database.
	Decouple	Decouples the referenced replication object from the server. (Inherited from ReplicationObject.)
	Equals	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	Load	Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)
	LoadProperties	Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)
	Refresh	Reloads the properties of the object. (Inherited from ReplicationObject.)
	RegisterBusinessLogicHandler	Registers a business logic handler assembly at the Distributor.
	Remove	Deletes the distribution database.
	Script	Generates a Transact-SQL script that can be used to create or delete the distribution database that the object represents.
	ToString	(Inherited from Object.)
	UnregisterBusinessLogicHandler	Removes the registration for a business logic handler from the Distributor.

Top

Remarks

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.

Examples

          // 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

Thread Safety

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

See Also

Reference

Microsoft.SqlServer.Replication Namespace

Other Resources

NIB Configure Publishing and Distribution (RMO Programming)

NIB View and Modify Publisher and Distributor Properties (RMO Programming)