• Article

TransSubscription Class

Represents a push subscription to a transactional or snapshot publication.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Replication.ReplicationObject
    Microsoft.SqlServer.Replication.Subscription
      Microsoft.SqlServer.Replication.TransSubscription

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

Syntax

'Declaration
Public NotInheritable Class TransSubscription _
    Inherits Subscription
'Usage
Dim instance As TransSubscription

public sealed class TransSubscription : Subscription

public ref class TransSubscription sealed : public Subscription

[<SealedAttribute>]
type TransSubscription =  
    class
        inherit Subscription
    end

public final class TransSubscription extends Subscription

The TransSubscription type exposes the following members.

Constructors

  Name Description
Public method TransSubscription() Creates a new instance of the TransSubscription class.
Public method TransSubscription(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

Properties

  Name Description
Public property AgentJobId Gets the ID of the agent job used to synchronize the subscription. (Inherited from Subscription.)
Public property AgentOffload 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.)
Public property AgentOffloadServer Gets or sets the name of the remote computer where the agent runs when using remote agent activation. (Inherited from Subscription.)
Public property AgentSchedule Gets the schedule for the agent job used to synchronize the subscription. (Inherited from Subscription.)
Public property BackupInformation Gets or sets information needed to initialize a subscription from a backup.
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 ConnectionContext Gets or sets the connection to an instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public property CreateSyncAgentByDefault Gets or sets whether the agent job used to synchronize the subscription is created by default. (Inherited from Subscription.)
Public property DatabaseName Gets or sets the name of the publication database. (Inherited from Subscription.)
Public property DtsPackageLocation Gets or sets the location of the Microsoft SQL Server 2000 Data Transformation Services (DTS) package.
Public property DtsPackageName Gets or sets the name of the Microsoft SQL Server 2000 Data Transformation Services (DTS) package that is applied at the Subscriber.
Public property DtsPackagePassword Sets the password used to run the Microsoft SQL Server 2000 Data Transformation Services (DTS) package.
Public property EnabledForSynchronizationManager Specifies whether the subscription can be synchronized using Microsoft Windows Synchronization Manager. (Inherited from Subscription.)
Public property FullSubscription Infrastructure.
Public property IsExistingObject Gets whether the object exists on the server or not. (Inherited from ReplicationObject.)
Public property LoopBackDetection Gets or sets whether or not the Distribution Agent sends transactions that originated at the Subscriber back to the Subscriber.
Public property Name Gets the name assigned to an existing subscription. (Inherited from Subscription.)
Public property PublicationName Gets or sets the name of the publication to which the subscription subscribes. (Inherited from Subscription.)
Public property PublisherName Gets or sets the name of the Publisher when the subscription belongs to a non- SQL Server Publisher.
Public property SecureDtsPackagePassword Sets the password (as a SecureString object) used to run the Microsoft SQL Server 2000 Data Transformation Services (DTS) package.
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 the status of the subscription. (Inherited from Subscription.)
Public property SubscriberCatalog Gets or sets the catalog used when making a connection to the OLE DB provider for a non-SQL Server Subscriber.
Public property SubscriberDatasource Name of the data source as understood by the OLE DB provider for a non-SQL Server Subscriber.
Public property SubscriberDatasourceType Identifies the type of data source that is a non-SQL Server Subscriber.
Public property SubscriberLocation Location of the database as understood by the OLE DB provider for the non-SQL Server Subscriber.
Public property SubscriberName Gets or sets the name of the instance of Microsoft SQL Server that is the Subscriber. (Inherited from Subscription.)
Public property SubscriberProvider Unique programmatic identifier (PROGID) with which the OLE DB provider for the non-SQL Server Subscriber is registered
Public property SubscriberProviderString OLE DB provider-specific connection string is used to connect to the data source for non-SQL Server Subscribers.
Public property SubscriberSecurity Gets the security context used to connect to the Subscriber. (Inherited from Subscription.)
Public property SubscriberType Gets or sets the updating behavior for data changes at the Subscriber.
Public property SubscriptionDBName Gets or sets the name of the database on the Subscriber that receives the replicated data. (Inherited from Subscription.)
Public property SubscriptionLSN
Public property SubscriptionType Gets whether the subscription registration is for a push or pull subscription. (Inherited from Subscription.)
Public property SynchronizationAgent Gets an instance of the TransSynchronizationAgent class that can be used to synchronize the subscription.
Public property SynchronizationAgentName Gets or sets the name of the agent job created to synchronize the subscription. (Inherited from Subscription.)
Public property SynchronizationAgentProcessSecurity 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.)
Public property SyncType Gets or sets the manner in which the subscription is initialized. (Inherited from Subscription.)
Public property UserData Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)

Top

Methods

  Name Description
Protected method CheckValidCreation Infrastructure. (Inherited from ReplicationObject.)
Protected method CheckValidDefinition Infrastructure. (Inherited from Subscription.)
Public method CommitPropertyChanges Sends all the cached property change statements to the instance of Microsoft SQL Server. (Inherited from ReplicationObject.)
Public method Create Creates the subscription registration at the Publisher. (Inherited from Subscription.)
Public method Decouple Decouples the referenced replication object from the server. (Inherited from ReplicationObject.)
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Protected method GetChangeCommand Infrastructure. (Inherited from ReplicationObject.)
Protected method GetCreateCommand Infrastructure. (Inherited from ReplicationObject.)
Protected method GetDropCommand Infrastructure. (Inherited from ReplicationObject.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method InternalRefresh 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.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Refresh Reloads the properties of the object. (Inherited from ReplicationObject.)
Public method Reinitialize() Marks the subscription for reinitialization the next time the Distribution Agent runs to synchronize the subscription.
Public method Reinitialize(Boolean)
Public method Remove Deletes the subscription registration at the Publisher and removes replication objects at the Subscriber for a push subscription. (Inherited from Subscription.)
Public method Script Returns a Transact-SQL script that can be used to create or delete the subscription. (Inherited from Subscription.)
Public method StopSynchronizationJob Attempts to stop a running Distribution Agent job that is currently synchronizing the subscription.
Public method SynchronizeWithJob Starts the agent job to synchronize the subscription.
Public method ToString (Inherited from Object.)

Top

Remarks

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.

This namespace, class, or member is supported only in version 2.0 of the .NET Framework.

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.

Examples

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

            //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 = "AdventureWorks2008R2Replica"
Dim publicationDbName As String = "AdventureWorks2008R2"

'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

Thread Safety

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