Publication Publication Publication Publication Class

Definition

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

public ref class Publication abstract : Microsoft::SqlServer::Replication::ReplicationObject
public abstract class Publication : Microsoft.SqlServer.Replication.ReplicationObject
type Publication = class
    inherit ReplicationObject
Public MustInherit Class Publication
Inherits ReplicationObject
Inheritance
Derived

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 sp_changemergepublication (Transact-SQL).

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

Publication() Publication() Publication() Publication()

Creates a new instance of the Publication class.

Properties

AltSnapshotFolder AltSnapshotFolder AltSnapshotFolder AltSnapshotFolder

Gets or sets the alternate snapshot file location for a publication.

Attributes Attributes Attributes Attributes

Gets or sets the publication attributes.

CachePropertyChanges CachePropertyChanges CachePropertyChanges CachePropertyChanges

Gets or sets whether to cache changes made to the replication properties or to apply them immediately.

(Inherited from ReplicationObject)
CompatibilityLevel CompatibilityLevel CompatibilityLevel CompatibilityLevel

Gets or sets the earliest version of Microsoft SQL Server running on the Subscribers that the referenced publication can support.

ConflictRetention ConflictRetention ConflictRetention ConflictRetention

Gets or sets the number of days that conflict data rows are retained in conflict tables.

ConnectionContext ConnectionContext ConnectionContext ConnectionContext

Gets or sets the connection to an instance of Microsoft SQL Server.

(Inherited from ReplicationObject)
CreateSnapshotAgentByDefault CreateSnapshotAgentByDefault CreateSnapshotAgentByDefault CreateSnapshotAgentByDefault

Gets or sets if the Snapshot Agent job is added automatically when the publication is created.

DatabaseName DatabaseName DatabaseName DatabaseName

Gets or sets the name of the publication database.

Description Description Description Description

Gets or sets a textual description of the publication.

FtpAddress FtpAddress FtpAddress FtpAddress

Gets or sets the address of the File Transfer Protocol (FTP) server computer for publications that allow subscription initialization over FTP.

FtpLogin FtpLogin FtpLogin 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.

FtpPassword FtpPassword FtpPassword 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.

FtpPort FtpPort FtpPort FtpPort

Gets or sets the port of the File Transfer Protocol (FTP) server computer for publications that allow subscription initialization over FTP.

FtpSubdirectory FtpSubdirectory FtpSubdirectory FtpSubdirectory

Gets or sets the subdirectory on the File Transfer Protocol (FTP) server computer for publications that allow subscription initialization over FTP.

HasSubscription HasSubscription HasSubscription HasSubscription

Gets whether the publication has one or more subscriptions.

IsExistingObject IsExistingObject IsExistingObject IsExistingObject

Gets whether the object exists on the server or not.

(Inherited from ReplicationObject)
Name Name Name Name

Gets or sets the name of the publication.

PostSnapshotScript PostSnapshotScript PostSnapshotScript 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.

PreSnapshotScript PreSnapshotScript PreSnapshotScript 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.

PubId PubId PubId PubId

Gets the value that uniquely identifies the publication.

ReplicateDdl ReplicateDdl ReplicateDdl ReplicateDdl

Gets or sets the data definition language (DDL) replication options that determine if DDL changes are replicated.

RetentionPeriod RetentionPeriod RetentionPeriod RetentionPeriod

Gets or sets the amount of time before a subscription expires when the subscription is not synchronized with the publication.

SecureFtpPassword SecureFtpPassword SecureFtpPassword 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.

SnapshotAgentExists SnapshotAgentExists SnapshotAgentExists SnapshotAgentExists

Gets if the SQL Server Agent job exists to generate the initial snapshot for this publication.

SnapshotGenerationAgentProcessSecurity SnapshotGenerationAgentProcessSecurity SnapshotGenerationAgentProcessSecurity SnapshotGenerationAgentProcessSecurity

Gets an object that sets the Windows account under which the Snapshot Agent job runs.

SnapshotGenerationAgentPublisherSecurity SnapshotGenerationAgentPublisherSecurity SnapshotGenerationAgentPublisherSecurity SnapshotGenerationAgentPublisherSecurity

Gets the security context used by the Snapshot Agent to connect to the Publisher.

SnapshotJobId SnapshotJobId SnapshotJobId SnapshotJobId

Gets the Snapshot Agent job ID for the current publication.

SnapshotMethod SnapshotMethod SnapshotMethod SnapshotMethod

Gets or sets the data file format of the initial snapshot.

SnapshotSchedule SnapshotSchedule SnapshotSchedule SnapshotSchedule

Gets an object that sets the schedule for the Snapshot Agent for the current publication.

SqlServerName SqlServerName SqlServerName SqlServerName

