Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
MSDN Library

TransPublication Class

 

Applies To: SQL Server 2016 Preview

Represents a transactional publication.

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


public sealed class TransPublication : Publication

NameDescription
System_CAPS_pubmethodTransPublication()

Creates a new instance of the TransPublication class.

System_CAPS_pubmethodTransPublication(String, String, ServerConnection)

Creates a new instance of the TransPublication class with the required properties.

System_CAPS_pubmethodTransPublication(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.

NameDescription
System_CAPS_pubpropertyAltSnapshotFolder

Gets or sets the alternate snapshot file location for a publication. (Inherited from Publication.)

System_CAPS_pubpropertyAttributes

Gets or sets the publication attributes.(Inherited from Publication.)

System_CAPS_pubpropertyCachePropertyChanges

Gets or sets whether to cache changes made to the replication properties or to apply them immediately.(Inherited from ReplicationObject.)

System_CAPS_pubpropertyCompatibilityLevel

Gets or sets the earliest version of Microsoft SQL Server running on the Subscribers that the referenced publication can support.(Inherited from Publication.)

System_CAPS_pubpropertyConflictPolicy

Gets or sets the conflict policy for publications that support updating subscriptions.

System_CAPS_pubpropertyConflictRetention

Gets or sets the number of days that conflict data rows are retained in conflict tables.(Inherited from Publication.)

System_CAPS_pubpropertyConnectionContext

Gets or sets the connection to an instance of Microsoft SQL Server.(Inherited from ReplicationObject.)

System_CAPS_pubpropertyContinueOnConflict

Determines whether the Distribution Agent continues to process changes after a conflict is detected.

System_CAPS_pubpropertyCreateSnapshotAgentByDefault

Gets or sets if the Snapshot Agent job is added automatically when the publication is created.(Inherited from Publication.)

System_CAPS_pubpropertyDatabaseName

Gets or sets the name of the publication database. (Inherited from Publication.)

System_CAPS_pubpropertyDescription

Gets or sets a textual description of the publication.(Inherited from Publication.)

System_CAPS_pubpropertyFtpAddress

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

System_CAPS_pubpropertyFtpLogin

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

System_CAPS_pubpropertyFtpPassword

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

System_CAPS_pubpropertyFtpPort

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

System_CAPS_pubpropertyFtpSubdirectory

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

System_CAPS_pubpropertyHasSubscription

Gets whether the publication has one or more subscriptions.(Inherited from Publication.)

System_CAPS_pubpropertyIsExistingObject

Gets whether the object exists on the server or not.(Inherited from ReplicationObject.)

System_CAPS_pubpropertyName

Gets or sets the name of the publication.(Inherited from Publication.)

System_CAPS_pubpropertyPeerConflictDetectionEnabled

Gets whether peer-to-peer conflict detection was enabled by using SetPeerConflictDetection.

System_CAPS_pubpropertyPeerOriginatorID

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.

System_CAPS_pubpropertyPostSnapshotScript

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

System_CAPS_pubpropertyPreSnapshotScript

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

System_CAPS_pubpropertyPubId

Gets the value that uniquely identifies the publication. (Inherited from Publication.)

System_CAPS_pubpropertyPublisherName

Gets or sets the name of the non-SQL Server Publisher.

System_CAPS_pubpropertyQueueType

Gets or sets the type of queue to use for publications that allow queued updating subscriptions.

System_CAPS_pubpropertyReplicateDdl

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

System_CAPS_pubpropertyRetentionPeriod

Gets or sets the amount of time before a subscription expires when the subscription is not synchronized with the publication.(Inherited from Publication.)

System_CAPS_pubpropertySecureFtpPassword

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

System_CAPS_pubpropertySnapshotAgentExists

Gets if the SQL Server Agent job exists to generate the initial snapshot for this publication.(Inherited from Publication.)

System_CAPS_pubpropertySnapshotAvailable

Gets whether or not the snapshot files for this publication are available for use.

System_CAPS_pubpropertySnapshotGenerationAgentProcessSecurity

Gets an object that sets the Windows account under which the Snapshot Agent job runs.(Inherited from Publication.)

System_CAPS_pubpropertySnapshotGenerationAgentPublisherSecurity

Gets the security context used by the Snapshot Agent to connect to the Publisher.(Inherited from Publication.)

System_CAPS_pubpropertySnapshotJobId

Gets the Snapshot Agent job ID for the current publication.(Inherited from Publication.)

System_CAPS_pubpropertySnapshotMethod

Gets or sets the data file format of the initial snapshot.(Inherited from Publication.)

System_CAPS_pubpropertySnapshotSchedule

Gets an object that sets the schedule for the Snapshot Agent for the current publication.(Inherited from Publication.)

System_CAPS_pubpropertySqlServerName

Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)

