TransPublication.MakePullSubscriptionWellKnown Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Replication

Assembly:: Microsoft.SqlServer.Rmo.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

MakePullSubscriptionWellKnown(String, String, SubscriptionSyncType, TransSubscriberType)	Registers a pull subscription at the Publisher.
MakePullSubscriptionWellKnown(String, String, SubscriptionSyncType, TransSubscriberType, Boolean)

MakePullSubscriptionWellKnown(String, String, SubscriptionSyncType, TransSubscriberType)

Registers a pull subscription at the Publisher.

public:
 void MakePullSubscriptionWellKnown(System::String ^ subscriber, System::String ^ subscriptionDB, Microsoft::SqlServer::Replication::SubscriptionSyncType syncType, Microsoft::SqlServer::Replication::TransSubscriberType subscriberType);

public void MakePullSubscriptionWellKnown (string subscriber, string subscriptionDB, Microsoft.SqlServer.Replication.SubscriptionSyncType syncType, Microsoft.SqlServer.Replication.TransSubscriberType subscriberType);

member this.MakePullSubscriptionWellKnown : string * string * Microsoft.SqlServer.Replication.SubscriptionSyncType * Microsoft.SqlServer.Replication.TransSubscriberType -> unit

Public Sub MakePullSubscriptionWellKnown (subscriber As String, subscriptionDB As String, syncType As SubscriptionSyncType, subscriberType As TransSubscriberType)

Parameters

subscriber: String

A String value that specifies the name of the Subscriber where the pull subscription was created.

subscriptionDB: String

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

syncType: SubscriptionSyncType

A SubscriptionSyncType object value that specifies how the subscription synchronization is performed.

subscriberType: TransSubscriberType

A TransSubscriberType object value that specifies the subscription behavior when a Subscriber initiates a change to data in an article image.

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

You must call MakePullSubscriptionWellKnown at the Publisher when creating a pull subscription.

Use EnumSubscriptions to determine if a subscription is already registered at the Publisher. If the registration exists, MakePullSubscriptionWellKnown generates an error at the server.

The MakePullSubscriptionWellKnown method can only be called by members of the sysadmin fixed server role at the Publisher, by members of the db_owner fixed database role on the publication database, or by users in the publication access list (PAL).

Calling MakePullSubscriptionWellKnown is equivalent to executing sp_addsubscription for a pull subscription.

Applies to

MakePullSubscriptionWellKnown(String, String, SubscriptionSyncType, TransSubscriberType, Boolean)

public:
 void MakePullSubscriptionWellKnown(System::String ^ subscriber, System::String ^ subscriptionDB, Microsoft::SqlServer::Replication::SubscriptionSyncType syncType, Microsoft::SqlServer::Replication::TransSubscriberType subscriberType, bool IsMemoryOptimized);

public void MakePullSubscriptionWellKnown (string subscriber, string subscriptionDB, Microsoft.SqlServer.Replication.SubscriptionSyncType syncType, Microsoft.SqlServer.Replication.TransSubscriberType subscriberType, bool IsMemoryOptimized);

member this.MakePullSubscriptionWellKnown : string * string * Microsoft.SqlServer.Replication.SubscriptionSyncType * Microsoft.SqlServer.Replication.TransSubscriberType * bool -> unit

Public Sub MakePullSubscriptionWellKnown (subscriber As String, subscriptionDB As String, syncType As SubscriptionSyncType, subscriberType As TransSubscriberType, IsMemoryOptimized As Boolean)

Parameters

subscriber: String

subscriptionDB: String

syncType: SubscriptionSyncType

subscriberType: TransSubscriberType

IsMemoryOptimized: Boolean

Applies to

Share via

TransPublication.MakePullSubscriptionWellKnown Method

Definition

Overloads

MakePullSubscriptionWellKnown(String, String, SubscriptionSyncType, TransSubscriberType)

Parameters

Examples

Remarks

See also

Applies to

MakePullSubscriptionWellKnown(String, String, SubscriptionSyncType, TransSubscriberType, Boolean)

Parameters

Applies to

Additional resources