TransSubscription TransSubscription TransSubscription Class

Definition

Represents a push subscription to a transactional or snapshot publication.

public ref class TransSubscription sealed : Microsoft::SqlServer::Replication::Subscription
public sealed class TransSubscription : Microsoft.SqlServer.Replication.Subscription
Public NotInheritable Class TransSubscription
Inherits Subscription
Inheritance

Examples

// 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

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 sp_reinitsubscription (Transact-SQL).

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.

Constructors

TransSubscription() TransSubscription() TransSubscription()

Creates a new instance of the TransSubscription class.

TransSubscription(String, String, String, String, ServerConnection) TransSubscription(String, String, String, String, ServerConnection) 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.

Properties

AgentJobId AgentJobId AgentJobId

Gets the ID of the agent job used to synchronize the subscription.

(Inherited from Subscription)
AgentOffload AgentOffload 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)
AgentOffloadServer AgentOffloadServer AgentOffloadServer

Gets or sets the name of the remote computer where the agent runs when using remote agent activation.

(Inherited from Subscription)
AgentSchedule AgentSchedule AgentSchedule

Gets the schedule for the agent job used to synchronize the subscription.

(Inherited from Subscription)
BackupInformation BackupInformation BackupInformation

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

CachePropertyChanges CachePropertyChanges CachePropertyChanges

Gets or sets whether to cache changes made to the replication properties or to apply them immediately.

(Inherited from ReplicationObject)
ConnectionContext ConnectionContext ConnectionContext

Gets or sets the connection to an instance of Microsoft SQL Server.

(Inherited from ReplicationObject)
CreateSyncAgentByDefault CreateSyncAgentByDefault CreateSyncAgentByDefault

Gets or sets whether the agent job used to synchronize the subscription is created by default.

(Inherited from Subscription)
DatabaseName DatabaseName DatabaseName

Gets or sets the name of the publication database.

(Inherited from Subscription)
DtsPackageLocation DtsPackageLocation DtsPackageLocation

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

DtsPackageName DtsPackageName DtsPackageName

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

DtsPackagePassword DtsPackagePassword DtsPackagePassword

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

EnabledForSynchronizationManager EnabledForSynchronizationManager EnabledForSynchronizationManager

Specifies whether the subscription can be synchronized using Microsoft Windows Synchronization Manager.

(Inherited from Subscription)
FullSubscription FullSubscription FullSubscription

Gets a value that indicates whether the subscription is full.

IsExistingObject IsExistingObject IsExistingObject

Gets whether the object exists on the server or not.

(Inherited from ReplicationObject)
LoopBackDetection LoopBackDetection LoopBackDetection

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

MemoryOptimized MemoryOptimized MemoryOptimized
Name Name Name

Gets the name assigned to an existing subscription.

(Inherited from Subscription)
PublicationName PublicationName PublicationName

Gets or sets the name of the publication to which the subscription subscribes.

(Inherited from Subscription)
PublisherName PublisherName PublisherName

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

SecureDtsPackagePassword SecureDtsPackagePassword SecureDtsPackagePassword

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

SqlServerName SqlServerName SqlServerName

Gets the name of the Microsoft SQL Server instance to which this object is connected.

(Inherited from ReplicationObject)
Status Status Status

Gets the status of the subscription.

(Inherited from Subscription)
SubscriberCatalog SubscriberCatalog SubscriberCatalog

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

SubscriberDatasource SubscriberDatasource SubscriberDatasource

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

SubscriberDatasourceType SubscriberDatasourceType SubscriberDatasourceType

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

SubscriberLocation SubscriberLocation SubscriberLocation

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

SubscriberName SubscriberName SubscriberName

Gets or sets the name of the instance of Microsoft SQL Server that is the Subscriber.

(Inherited from Subscription)
SubscriberProvider SubscriberProvider SubscriberProvider

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

SubscriberProviderString SubscriberProviderString SubscriberProviderString

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

SubscriberSecurity SubscriberSecurity SubscriberSecurity

Gets the security context used to connect to the Subscriber.

