DistributionPublication Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents information about a transactional or snapshot publication stored at the Distributor.
public ref class DistributionPublication sealed : Microsoft::SqlServer::Replication::ReplicationObjectpublic sealed class DistributionPublication : Microsoft.SqlServer.Replication.ReplicationObjecttype DistributionPublication = class
inherit ReplicationObjectPublic NotInheritable Class DistributionPublication
Inherits ReplicationObject- Inheritance
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.
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.
Constructors
| DistributionPublication() |
Creates a new instance of the DistributionPublication class. |
| 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. |
Properties
| Attributes |
Gets or sets the publication attributes for the distribution publication. |
| 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) |
| Description |
Gets or sets a description for the publication. |
| DistributionArticles |
Returns information about the articles in the publication stored at the Distributor. |
| DistributionDBName |
Gets or sets the name of the distribution database for the publication. |
| DistributionSubscriptions |
Represents information about subscriptions to the publication stored at the Distributor. |
| IsExistingObject |
Gets whether the object exists on the server or not. (Inherited from ReplicationObject) |
| LogReaderAgent |
Gets or sets the name of the Log Reader Agent job for the transactional publication. |
| Name |
Gets or sets the name of the publication. |
| PubId |
Gets the publication ID. |
| PublicationDBName |
Gets or sets the name of the publication database. |
| PublisherName |
Gets or sets the name of the Publisher. |
| SnapshotAgent |
Gets or sets the name of the Snapshot Agent job for the transactional publication. |
| SqlServerName |
Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject) |
| Type |
Gets or sets the type of replication for this publication. |
| UserData |
Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject) |
| VendorName |
Gets or sets the product manufacturer of the non-SQL Server Publisher of the publication. |
Methods
| CheckValidCreation() |
Checks the valid replication creation. (Inherited from ReplicationObject) |
| CheckValidDefinition(Boolean) |
Indicates whether the definition is valid. (Inherited from ReplicationObject) |
| CommitPropertyChanges() |
Sends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject) |
| Create() |
Creates the publication metadata at the Distributor. |
| Decouple() |
Decouples the referenced replication object from the server. (Inherited from ReplicationObject) |
| EnumDistributionArticles() |
Returns information maintained at the Distributor on articles in this publication. |
| EnumDistributionSubscriptions() |
Returns information maintained at the Distributor for subscriptions to this publication. |
| GetChangeCommand(StringBuilder, String, String) |
Returns the change command from the replication. (Inherited from ReplicationObject) |
| GetCreateCommand(StringBuilder, Boolean, ScriptOptions) |
Returns the create command from the replication. (Inherited from ReplicationObject) |
| GetDropCommand(StringBuilder, Boolean) |
Returns the drop command from the replication. (Inherited from ReplicationObject) |
| InternalRefresh(Boolean) |
Initiates an internal refresh from the replication. (Inherited from ReplicationObject) |
| 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) |
| Remove() |
Removes metadata for the publication from the Distributor. |
| Script(ScriptOptions) |
Generates a Transact-SQL script that can be used to create or remove the publication metadata at the Distributor. |