Share via


DistributionPublication Class

Represents information about a transactional or snapshot publication stored at the Distributor.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Replication.ReplicationObject
    Microsoft.SqlServer.Replication.DistributionPublication

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

Syntax

'Declaration
Public NotInheritable Class DistributionPublication _
    Inherits ReplicationObject
'Usage
Dim instance As DistributionPublication
public sealed class DistributionPublication : ReplicationObject
public ref class DistributionPublication sealed : public ReplicationObject
[<SealedAttribute>]
type DistributionPublication =  
    class
        inherit ReplicationObject
    end
public final class DistributionPublication extends ReplicationObject

The DistributionPublication type exposes the following members.

Constructors

  Name Description
Public method DistributionPublication() Creates a new instance of the DistributionPublication class.
Public method DistributionPublication(String, String, String, String, ServerConnection) Creates a new instance of the DistributionPublication class, with the required properties and with a connection to the Distributor.

Top

Properties

  Name Description
Public property Attributes Gets or sets the publication attributes for the distribution publication.
Public property CachePropertyChanges Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (Inherited from ReplicationObject.)
Public property ConnectionContext Gets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public property Description Gets or sets a description for the publication.
Public property DistributionArticles Returns information about the articles in the publication stored at the Distributor.
Public property DistributionDBName Gets or sets the name of the distribution database for the publication.
Public property DistributionSubscriptions Represents information about subscriptions to the publication stored at the Distributor.
Public property IsExistingObject Gets whether the object exists on the server or not. (Inherited from ReplicationObject.)
Public property LogReaderAgent Gets or sets the name of the Log Reader Agent job for the transactional publication.
Public property Name Gets or sets the name of the publication.
Public property PubId Gets the publication ID.
Public property PublicationDBName Gets or sets the name of the publication database.
Public property PublisherName Gets or sets the name of the Publisher.
Public property SnapshotAgent Gets or sets the name of the Snapshot Agent job for the transactional publication.
Public property SqlServerName Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)
Public property Type Gets or sets the type of replication for this publication.
Public property UserData Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)
Public property VendorName Gets or sets the product manufacturer of the non-SQL Server Publisher of the publication.

Top

Methods

  Name Description
Protected method CheckValidCreation Infrastructure. (Inherited from ReplicationObject.)
Protected method CheckValidDefinition Infrastructure. (Inherited from ReplicationObject.)
Public method CommitPropertyChanges Sends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public method Create Creates the publication metadata at the Distributor.
Public method Decouple Decouples the referenced replication object from the server. (Inherited from ReplicationObject.)
Public method EnumDistributionArticles Returns information maintained at the Distributor on articles in this publication.
Public method EnumDistributionSubscriptions Returns information maintained at the Distributor for subscriptions to this publication.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Protected method GetChangeCommand Infrastructure. (Inherited from ReplicationObject.)
Protected method GetCreateCommand Infrastructure. (Inherited from ReplicationObject.)
Protected method GetDropCommand Infrastructure. (Inherited from ReplicationObject.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method InternalRefresh Infrastructure. (Inherited from ReplicationObject.)
Public method Load Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Public method LoadProperties Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Refresh Reloads the properties of the object. (Inherited from ReplicationObject.)
Public method Remove Removes metadata for the publication from the Distributor.
Public method Script Generates a Transact-SQL script that can be used to create or remove the publication metadata at the Distributor.
Public method ToString (Inherited from Object.)

Top

Remarks

The DistributionPublication class is used primarily by SQL Server Management Studio and for non-SQL Server Publishers. To create, view, or modify the properties of a publication, you should instead use an instance of the TransPublication class.

The DistributionPublication class requires a connection to the Distributor.

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.

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.