(Inherited from Subscription)
SubscriberType SubscriberType SubscriberType

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

SubscriptionDBName SubscriptionDBName SubscriptionDBName

Gets or sets the name of the database on the Subscriber that receives the replicated data.

(Inherited from Subscription)
SubscriptionLSN SubscriptionLSN SubscriptionLSN

Gets or sets the log sequence number of the subscription.

SubscriptionType SubscriptionType SubscriptionType

Gets whether the subscription registration is for a push or pull subscription.

(Inherited from Subscription)
SynchronizationAgent SynchronizationAgent SynchronizationAgent

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

SynchronizationAgentName SynchronizationAgentName SynchronizationAgentName

Gets or sets the name of the agent job created to synchronize the subscription.

(Inherited from Subscription)
SynchronizationAgentProcessSecurity SynchronizationAgentProcessSecurity 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)
SyncType SyncType SyncType

Gets or sets the manner in which the subscription is initialized.

(Inherited from Subscription)
UserData UserData UserData

Gets or sets an object property that allows users to attach their own data to the object.

(Inherited from ReplicationObject)

Methods

CheckValidCreation() CheckValidCreation() CheckValidCreation()

Checks the valid replication creation.

(Inherited from ReplicationObject)
CheckValidDefinition(Boolean) CheckValidDefinition(Boolean) CheckValidDefinition(Boolean)

Indicates whether the subscription definition is valid.

(Inherited from Subscription)
CommitPropertyChanges() CommitPropertyChanges() CommitPropertyChanges()

Sends all the cached property change statements to the instance of Microsoft SQL Server.

(Inherited from ReplicationObject)
Create() Create() Create()

Creates the subscription registration at the Publisher.

(Inherited from Subscription)
Decouple() Decouple() Decouple()

Decouples the referenced replication object from the server.

(Inherited from ReplicationObject)
DoUpdateMemoryOptimizedProperty(String) DoUpdateMemoryOptimizedProperty(String) DoUpdateMemoryOptimizedProperty(String)
GetChangeCommand(StringBuilder, String, String) GetChangeCommand(StringBuilder, String, String) GetChangeCommand(StringBuilder, String, String)

Returns the change command from the replication.

(Inherited from ReplicationObject)
GetCreateCommand(StringBuilder, Boolean, ScriptOptions) GetCreateCommand(StringBuilder, Boolean, ScriptOptions) GetCreateCommand(StringBuilder, Boolean, ScriptOptions)

Returns the create command from the replication.

(Inherited from ReplicationObject)
GetDropCommand(StringBuilder, Boolean) GetDropCommand(StringBuilder, Boolean) GetDropCommand(StringBuilder, Boolean)

Returns the drop command from the replication.

(Inherited from ReplicationObject)
InternalRefresh(Boolean) InternalRefresh(Boolean) InternalRefresh(Boolean)

Initiates an internal refresh from the replication.

(Inherited from ReplicationObject)
Load() Load() Load()

Loads the properties of an existing object from the server.

(Inherited from ReplicationObject)
LoadProperties() LoadProperties() LoadProperties()

Loads the properties of an existing object from the server.

(Inherited from ReplicationObject)
Refresh() Refresh() Refresh()

Reloads the properties of the object.

(Inherited from ReplicationObject)
Reinitialize() Reinitialize() Reinitialize()

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

Reinitialize(Boolean) Reinitialize(Boolean) Reinitialize(Boolean)

Reinitializes the subscription.

Remove() Remove() Remove()

Deletes the subscription registration at the Publisher and removes replication objects at the Subscriber for a push subscription.

(Inherited from Subscription)
Script(ScriptOptions) Script(ScriptOptions) Script(ScriptOptions)

Returns a Transact-SQL script that can be used to create or delete the subscription.

(Inherited from Subscription)
StopSynchronizationJob() StopSynchronizationJob() StopSynchronizationJob()

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

SynchronizeWithJob() SynchronizeWithJob() SynchronizeWithJob()

Starts the agent job to synchronize the subscription.

Applies to

See Also