Gets the name of the Microsoft SQL Server instance to which this object is connected.

(Inherited from ReplicationObject)
Status Status Status Status

Gets or sets the status of the publication.

Type Type Type Type

Gets or sets the type of publication.

UserData UserData UserData UserData

Gets or sets an object property that allows users to attach their own data to the object.

(Inherited from ReplicationObject)

Methods

CheckValidCreation() CheckValidCreation() CheckValidCreation() CheckValidCreation()

Checks the valid replication creation.

(Inherited from ReplicationObject)
CheckValidDefinition(Boolean) CheckValidDefinition(Boolean) CheckValidDefinition(Boolean) CheckValidDefinition(Boolean)

Indicates whether to check valid definition.

CommitPropertyChanges() CommitPropertyChanges() CommitPropertyChanges() CommitPropertyChanges()

Sends all the cached property change statements to the instance of Microsoft SQL Server.

(Inherited from ReplicationObject)
Create() Create() Create() Create()

Creates the publication.

CreateSnapshotAgent() CreateSnapshotAgent() CreateSnapshotAgent() 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.

Decouple() Decouple() Decouple() Decouple()

Decouples the referenced replication object from the server.

(Inherited from ReplicationObject)
EnumArticles() EnumArticles() EnumArticles() EnumArticles()

Returns the articles in the publication.

EnumPublicationAccesses(Boolean) EnumPublicationAccesses(Boolean) EnumPublicationAccesses(Boolean) EnumPublicationAccesses(Boolean)

Returns logins that have access to the Publisher.

EnumSubscriptions() EnumSubscriptions() EnumSubscriptions() EnumSubscriptions()

Returns the subscriptions that subscribe to the publication.

GetChangeCommand(StringBuilder, String, String) GetChangeCommand(StringBuilder, String, String) GetChangeCommand(StringBuilder, String, String) GetChangeCommand(StringBuilder, String, String)

Returns the change command from the replication.

(Inherited from ReplicationObject)
GetCreateCommand(StringBuilder, Boolean, ScriptOptions) GetCreateCommand(StringBuilder, Boolean, ScriptOptions) GetCreateCommand(StringBuilder, Boolean, ScriptOptions) GetCreateCommand(StringBuilder, Boolean, ScriptOptions)

Returns the create command from the replication.

(Inherited from ReplicationObject)
GetDropCommand(StringBuilder, Boolean) GetDropCommand(StringBuilder, Boolean) GetDropCommand(StringBuilder, Boolean) GetDropCommand(StringBuilder, Boolean)

Returns the drop command from the replication.

(Inherited from ReplicationObject)
GrantPublicationAccess(String) GrantPublicationAccess(String) GrantPublicationAccess(String) GrantPublicationAccess(String)

Adds the specified login to the publication access list (PAL).

InternalRefresh(Boolean) InternalRefresh(Boolean) InternalRefresh(Boolean) InternalRefresh(Boolean)

Initiates an internal refresh from the replication.

(Inherited from ReplicationObject)
Load() Load() Load() Load()

Loads the properties of an existing object from the server.

(Inherited from ReplicationObject)
LoadProperties() LoadProperties() LoadProperties() LoadProperties()

Loads the properties of an existing object from the server.

(Inherited from ReplicationObject)
Refresh() Refresh() Refresh() Refresh()

Reloads the properties of the object.

(Inherited from ReplicationObject)
Remove() Remove() Remove() Remove()

Removes an existing publication.

Remove(Boolean) Remove(Boolean) Remove(Boolean) Remove(Boolean)

Removes an existing publication even if the Distributor cannot be accessed.

ReplicateUserDefinedScript(String) ReplicateUserDefinedScript(String) ReplicateUserDefinedScript(String) ReplicateUserDefinedScript(String)

Replicates the execution of a user-defined script to the Subscribers of a specified publication.

RevokePublicationAccess(String) RevokePublicationAccess(String) RevokePublicationAccess(String) RevokePublicationAccess(String)

Removes the specified login from the publication access list (PAL).

Script(ScriptOptions) Script(ScriptOptions) Script(ScriptOptions) Script(ScriptOptions)

Generates a Transact-SQL script that can be used to re-create the publication as specified by the script options.

StartSnapshotGenerationAgentJob() StartSnapshotGenerationAgentJob() StartSnapshotGenerationAgentJob() StartSnapshotGenerationAgentJob()

Starts the job that generates the initial snapshot for the publication.

StopSnapshotGenerationAgentJob() StopSnapshotGenerationAgentJob() StopSnapshotGenerationAgentJob() StopSnapshotGenerationAgentJob()

Attempts to stop a running Snapshot Agent job.

Applies to