Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

TransSubscription Class

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

The TransSubscription type exposes the following members.

  NameDescription
Public methodTransSubscription()Creates a new instance of the TransSubscription class.
Public methodTransSubscription(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.
Top
  NameDescription
Public propertyAgentJobIdGets the ID of the agent job used to synchronize the subscription. (Inherited from Subscription.)
Public propertyAgentOffloadGets 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.)
Public propertyAgentOffloadServerGets or sets the name of the remote computer where the agent runs when using remote agent activation. (Inherited from Subscription.)
Public propertyAgentScheduleGets the schedule for the agent job used to synchronize the subscription. (Inherited from Subscription.)
Public propertyBackupInformationGets or sets information needed to initialize a subscription from a backup.
Public propertyCachePropertyChangesGets or sets whether to cache changes made to the replication properties or to apply them immediately. (Inherited from ReplicationObject.)
Public propertyConnectionContextGets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public propertyCreateSyncAgentByDefaultGets or sets whether the agent job used to synchronize the subscription is created by default. (Inherited from Subscription.)
Public propertyDatabaseNameGets or sets the name of the publication database. (Inherited from Subscription.)
Public propertyDtsPackageLocationGets or sets the location of the Microsoft SQL Server 2000 Data Transformation Services (DTS) package.
Public propertyDtsPackageNameGets or sets the name of the Microsoft SQL Server 2000 Data Transformation Services (DTS) package that is applied at the Subscriber.
Public propertyDtsPackagePasswordSets the password used to run the Microsoft SQL Server 2000 Data Transformation Services (DTS) package.
Public propertyEnabledForSynchronizationManagerSpecifies whether the subscription can be synchronized using Microsoft Windows Synchronization Manager. (Inherited from Subscription.)
Public propertyFullSubscriptionInfrastructure. Gets a value that indicates whether the subscription is full.
Public propertyIsExistingObjectGets whether the object exists on the server or not. (Inherited from ReplicationObject.)
Public propertyLoopBackDetectionGets or sets whether or not the Distribution Agent sends transactions that originated at the Subscriber back to the Subscriber.
Public propertyNameGets the name assigned to an existing subscription. (Inherited from Subscription.)
Public propertyPublicationNameGets or sets the name of the publication to which the subscription subscribes. (Inherited from Subscription.)
Public propertyPublisherNameGets or sets the name of the Publisher when the subscription belongs to a non- SQL Server Publisher.
Public propertySecureDtsPackagePasswordSets the password (as a SecureString object) used to run the Microsoft SQL Server 2000 Data Transformation Services (DTS) package.
Public propertySqlServerNameGets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)
Public propertyStatusGets the status of the subscription. (Inherited from Subscription.)
Public propertySubscriberCatalogGets or sets the catalog used when making a connection to the OLE DB provider for a non-SQL Server Subscriber.
Public propertySubscriberDatasourceName of the data source as understood by the OLE DB provider for a non-SQL Server Subscriber.
Public propertySubscriberDatasourceTypeIdentifies the type of data source that is a non-SQL Server Subscriber.
Public propertySubscriberLocationLocation of the database as understood by the OLE DB provider for the non-SQL Server Subscriber.
Public propertySubscriberNameGets or sets the name of the instance of Microsoft SQL Server that is the Subscriber. (Inherited from Subscription.)
Public propertySubscriberProviderUnique programmatic identifier (PROGID) with which the OLE DB provider for the non-SQL Server Subscriber is registered
Public propertySubscriberProviderStringOLE DB provider-specific connection string is used to connect to the data source for non-SQL Server Subscribers.
Public propertySubscriberSecurityGets the security context used to connect to the Subscriber. (Inherited from Subscription.)
Public propertySubscriberTypeGets or sets the updating behavior for data changes at the Subscriber.
Public propertySubscriptionDBNameGets or sets the name of the database on the Subscriber that receives the replicated data. (Inherited from Subscription.)
Public propertySubscriptionLSNGets or sets the log sequence number of the subscription.
Public propertySubscriptionTypeGets whether the subscription registration is for a push or pull subscription. (Inherited from Subscription.)
Public propertySynchronizationAgentGets an instance of the TransSynchronizationAgent class that can be used to synchronize the subscription.
Public propertySynchronizationAgentNameGets or sets the name of the agent job created to synchronize the subscription. (Inherited from Subscription.)
Public propertySynchronizationAgentProcessSecurityGets 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.)
Public propertySyncTypeGets or sets the manner in which the subscription is initialized. (Inherited from Subscription.)
Public propertyUserDataGets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)
Top
  NameDescription
Public methodCommitPropertyChangesSends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public methodCreateCreates the subscription registration at the Publisher. (Inherited from Subscription.)
Public methodDecoupleDecouples the referenced replication object from the server. (Inherited from ReplicationObject.)
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodLoadLoads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Public methodLoadPropertiesLoads the properties of an existing object from the server. (Inherited from ReplicationObject.)
Public methodRefreshReloads the properties of the object. (Inherited from ReplicationObject.)
Public methodReinitialize()Marks the subscription for reinitialization the next time the Distribution Agent runs to synchronize the subscription.
Public methodReinitialize(Boolean)Reinitializes the subscription.
Public methodRemoveDeletes the subscription registration at the Publisher and removes replication objects at the Subscriber for a push subscription. (Inherited from Subscription.)
Public methodScriptReturns a Transact-SQL script that can be used to create or delete the subscription. (Inherited from Subscription.)
Public methodStopSynchronizationJobAttempts to stop a running Distribution Agent job that is currently synchronizing the subscription.
Public methodSynchronizeWithJobStarts the agent job to synchronize the subscription.
Public methodToString (Inherited from Object.)
Top

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 Encrypting Connections to SQL Server.

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.

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.

			// 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();
			}
' Define the Publisher, publication, and databases.
Dim publicationName As String = "AdvWorksProductTran"
Dim publisherName As String = publisherInstance
Dim subscriberName As String = subscriberInstance
Dim subscriptionDbName As String = "AdventureWorks2012Replica"
Dim publicationDbName As String = "AdventureWorks2012"

'Create a connection to the Publisher.
Dim conn As ServerConnection = New ServerConnection(subscriberName)

' Create the objects that we need.
Dim publication As TransPublication
Dim subscription As TransSubscription

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 Then
        If (publication.Attributes And PublicationAttributes.AllowPush) = 0 Then
            publication.Attributes = publication.Attributes _
            Or PublicationAttributes.AllowPush
        End If

        ' 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))
    End If

Catch ex As Exception
    ' Implement the appropriate error handling here.
    Throw New ApplicationException(String.Format( _
        "The subscription to {0} could not be created.", publicationName), ex)
Finally
    conn.Disconnect()
End Try
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.