TransPullSubscription Constructors

Definition

Creates a new instance of the TransPullSubscription class.

Overloads

TransPullSubscription()

Creates a new instance of the TransPullSubscription class.

TransPullSubscription(String, String, String, String, ServerConnection)

Creates a new instance of the TransPullSubscription class with the properties that define a pull subscription.

TransPullSubscription(String, String, String, String, ServerConnection, Boolean)

Creates a new instance of the TransPullSubscription class with the properties that define a pull subscription, and whether or not to create the agent job for the subscription.

Remarks

Updated text: 17 July 2006

The following table shows the default property values for a new instance of TransPullSubscription. Any properties that are not explicitly enumerated in this table are initialized to a null value.

Property Default value
AgentOffload false
AgentSchedule A value of 99991231 for ActiveEndDate

A value of 235959 for ActiveEndTime

A value of the subscription creation date for ActiveStartDate

A value of 0 for ActiveStartTime

A value of 0 for FrequencyInterval

A value of 0 for FrequencyRecurrenceFactor

A value of 0 for FrequencySubDayInterval

A value of Continuously for FrequencyType
CachePropertyChanges false
CreateSyncAgentByDefault false
DistributorSecurity A value of true for WindowsAuthentication
EnabledForSynchronizationManager false
IsExistingObject false
SubscriberSecurity A value of true for WindowsAuthentication
SubscriberType A value of ReadOnly for TransSubscriberType
SubscriptionType A value of Pull for SubscriptionOption
SynchronizationAgent An instance of TransSynchronizationAgent from the publication that is associated with the subscription you create.
Type A value of Transactional for PublicationType
UseFtp false

TransPullSubscription()

Creates a new instance of the TransPullSubscription class.

public:
 TransPullSubscription();
public TransPullSubscription ();
Public Sub New ()

Examples

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

//Create connections to the Publisher and Subscriber.
ServerConnection subscriberConn = new ServerConnection(subscriberName);
ServerConnection publisherConn = new ServerConnection(publisherName);

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

