Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
MSDN Library

TransPullSubscription Class

 

Applies To: SQL Server 2016 Preview

Represents a pull subscription to a transactional publication.

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


public sealed class TransPullSubscription : PullSubscription

NameDescription
System_CAPS_pubmethodTransPullSubscription()

Creates a new instance of the TransPullSubscription class.

System_CAPS_pubmethodTransPullSubscription(String, String, String, String, ServerConnection)

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

System_CAPS_pubmethodTransPullSubscription(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.

NameDescription
System_CAPS_pubpropertyAgentJobId

Gets the ID of the agent job used to synchronize the subscription.(Inherited from PullSubscription.)

System_CAPS_pubpropertyAgentOffload

Gets or sets whether or not 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 PullSubscription.)

System_CAPS_pubpropertyAgentOffloadServer

Gets or sets the name of the remote computer where the agent runs when using remote agent activation. (Inherited from PullSubscription.)

System_CAPS_pubpropertyAgentSchedule

Gets the schedule for the agent job used to synchronize the subscription. (Inherited from PullSubscription.)

System_CAPS_pubpropertyAltSnapshotFolder

Gets or sets the location where the publication snapshot files are obtained when the default snapshot location at the Distributor is not used. (Inherited from PullSubscription.)

System_CAPS_pubpropertyAttributes

Gets or sets the attributes of a transactional publication that are supported by the subscription.

System_CAPS_pubpropertyCachePropertyChanges

Gets or sets whether to cache changes made to the replication properties or to apply them immediately.(Inherited from ReplicationObject.)

System_CAPS_pubpropertyConnectionContext

Gets or sets the connection to an instance of Microsoft SQL Server.(Inherited from ReplicationObject.)

System_CAPS_pubpropertyCreateSyncAgentByDefault

Gets or sets whether or not the agent job used to start the Replication Agent to synchronize the subscription is created when the subscription is created.(Inherited from PullSubscription.)

System_CAPS_pubpropertyDatabaseName

Gets or sets the name of the subscription database.(Inherited from PullSubscription.)

System_CAPS_pubpropertyDescription

Gets or sets a textual description of the pull subscription. (Inherited from PullSubscription.)

System_CAPS_pubpropertyDistributorName

Gets or sets the instance of Microsoft SQL Server that is the Distributor and is distributing the publication to which the subscription subscribes. (Inherited from PullSubscription.)

System_CAPS_pubpropertyDistributorSecurity

Gets the security context used to connect to the Distributor.(Inherited from PullSubscription.)

System_CAPS_pubpropertyDtsPackageLocation

Gets or sets the location of the Data Transformation Services (DTS) package used with a transformable subscription.

System_CAPS_pubpropertyDtsPackageName

Gets or sets the Data Transformation Services (DTS) package name used in a transformable subscription.

System_CAPS_pubpropertyDtsPackagePassword

Sets the password that is used with a transformable subscription.

System_CAPS_pubpropertyEnabledForSynchronizationManager

Specifies whether or not the subscription can be synchronized using Windows Synchronization Manager.(Inherited from PullSubscription.)

System_CAPS_pubpropertyFtpAddress

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the IP address of the FTP server.(Inherited from PullSubscription.)

System_CAPS_pubpropertyFtpLogin

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the FTP login.(Inherited from PullSubscription.)

System_CAPS_pubpropertyFtpPassword

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the FTP password.(Inherited from PullSubscription.)

System_CAPS_pubpropertyFtpPort

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the port number for the FTP server.(Inherited from PullSubscription.)

System_CAPS_pubpropertyIsExistingObject

Gets whether the object exists on the server or not.(Inherited from ReplicationObject.)

System_CAPS_pubpropertyLastAgentDateTime

Gets the date and time when the subscription was last synchronized. (Inherited from PullSubscription.)

System_CAPS_pubpropertyLastAgentStatus

Gets the status of the most recent synchronization of the subscription.(Inherited from PullSubscription.)

System_CAPS_pubpropertyLastAgentSummary

Gets a summary of the result of the most recent synchronization of the subscription. (Inherited from PullSubscription.)

System_CAPS_pubpropertyLastSummaryDateTime

Gets the date and time that the last synchronization was completed.

System_CAPS_pubpropertyName

