• Article

TransPublication Members

Include Protected Members
Include Inherited Members

Represents a transactional publication.

The TransPublication type exposes the following members.

Constructors

  Name Description
Public method TransPublication() Creates a new instance of the TransPublication class.
Public method TransPublication(String, String, ServerConnection) Creates a new instance of the TransPublication class with the required properties.
Public method TransPublication(String, String, ServerConnection, Boolean) Creates a new instance of the TransPublication class with the required properties, and indicates whether the Snapshot Agent job for the publication is created.

Top

Methods

  Name Description
Public method BrowseSnapshotFolder(String, String) Returns the complete path of the location where snapshot files were generated for a specific subscription.
Protected method CheckValidCreation() Infrastructure. (Inherited from ReplicationObject.)
Protected method CheckValidDefinition(Boolean) Infrastructure. (Inherited from Publication.)
Public method CommitPropertyChanges() Sends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public method CopySnapshot(String, String, String) Copies the latest snapshot files for a specific subscription to a destination folder.
Public method Create() Creates the publication. (Inherited from 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. (Inherited from Publication.)
Public method Decouple() Decouples the referenced replication object from the server. (Inherited from ReplicationObject.)
Public method EnumArticles() Returns the articles in the publication. (Inherited from Publication.)
Public method EnumPublicationAccesses(Boolean) Returns logins that have access to the Publisher. (Inherited from Publication.)
Public method EnumSubscriptions() Returns the subscriptions that subscribe to the publication. (Inherited from Publication.)
Public method Equals(Object) (Inherited from Object.)
Protected method Finalize() (Inherited from Object.)
Protected method GetChangeCommand(StringBuilder, String, String) Infrastructure. (Inherited from ReplicationObject.)
Protected method GetCreateCommand(StringBuilder, Boolean, ScriptOptions) Infrastructure. (Inherited from ReplicationObject.)
Protected method GetDropCommand(StringBuilder, Boolean) Infrastructure. (Inherited from ReplicationObject.)
Public method GetHashCode() (Inherited from Object.)
Public method GetType() (Inherited from Object.)
Public method GrantPublicationAccess(String) Adds the specified login to the publication access list (PAL). (Inherited from Publication.)
Protected method InternalRefresh(Boolean) 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.)
Public method MakePullSubscriptionWellKnown(String, String, SubscriptionSyncType, TransSubscriberType) Registers a pull subscription at the Publisher.
Protected method MemberwiseClone() (Inherited from Object.)
Public method PostTracerToken() Posts a tracer token into the Publisher log to begin the process of determining latency.
Public method Refresh() Reloads the properties of the object. (Inherited from ReplicationObject.)
Public method RefreshSubscriptions() Updates all subscriptions to a publication to include any newly added articles.
Public method ReinitializeAllSubscriptions() Marks all subscriptions to the publication for reinitialization.
Public method ReinitializeAllSubscriptions(Boolean) Marks all subscriptions to the publication for reinitialization, with the option to invalidate an existing snapshot.
Public method Remove() Removes an existing publication. (Inherited from Publication.)
Public method Remove(Boolean) Removes an existing publication even if the Distributor cannot be accessed. (Inherited from Publication.)
Public method RemovePullSubscription(String, String) Removes the registration for a pull subscription at the Publisher.
Public method ReplicateUserDefinedScript(String) Replicates the execution of a user-defined script to the Subscribers of a specified publication. (Inherited from Publication.)
Public method RevokePublicationAccess(String) Removes the specified login from the publication access list (PAL). (Inherited from Publication.)
Public method Script(ScriptOptions) Generates a Transact-SQL script that can be used to re-create the publication as specified by the script options. (Inherited from Publication.)
Public method SetPeerConflictDetection(Boolean, Int32) Enables or disables conflict detection for a node in a peer-to-peer topology.
Public method StartSnapshotGenerationAgentJob() Starts the job that generates the initial snapshot for the publication. (Inherited from Publication.)
Public method StopSnapshotGenerationAgentJob() Attempts to stop a running Snapshot Agent job. (Inherited from Publication.)
Public method ToString() (Inherited from Object.)
Public method ValidatePublication(ValidationOption, ValidationMethod, Boolean) Invokes inline publication validation for all subscriptions.
Public method ValidateSubscriptions(array<String[], array<String[], ValidationOption, ValidationMethod, Boolean) Invokes inline publication validation for the specified subscription.

