Publication Class

The Publication class is a base class from which the TransPublication class and the MergePublication class are derived.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Replication.ReplicationObject
    Microsoft.SqlServer.Replication.Publication
      Microsoft.SqlServer.Replication.MergePublication
      Microsoft.SqlServer.Replication.TransPublication

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

Syntax

'Declaration
<StrongNameIdentityPermissionAttribute(SecurityAction.InheritanceDemand, PublicKey := "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8",  _
    Name := "Microsoft.SqlServer.Rmo")> _
Public MustInherit Class Publication _
    Inherits ReplicationObject
'Usage
Dim instance As Publication
[StrongNameIdentityPermissionAttribute(SecurityAction.InheritanceDemand, PublicKey = "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8", 
    Name = "Microsoft.SqlServer.Rmo")]
public abstract class Publication : ReplicationObject
[StrongNameIdentityPermissionAttribute(SecurityAction::InheritanceDemand, PublicKey = L"0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8", 
    Name = L"Microsoft.SqlServer.Rmo")]
public ref class Publication abstract : public ReplicationObject
[<AbstractClassAttribute>]
[<StrongNameIdentityPermissionAttribute(SecurityAction.InheritanceDemand, PublicKey = "0024000004800000940000000602000000240000525341310004000001000100272736ad6e5f9586bac2d531eabc3acc666c2f8ec879fa94f8f7b0327d2ff2ed523448f83c3d5c5dd2dfc7bc99c5286b2c125117bf5cbe242b9d41750732b2bdffe649c6efb8e5526d526fdd130095ecdb7bf210809c6cdad8824faa9ac0310ac3cba2aa0523567b2dfa7fe250b30facbd62d4ec99b94ac47c7d3b28f1f6e4c8", 
    Name = "Microsoft.SqlServer.Rmo")>]
type Publication =  
    class 
        inherit ReplicationObject 
    end
public abstract class Publication extends ReplicationObject

The Publication type exposes the following members.

Constructors

  Name Description
Protected method Publication Creates a new instance of the Publication class.

Top

Properties

  Name Description
Public property AltSnapshotFolder Gets or sets the alternate snapshot file location for a publication.
Public property Attributes Gets or sets the publication attributes.
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 CompatibilityLevel Gets or sets the earliest version of Microsoft SQL Server running on the Subscribers that the referenced publication can support.
Public property ConflictRetention Gets or sets the number of days that conflict data rows are retained in conflict tables.
Public property ConnectionContext Gets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public property CreateSnapshotAgentByDefault Gets or sets if the Snapshot Agent job is added automatically when the publication is created.
Public property DatabaseName Gets or sets the name of the publication database.
Public property Description Gets or sets a textual description of the publication.
Public property FtpAddress Gets or sets the address of the File Transfer Protocol (FTP) server computer for publications that allow subscription initialization over FTP.
Public property FtpLogin Gets or sets the login that is used to connect to the File Transfer Protocol (FTP) server for publications that allow subscription initialization over FTP.
Public property FtpPassword Sets the password for the login that is used to connect to the File Transfer Protocol (FTP) server for publications that allow subscription initialization over FTP.
Public property FtpPort Gets or sets the port of the File Transfer Protocol (FTP) server computer for publications that allow subscription initialization over FTP.
Public property FtpSubdirectory Gets or sets the subdirectory on the File Transfer Protocol (FTP) server computer for publications that allow subscription initialization over FTP.
Public property HasSubscription Gets whether the publication has one or more subscriptions.
Public property IsExistingObject Gets whether the object exists on the server or not. (Inherited from ReplicationObject.)
Public property Name Gets or sets the name of the publication.
Public property PostSnapshotScript Gets or sets the name and full path of a Transact-SQL script file that is executed after the initial snapshot is applied to the Subscriber.
Public property PreSnapshotScript Gets or sets the name and full path of a Transact-SQL script file that is executed before the initial snapshot is applied to the Subscriber.
Public property PubId Gets the value that uniquely identifies the publication.
Public property ReplicateDdl Gets or sets the data definition language (DDL) replication options that determine if DDL changes are replicated.
Public property RetentionPeriod Gets or sets the amount of time before a subscription expires when the subscription is not synchronized with the publication.
Public property SecureFtpPassword Sets the password (as a SecureString object) for the login used to connect to the File Transfer Protocol (FTP) server for publications that allow subscription initialization over FTP.
Public property SnapshotAgentExists Gets if the SQL Server Agent job exists to generate the initial snapshot for this publication.
Public property SnapshotGenerationAgentProcessSecurity Gets an object that sets the Windows account under which the Snapshot Agent job runs.
Public property SnapshotGenerationAgentPublisherSecurity Gets the security context used by the Snapshot Agent to connect to the Publisher.
Public property SnapshotJobId Gets the Snapshot Agent job ID for the current publication.
Public property SnapshotMethod Gets or sets the data file format of the initial snapshot.
Public property SnapshotSchedule Gets an object that sets the schedule for the Snapshot Agent for the current publication.
Public property SqlServerName Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)
Public property Status Gets or sets the status of the publication.
Public property Type Gets or sets the type of publication.
Public property 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
Protected method CheckValidCreation Infrastructure. Checks the valid replication creation. (Inherited from ReplicationObject.)
Protected method CheckValidDefinition Infrastructure. Indicates whether to check valid definition. (Overrides ReplicationObject.CheckValidDefinition(Boolean).)
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.
Public method CreateSnapshotAgent Creates the SQL Server Agent job that is used to generate the initial snapshot for the publication, if this job does not already exist.
Public method Decouple Decouples the referenced replication object from the server. (Inherited from ReplicationObject.)
Public method EnumArticles Returns the articles in the publication.
Public method EnumPublicationAccesses Returns logins that have access to the Publisher.
Public method EnumSubscriptions Returns the subscriptions that subscribe to the publication.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Protected method GetChangeCommand Infrastructure. Returns the change command from the replication. (Inherited from ReplicationObject.)
Protected method GetCreateCommand Infrastructure. Returns the create command from the replication. (Inherited from ReplicationObject.)
Protected method GetDropCommand Infrastructure. Returns the drop command from the replication. (Inherited from ReplicationObject.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method GrantPublicationAccess Adds the specified login to the publication access list (PAL).
Protected method InternalRefresh Infrastructure. Initiates an internal refresh from the replication. (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 an existing publication.
Public method Remove(Boolean) Removes an existing publication even if the Distributor cannot be accessed.
Public method ReplicateUserDefinedScript Replicates the execution of a user-defined script to the Subscribers of a specified publication.
Public method RevokePublicationAccess Removes the specified login from the publication access list (PAL).
Public method Script Generates a Transact-SQL script that can be used to re-create the publication as specified by the script options.
Public method StartSnapshotGenerationAgentJob Starts the job that generates the initial snapshot for the publication.
Public method StopSnapshotGenerationAgentJob Attempts to stop a running Snapshot Agent job.
Public method ToString (Inherited from Object.)

Top

Remarks

When configuring a Publisher with a remote Distributor, the values supplied for all properties, including SnapshotGenerationAgentProcessSecurity, are sent to the Distributor as plain text. You should encrypt the connection between the Publisher and its remote Distributor before calling the Create or the CreateSnapshotAgent methods. For more information, see Encrypting Connections to SQL Server.

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.

See Also

Reference

Microsoft.SqlServer.Replication Namespace