Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

TransSubscription Class

 

Applies To: SQL Server 2016 Preview

Represents a push subscription to a transactional or snapshot publication.

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


public sealed class TransSubscription : Subscription

NameDescription
System_CAPS_pubmethodTransSubscription()

Creates a new instance of the TransSubscription class.

System_CAPS_pubmethodTransSubscription(String, String, String, String, ServerConnection)

Creates a new instance of the TransSubscription class with the specified publication, database, Subscriber, and subscriber database, and with the specified connection to the instance of Microsoft SQL Server.

NameDescription
System_CAPS_pubpropertyAgentJobId

Gets the ID of the agent job used to synchronize the subscription.(Inherited from Subscription.)

System_CAPS_pubpropertyAgentOffload

Gets or sets whether the synchronization agent runs on a computer other than the one where the agent job was created. This property is no longer supported for Distributors running Microsoft SQL Server 2005 and later.(Inherited from Subscription.)

System_CAPS_pubpropertyAgentOffloadServer

Gets or sets the name of the remote computer where the agent runs when using remote agent activation. (Inherited from Subscription.)

System_CAPS_pubpropertyAgentSchedule

Gets the schedule for the agent job used to synchronize the subscription. (Inherited from Subscription.)

System_CAPS_pubpropertyBackupInformation

Gets or sets information needed to initialize a subscription from a backup.

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_pubpropertyConnectionContext

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

System_CAPS_pubpropertyCreateSyncAgentByDefault

Gets or sets whether the agent job used to synchronize the subscription is created by default.(Inherited from Subscription.)

System_CAPS_pubpropertyDatabaseName

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

System_CAPS_pubpropertyDtsPackageLocation

Gets or sets the location of the Microsoft SQL Server 2000 Data Transformation Services (DTS) package.

System_CAPS_pubpropertyDtsPackageName

Gets or sets the name of the Microsoft SQL Server 2000 Data Transformation Services (DTS) package that is applied at the Subscriber.

System_CAPS_pubpropertyDtsPackagePassword

Sets the password used to run the Microsoft SQL Server 2000 Data Transformation Services (DTS) package.

System_CAPS_pubpropertyEnabledForSynchronizationManager

Specifies whether the subscription can be synchronized using Microsoft Windows Synchronization Manager.(Inherited from Subscription.)

System_CAPS_pubpropertyFullSubscription

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value that indicates whether the subscription is full.

System_CAPS_pubpropertyIsExistingObject

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

System_CAPS_pubpropertyLoopBackDetection

Gets or sets whether or not the Distribution Agent sends transactions that originated at the Subscriber back to the Subscriber.

System_CAPS_pubpropertyName

Gets the name assigned to an existing subscription.(Inherited from Subscription.)

System_CAPS_pubpropertyPublicationName

Gets or sets the name of the publication to which the subscription subscribes.(Inherited from Subscription.)

System_CAPS_pubpropertyPublisherName

Gets or sets the name of the Publisher when the subscription belongs to a non- SQL Server Publisher.

System_CAPS_pubpropertySecureDtsPackagePassword

Sets the password (as a SecureString object) used to run the Microsoft SQL Server 2000 Data Transformation Services (DTS) package.

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 the status of the subscription.(Inherited from Subscription.)

System_CAPS_pubpropertySubscriberCatalog

Gets or sets the catalog used when making a connection to the OLE DB provider for a non-SQL Server Subscriber.

System_CAPS_pubpropertySubscriberDatasource

Name of the data source as understood by the OLE DB provider for a non-SQL Server Subscriber.

System_CAPS_pubpropertySubscriberDatasourceType

Identifies the type of data source that is a non-SQL Server Subscriber.

System_CAPS_pubpropertySubscriberLocation

Location of the database as understood by the OLE DB provider for the non-SQL Server Subscriber.

System_CAPS_pubpropertySubscriberName

Gets or sets the name of the instance of Microsoft SQL Server that is the Subscriber. (Inherited from Subscription.)

System_CAPS_pubpropertySubscriberProvider

Unique programmatic identifier (PROGID) with which the OLE DB provider for the non-SQL Server Subscriber is registered

System_CAPS_pubpropertySubscriberProviderString

OLE DB provider-specific connection string is used to connect to the data source for non-SQL Server Subscribers.

System_CAPS_pubpropertySubscriberSecurity

Gets the security context used to connect to the Subscriber.(Inherited from Subscription.)

System_CAPS_pubpropertySubscriberType

Gets or sets the updating behavior for data changes at the Subscriber.

System_CAPS_pubpropertySubscriptionDBName

Gets or sets the name of the database on the Subscriber that receives the replicated data.(Inherited from Subscription.)