Top

Properties

  Name Description
Public property AltSnapshotFolder Gets or sets the alternate snapshot file location for a publication. (Inherited from Publication.)
Public property Attributes Gets or sets the publication attributes. (Inherited from 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 CompatibilityLevel Gets or sets the earliest version of Microsoft SQL Server running on the Subscribers that the referenced publication can support. (Inherited from Publication.)
Public property ConflictPolicy Gets or sets the conflict policy for publications that support updating subscriptions.
Public property ConflictRetention Gets or sets the number of days that conflict data rows are retained in conflict tables. (Inherited from Publication.)
Public property ConnectionContext Gets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public property ContinueOnConflict Determines whether the Distribution Agent continues to process changes after a conflict is detected.
Public property CreateSnapshotAgentByDefault Gets or sets if the Snapshot Agent job is added automatically when the publication is created. (Inherited from Publication.)
Public property DatabaseName Gets or sets the name of the publication database. (Inherited from Publication.)
Public property Description Gets or sets a textual description of the publication. (Inherited from 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. (Inherited from Publication.)
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. (Inherited from Publication.)
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. (Inherited from Publication.)
Public property FtpPort Gets or sets the port of the File Transfer Protocol (FTP) server computer for publications that allow subscription initialization over FTP. (Inherited from Publication.)
Public property FtpSubdirectory Gets or sets the subdirectory on the File Transfer Protocol (FTP) server computer for publications that allow subscription initialization over FTP. (Inherited from Publication.)
Public property HasSubscription Gets whether the publication has one or more subscriptions. (Inherited from Publication.)
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. (Inherited from Publication.)
Public property PeerConflictDetectionEnabled Gets whether peer-to-peer conflict detection was enabled by using SetPeerConflictDetection.
Public property PeerOriginatorID Gets the ID for a node in a peer-to-peer topology; this ID is used for conflict detection if PeerConflictDetectionEnabled is set to true.
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. (Inherited from Publication.)
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. (Inherited from Publication.)
Public property PubId Gets the value that uniquely identifies the publication. (Inherited from Publication.)
Public property PublisherName Gets or sets the name of the non-SQL Server Publisher.
Public property QueueType Gets or sets the type of queue to use for publications that allow queued updating subscriptions.
Public property ReplicateDdl Gets or sets the data definition language (DDL) replication options that determine if DDL changes are replicated. (Inherited from Publication.)
Public property RetentionPeriod Gets or sets the amount of time before a subscription expires when the subscription is not synchronized with the publication. (Inherited from 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. (Inherited from Publication.)
Public property SnapshotAgentExists Gets if the SQL Server Agent job exists to generate the initial snapshot for this publication. (Inherited from Publication.)
Public property SnapshotAvailable Gets whether or not the snapshot files for this publication are available for use.
Public property SnapshotGenerationAgentProcessSecurity Gets an object that sets the Windows account under which the Snapshot Agent job runs. (Inherited from Publication.)
Public property SnapshotGenerationAgentPublisherSecurity Gets the security context used by the Snapshot Agent to connect to the Publisher. (Inherited from Publication.)
Public property SnapshotJobId Gets the Snapshot Agent job ID for the current publication. (Inherited from Publication.)
Public property SnapshotMethod Gets or sets the data file format of the initial snapshot. (Inherited from Publication.)
Public property SnapshotSchedule Gets an object that sets the schedule for the Snapshot Agent for the current publication. (Inherited from 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. (Inherited from Publication.)
Public property TransArticles Represents the articles in the publication.
Public property TransSubscriptions Represents subscriptions to the publication.
Public property Type Gets or sets the type of publication. (Inherited from 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