try
{
    // Connect to the Publisher and Subscriber.
    subscriberConn.Connect();
    publisherConn.Connect();

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

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

        // Define the pull subscription.
        subscription = new TransPullSubscription();
        subscription.ConnectionContext = subscriberConn;
        subscription.PublisherName = publisherName;
        subscription.PublicationName = publicationName;
        subscription.PublicationDBName = publicationDbName;
        subscription.DatabaseName = subscriptionDbName;

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

        // Make sure that the agent job for the subscription is created.
        subscription.CreateSyncAgentByDefault = true;

        // 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 pull subscription at the Subscriber.
        subscription.Create();

        Boolean registered = false;

        // Verify that the subscription is not already registered.
        foreach (TransSubscription existing
            in publication.EnumSubscriptions())
        {
            if (existing.SubscriberName == subscriberName
                && existing.SubscriptionDBName == subscriptionDbName)
            {
                registered = true;
            }
        }
        if (!registered)
        {
            // Register the subscription with the Publisher.
            publication.MakePullSubscriptionWellKnown(
                subscriberName, subscriptionDbName,
                SubscriptionSyncType.Automatic,
                TransSubscriberType.ReadOnly);
        }
    }
    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
{
    subscriberConn.Disconnect();
    publisherConn.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 connections to the Publisher and Subscriber.
Dim subscriberConn As ServerConnection = New ServerConnection(subscriberName)
Dim publisherConn As ServerConnection = New ServerConnection(publisherName)

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

Try
    ' Connect to the Publisher and Subscriber.
    subscriberConn.Connect()
    publisherConn.Connect()

    ' Ensure that the publication exists and that 
    ' it supports pull subscriptions.
    publication = New TransPublication()
    publication.Name = publicationName
    publication.DatabaseName = publicationDbName
    publication.ConnectionContext = publisherConn

    If publication.IsExistingObject Then
        If (publication.Attributes And PublicationAttributes.AllowPull) = 0 Then
            publication.Attributes = publication.Attributes _
            Or PublicationAttributes.AllowPull
        End If

        ' Define the pull subscription.
        subscription = New TransPullSubscription()
        subscription.ConnectionContext = subscriberConn
        subscription.PublisherName = publisherName
        subscription.PublicationName = publicationName
        subscription.PublicationDBName = publicationDbName
        subscription.DatabaseName = subscriptionDbName
        subscription.Description = "Pull subscription to " + publicationDbName _
        + " on " + subscriberName + "."

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

        ' Make sure that the agent job for the subscription is created.
        subscription.CreateSyncAgentByDefault = True

        ' 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 pull subscription at the Subscriber.
        subscription.Create()

        Dim registered As Boolean = False

        ' Verify that the subscription is not already registered.
        For Each existing As TransSubscription In publication.EnumSubscriptions()
            If existing.SubscriberName = subscriberName And _
                existing.SubscriptionDBName = subscriptionDbName Then
                registered = True
            End If
        Next existing
        If Not registered Then
            ' Register the subscription with the Publisher.
            publication.MakePullSubscriptionWellKnown( _
             subscriberName, subscriptionDbName, _
             SubscriptionSyncType.Automatic, _
             TransSubscriberType.ReadOnly)
        End If
    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
    subscriberConn.Disconnect()
    publisherConn.Disconnect()
End Try

Remarks

The default constructor initializes any fields to their default values.

Applies to

TransPullSubscription(String, String, String, String, ServerConnection)

Creates a new instance of the TransPullSubscription class with the properties that define a pull subscription.

public:
 TransPullSubscription(System::String ^ subscriptionDBName, System::String ^ publisherName, System::String ^ publicationDBName, System::String ^ publicationName, Microsoft::SqlServer::Management::Common::ServerConnection ^ subscriberConnectionContext);
public TransPullSubscription (string subscriptionDBName, string publisherName, string publicationDBName, string publicationName, Microsoft.SqlServer.Management.Common.ServerConnection subscriberConnectionContext);
new Microsoft.SqlServer.Replication.TransPullSubscription : string * string * string * string * Microsoft.SqlServer.Management.Common.ServerConnection -> Microsoft.SqlServer.Replication.TransPullSubscription
Public Sub New (subscriptionDBName As String, publisherName As String, publicationDBName As String, publicationName As String, subscriberConnectionContext As ServerConnection)

Parameters

subscriptionDBName
String

A String value that specifies the name of the subscription database.

publisherName
String

A String value that specifies the name of the Publisher.

publicationDBName
String

A String value that specifies the name of the publication database.

publicationName
String

A String value that specifies the name of the publication.

subscriberConnectionContext
ServerConnection

A ServerConnection object that specifies Subscriber connection.

Applies to

TransPullSubscription(String, String, String, String, ServerConnection, Boolean)

Creates a new instance of the TransPullSubscription class with the properties that define a pull subscription, and whether or not to create the agent job for the subscription.

public:
 TransPullSubscription(System::String ^ subscriptionDBName, System::String ^ publisherName, System::String ^ publicationDBName, System::String ^ publicationName, Microsoft::SqlServer::Management::Common::ServerConnection ^ subscriberConnectionContext, bool createDistributionAgentByDefault);
public TransPullSubscription (string subscriptionDBName, string publisherName, string publicationDBName, string publicationName, Microsoft.SqlServer.Management.Common.ServerConnection subscriberConnectionContext, bool createDistributionAgentByDefault);
new Microsoft.SqlServer.Replication.TransPullSubscription : string * string * string * string * Microsoft.SqlServer.Management.Common.ServerConnection * bool -> Microsoft.SqlServer.Replication.TransPullSubscription
Public Sub New (subscriptionDBName As String, publisherName As String, publicationDBName As String, publicationName As String, subscriberConnectionContext As ServerConnection, createDistributionAgentByDefault As Boolean)

Parameters

subscriptionDBName
String

A String value that specifies the name of the subscription database.

publisherName
String

A String value that specifies the name of the Publisher.

publicationDBName
String

A String value that specifies the name of the publication database.

publicationName
String

A String value that specifies the name of the publication.

subscriberConnectionContext
ServerConnection

A ServerConnection object that specifies Subscriber connection.

createDistributionAgentByDefault
Boolean

A Boolean value that indicates whether to create the Distribution Agent job to synchronize the subscription.

Applies to