System_CAPS_pubpropertyStatus

Gets or sets the status of the publication.(Inherited from Publication.)

System_CAPS_pubpropertyTransArticles

Represents the articles in the publication.

System_CAPS_pubpropertyTransSubscriptions

Represents subscriptions to the publication.

System_CAPS_pubpropertyType

Gets or sets the type of publication.(Inherited from Publication.)

System_CAPS_pubpropertyUserData

Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)

NameDescription
System_CAPS_pubmethodBrowseSnapshotFolder(String, String)

Returns the complete path of the location where snapshot files were generated for a specific subscription.

System_CAPS_pubmethodCommitPropertyChanges()

Sends all the cached property change statements to the instance of Microsoft SQL Server.(Inherited from ReplicationObject.)

System_CAPS_pubmethodCopySnapshot(String, String, String)

Copies the latest snapshot files for a specific subscription to a destination folder.

System_CAPS_pubmethodCreate()

Creates the publication.(Inherited from Publication.)

System_CAPS_pubmethodCreateSnapshotAgent()

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

System_CAPS_pubmethodDecouple()

Decouples the referenced replication object from the server. (Inherited from ReplicationObject.)

System_CAPS_pubmethodEnumArticles()

Returns the articles in the publication.(Inherited from Publication.)

System_CAPS_pubmethodEnumPublicationAccesses(Boolean)

Returns logins that have access to the Publisher.(Inherited from Publication.)

System_CAPS_pubmethodEnumSubscriptions()

Returns the subscriptions that subscribe to the publication.(Inherited from Publication.)

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodGrantPublicationAccess(String)

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

System_CAPS_pubmethodLoad()

Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)

System_CAPS_pubmethodLoadProperties()

Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)

System_CAPS_pubmethodMakePullSubscriptionWellKnown(String, String, SubscriptionSyncType, TransSubscriberType)

Registers a pull subscription at the Publisher.

System_CAPS_pubmethodPostTracerToken()

Posts a tracer token into the Publisher log to begin the process of determining latency.

System_CAPS_pubmethodRefresh()

Reloads the properties of the object. (Inherited from ReplicationObject.)

System_CAPS_pubmethodRefreshSubscriptions()

Updates all subscriptions to a publication to include any newly added articles.

System_CAPS_pubmethodReinitializeAllSubscriptions()

Marks all subscriptions to the publication for reinitialization.

System_CAPS_pubmethodReinitializeAllSubscriptions(Boolean)

Marks all subscriptions to the publication for reinitialization, with the option to invalidate an existing snapshot.

System_CAPS_pubmethodRemove()

Removes an existing publication.(Inherited from Publication.)

System_CAPS_pubmethodRemove(Boolean)

Removes an existing publication even if the Distributor cannot be accessed.(Inherited from Publication.)

System_CAPS_pubmethodRemovePullSubscription(String, String)

Removes the registration for a pull subscription at the Publisher.

System_CAPS_pubmethodReplicateUserDefinedScript(String)

Replicates the execution of a user-defined script to the Subscribers of a specified publication.(Inherited from Publication.)

System_CAPS_pubmethodRevokePublicationAccess(String)

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

System_CAPS_pubmethodScript(ScriptOptions)

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

System_CAPS_pubmethodSetPeerConflictDetection(Boolean, Int32)

Enables or disables conflict detection for a node in a peer-to-peer topology.

System_CAPS_pubmethodStartSnapshotGenerationAgentJob()

Starts the job that generates the initial snapshot for the publication.(Inherited from Publication.)

System_CAPS_pubmethodStopSnapshotGenerationAgentJob()