Gets the name generated for the pull subscription.(Inherited from PullSubscription.)

System_CAPS_pubpropertyPublicationDBName

Gets or sets the name of the publication database.(Inherited from PullSubscription.)

System_CAPS_pubpropertyPublicationName

Gets or sets the name of the publication to which the subscription subscribes. (Inherited from PullSubscription.)

System_CAPS_pubpropertyPublisherName

Gets or sets the name of the Publisher.(Inherited from PullSubscription.)

System_CAPS_pubpropertyPublisherSecurity

Gets or sets the security context used by the Synchronization Agent when connecting to the Publisher. (Inherited from PullSubscription.)

System_CAPS_pubpropertySecureFtpPassword

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the secured password for the login used to connect to the FTP server.(Inherited from PullSubscription.)

System_CAPS_pubpropertySqlServerName

Gets the name of the Microsoft SQL Server instance to which this object is connected. (Inherited from ReplicationObject.)

System_CAPS_pubpropertySubscriberSecurity

Gets the security context that is used by the Synchronization Agent when connecting to the Subscriber. (Inherited from PullSubscription.)

System_CAPS_pubpropertySubscriberType

Gets or sets the updating behavior of the subscription.

System_CAPS_pubpropertySubscriptionId

Gets the subscription ID value.(Inherited from PullSubscription.)

System_CAPS_pubpropertySubscriptionType

Gets whether the subscription registration is for a push, pull, or anonymous subscription. (Inherited from PullSubscription.)

System_CAPS_pubpropertySynchronizationAgent

Gets an object that represents an instance of the Distribution Agent that can be used to synchronize the subscription.

System_CAPS_pubpropertySynchronizationAgentProcessSecurity

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 PullSubscription.)

System_CAPS_pubpropertyType

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the publication type.(Inherited from PullSubscription.)

System_CAPS_pubpropertyUseFtp

Gets or sets whether or not the snapshot files needed to initialize the pull subscription are accessed by the Synchronization Agent using File Transfer Protocol (FTP). (Inherited from PullSubscription.)

System_CAPS_pubpropertyUserData

Gets or sets an object property that allows users to attach their own data to the object. (Inherited from ReplicationObject.)

System_CAPS_pubpropertyWorkingDirectory

Gets or sets the path of the directory at the Subscriber that is used to temporarily store and decompress downloaded snapshot files.(Inherited from PullSubscription.)

NameDescription
System_CAPS_pubmethodCommitPropertyChanges()

Sends all the cached property change statements to the instance of Microsoft SQL Server.(Inherited from ReplicationObject.)

System_CAPS_pubmethodCreate()

Creates the pull subscription on the Subscriber.(Inherited from PullSubscription.)

System_CAPS_pubmethodDecouple()

Decouples the referenced replication object from the server. (Inherited from ReplicationObject.)

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodLastAgentJobHistoryInfo()

Returns information on the last Synchronization Agent job that was run.(Inherited from PullSubscription.)

System_CAPS_pubmethodLoad()

Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)

System_CAPS_pubmethodLoadProperties()

Loads the properties of an existing object from the server. (Inherited from ReplicationObject.)

System_CAPS_pubmethodRefresh()

Reloads the properties of the object. (Inherited from ReplicationObject.)

System_CAPS_pubmethodReinitialize()

Marks the pull subscription for reinitialization.

System_CAPS_pubmethodRemove()

Removes the pull subscription.(Inherited from PullSubscription.)

System_CAPS_pubmethodScript(ScriptOptions)

Returns a Transact-SQL script to create or delete the pull subscription based on the current property setting of the PullSubscription object. (Inherited from PullSubscription.)

System_CAPS_pubmethodStopSynchronizationJob()

Attempts to stop a running Distribution Agent job that is currently synchronizing the subscription.(Overrides PullSubscription.StopSynchronizationJob().)

System_CAPS_pubmethodSynchronizeWithJob()

Starts the agent job to synchronize the subscription. (Overrides PullSubscription.SynchronizeWithJob().)

System_CAPS_pubmethodToString()

(Inherited from Object.)

For a pull subscription, the Distribution Agent runs at the Subscriber.

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.

Legacy Code Example

			// 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();
			}

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

Return to top

Community Additions

Show:
© 2015 Microsoft