System_CAPS_pubpropertySubscriptionLSN

Gets or sets the log sequence number of the subscription.

System_CAPS_pubpropertySubscriptionType

Gets whether the subscription registration is for a push or pull subscription. (Inherited from Subscription.)

System_CAPS_pubpropertySynchronizationAgent

Gets an instance of the TransSynchronizationAgent class that can be used to synchronize the subscription.

System_CAPS_pubpropertySynchronizationAgentName

Gets or sets the name of the agent job created to synchronize the subscription. (Inherited from Subscription.)

System_CAPS_pubpropertySynchronizationAgentProcessSecurity

Gets the security context that is used to specify the Microsoft Windows account under which the synchronization agent job runs to synchronize the subscription.(Inherited from Subscription.)

System_CAPS_pubpropertySyncType

Gets or sets the manner in which the subscription is initialized. (Inherited from Subscription.)

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_pubmethodCommitPropertyChanges()

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

System_CAPS_pubmethodCreate()

Creates the subscription registration at the Publisher.(Inherited from Subscription.)

System_CAPS_pubmethodDecouple()

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

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

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_pubmethodRefresh()

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

System_CAPS_pubmethodReinitialize()

Marks the subscription for reinitialization the next time the Distribution Agent runs to synchronize the subscription.

System_CAPS_pubmethodReinitialize(Boolean)

Reinitializes the subscription.

System_CAPS_pubmethodRemove()

Deletes the subscription registration at the Publisher and removes replication objects at the Subscriber for a push subscription.(Inherited from Subscription.)

System_CAPS_pubmethodScript(ScriptOptions)

Returns a Transact-SQL script that can be used to create or delete the subscription. (Inherited from Subscription.)

System_CAPS_pubmethodStopSynchronizationJob()

Attempts to stop a running Distribution Agent job that is currently synchronizing the subscription.

System_CAPS_pubmethodSynchronizeWithJob()

Starts the agent job to synchronize the subscription.

System_CAPS_pubmethodToString()

(Inherited from Object.)

When configuring a Publisher with a remote Distributor, the values supplied for all parameters, including SynchronizationAgentProcessSecurity, are sent to the Distributor as plain text. You should encrypt the connection between the Publisher and its remote Distributor before calling the Create method. For more information, see .

When the subscription belongs to a non-SQL Server Publisher, the ConnectionContext property is set to the Distributor instead of Publisher, the DatabaseName property is set to the distribution database instead of the publication database, and the PublisherName property is set to the name of the non-SQL Server Publisher.

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

			// Define the Publisher, publication, and databases.
			string publicationName = "AdvWorksProductTran";
			string publisherName = publisherInstance;
			string subscriberName = subscriberInstance;
			string subscriptionDbName = "AdventureWorks2012Replica";
			string publicationDbName = "AdventureWorks2012";

			//Create a connection to the Publisher.
			ServerConnection conn = new ServerConnection(subscriberName);

			// Create the objects that we need.
			TransPublication publication;
			TransSubscription subscription;

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

				// Ensure that the publication exists and that 
				// it supports push subscriptions.
				publication = new TransPublication();
				publication.Name = publicationName;
				publication.DatabaseName = publicationDbName;
				publication.ConnectionContext = conn;

				if (publication.IsExistingObject)
				{
					if ((publication.Attributes & PublicationAttributes.AllowPush) == 0)
					{
						publication.Attributes |= PublicationAttributes.AllowPush;
					}

					// Define the push subscription.
					subscription = new TransSubscription();
					subscription.ConnectionContext = conn;
					subscription.SubscriberName = subscriberName;
					subscription.PublicationName = publicationName;
					subscription.DatabaseName = publicationDbName;
					subscription.SubscriptionDBName = subscriptionDbName;

					// Specify the Windows login credentials for the Distribution Agent job.
					subscription.SynchronizationAgentProcessSecurity.Login = winLogin;
					subscription.SynchronizationAgentProcessSecurity.Password = winPassword;

                    // By default, subscriptions to transactional publications are synchronized 
                    // continuously, but in this case we only want to synchronize on demand.
                    subscription.AgentSchedule.FrequencyType = ScheduleFrequencyType.OnDemand;
 
					// Create the push subscription.
					subscription.Create();
				}
				else
				{
					// Do something here if the publication does not exist.
					throw new ApplicationException(String.Format(
						"The publication '{0}' does not exist on {1}.",
						publicationName, publisherName));
				}
			}
			catch (Exception ex)
			{
				// Implement the appropriate error handling here.
				throw new ApplicationException(String.Format(
					"The subscription to {0} could not be created.", 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