Attempts to stop a running Snapshot Agent job.(Inherited from Publication.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodValidatePublication(ValidationOption, ValidationMethod, Boolean)

Invokes inline publication validation for all subscriptions.

System_CAPS_pubmethodValidateSubscriptions(String[], String[], ValidationOption, ValidationMethod, Boolean)

Invokes inline publication validation for the specified subscription.

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.

Legacy Code Example

This example creates a transactional publication.

			// Set the Publisher, publication database, and publication names.
			string publicationName = "AdvWorksProductTran";
			string publicationDbName = "AdventureWorks2012";
			string publisherName = publisherInstance;

			ReplicationDatabase publicationDb;
			TransPublication publication;

			// Create a connection to the Publisher using Windows Authentication.
			ServerConnection conn;
			conn = new ServerConnection(publisherName);


			try
			{
				// Connect to the Publisher.
				conn.Connect();

				// Enable the AdventureWorks2012 database for transactional publishing.
				publicationDb = new ReplicationDatabase(publicationDbName, conn);

				// If the database exists and is not already enabled, 
				// enable it for transactional publishing.
				if (publicationDb.LoadProperties())
				{
					if (!publicationDb.EnabledTransPublishing)
					{
						publicationDb.EnabledTransPublishing = true;
					}

					// If the Log Reader Agent does not exist, create it.
					if (!publicationDb.LogReaderAgentExists)
					{
						// Specify the Windows account under which the agent job runs.
						// This account will be used for the local connection to the 
						// Distributor and all agent connections that use Windows Authentication.
						publicationDb.LogReaderAgentProcessSecurity.Login = winLogin;
						publicationDb.LogReaderAgentProcessSecurity.Password = winPassword;

						// Explicitly set authentication mode for the Publisher connection
						// to the default value of Windows Authentication.
						publicationDb.LogReaderAgentPublisherSecurity.WindowsAuthentication = true;

						// Create the Log Reader Agent job.
						publicationDb.CreateLogReaderAgent();
					}
				}
				else
				{
					throw new ApplicationException(String.Format(
						"The {0} database does not exist at {1}.",
						publicationDb, publisherName));
				}

				// Set the required properties for the transactional publication.
				publication = new TransPublication();
				publication.ConnectionContext = conn;
				publication.Name = publicationName;
				publication.DatabaseName = publicationDbName;

				// Specify a transactional publication (the default).
				publication.Type = PublicationType.Transactional;

				// Activate the publication so that we can add subscriptions.
				publication.Status = State.Active;

                // Enable push and pull subscriptions and independent Distribition Agents.
                publication.Attributes |= PublicationAttributes.AllowPull;
                publication.Attributes |= PublicationAttributes.AllowPush;
                publication.Attributes |= PublicationAttributes.IndependentAgent;

				// Specify the Windows account under which the Snapshot Agent job runs.
				// This account will be used for the local connection to the 
				// Distributor and all agent connections that use Windows Authentication.
				publication.SnapshotGenerationAgentProcessSecurity.Login = winLogin;
				publication.SnapshotGenerationAgentProcessSecurity.Password = winPassword;

				// Explicitly set the security mode for the Publisher connection
				// Windows Authentication (the default).
				publication.SnapshotGenerationAgentPublisherSecurity.WindowsAuthentication = true;

				if (!publication.IsExistingObject)
				{
					// Create the transactional publication.
					publication.Create();

					// Create a Snapshot Agent job for the publication.
					publication.CreateSnapshotAgent();
				}
				else
				{
					throw new ApplicationException(String.Format(
						"The {0} publication already exists.", publicationName));
				}
			}

			catch (Exception ex)
			{
				// Implement custom application error handling here.
				throw new ApplicationException(String.Format(
					"The publication {0} could not be created.", publicationName), ex);
			}
			finally
			{
				conn.Disconnect();
			}

This example deletes a transactional publication.

			// Define the Publisher, publication database, 
			// and publication names.
			string publisherName = publisherInstance;
			string publicationName = "AdvWorksProductTran";
			string publicationDbName = "AdventureWorks2012";

			TransPublication publication;
			ReplicationDatabase publicationDb;

			// Create a connection to the Publisher 
			// using Windows Authentication.
			ServerConnection conn = new ServerConnection(publisherName);

			try
			{
				conn.Connect();

				// Set the required properties for the transactional publication.
				publication = new TransPublication();
				publication.ConnectionContext = conn;
				publication.Name = publicationName;
				publication.DatabaseName = publicationDbName;

				// Delete the publication, if it exists and has no subscriptions.
				if (publication.LoadProperties() && !publication.HasSubscription)
				{
					publication.Remove();
				}
				else
				{
					// Do something here if the publication does not exist
					// or has subscriptions.
					throw new ApplicationException(String.Format(
						"The publication {0} could not be deleted. " +
						"Ensure that the publication exists and that all " +
						"subscriptions have been deleted.",
						publicationName, publisherName));
				}

				// If no other transactional publications exists,
				// disable publishing on the database.
				publicationDb = new ReplicationDatabase(publicationDbName, conn);
				if (publicationDb.LoadProperties())
				{
					if (publicationDb.TransPublications.Count == 0)
					{
						publicationDb.EnabledTransPublishing = false;
					}
				}
				else
				{
					// Do something here if the database does not exist.
					throw new ApplicationException(String.Format(
						"The database {0} does not exist on {1}.",
						publicationDbName, publisherName));
				}
			}
			catch (Exception ex)
			{
				// Implement application error handling here.
				throw new ApplicationException(String.Format(
					"The publication {0} could not be deleted.",
					publicationName), ex);
			}
			finally
			{
				conn.Disconnect();
			}

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top

Community Additions

Show:
© 2015 Microsoft