TransPullSubscription 類別
Represents a pull subscription to a transactional publication.
繼承階層
System. . :: . .Object
Microsoft.SqlServer.Replication. . :: . .ReplicationObject
Microsoft.SqlServer.Replication. . :: . .PullSubscription
Microsoft.SqlServer.Replication..::..TransPullSubscription
命名空間： Microsoft.SqlServer.Replication
組件： Microsoft.SqlServer.Rmo (在 Microsoft.SqlServer.Rmo.dll 中)
語法
'宣告
Public NotInheritable Class TransPullSubscription _
Inherits PullSubscription
'用途
Dim instance As TransPullSubscription
public sealed class TransPullSubscription : PullSubscription
public ref class TransPullSubscription sealed : public PullSubscription
[<SealedAttribute>]
type TransPullSubscription =
class
inherit PullSubscription
end
public final class TransPullSubscription extends PullSubscription
TransPullSubscription 型別公開下列成員。
建構函式
| 名稱 | 說明 | |
|---|---|---|
.gif "公用方法") |
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. |
上層
屬性
| 名稱 | 說明 | |
|---|---|---|
.gif "公用屬性") |
AgentJobId | Gets the ID of the agent job used to synchronize the subscription. (繼承自 PullSubscription。) |
|
AgentOffload | 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. (繼承自 PullSubscription。) |
|
AgentOffloadServer | Gets or sets the name of the remote computer where the agent runs when using remote agent activation. (繼承自 PullSubscription。) |
|
AgentSchedule | Gets the schedule for the agent job used to synchronize the subscription. (繼承自 PullSubscription。) |
|
AltSnapshotFolder | Gets or sets the location where the publication snapshot files are obtained when the default snapshot location at the Distributor is not used. (繼承自 PullSubscription。) |
|
Attributes | Gets or sets the attributes of a transactional publication that are supported by the subscription. |
|
CachePropertyChanges | Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (繼承自 ReplicationObject。) |
|
ConnectionContext | Gets or sets the connection to an instance of Microsoft SQL Server. (繼承自 ReplicationObject。) |
|
CreateSyncAgentByDefault | 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. (繼承自 PullSubscription。) |
|
DatabaseName | Gets or sets the name of the subscription database. (繼承自 PullSubscription。) |
|
Description | Gets or sets a textual description of the pull subscription. (繼承自 PullSubscription。) |
|
DistributorName | Gets or sets the instance of Microsoft SQL Server that is the Distributor and is distributing the publication to which the subscription subscribes. (繼承自 PullSubscription。) |
|
DistributorSecurity | Gets the security context used to connect to the Distributor. (繼承自 PullSubscription。) |
|
DtsPackageLocation | Gets or sets the location of the Data Transformation Services (DTS) package used with a transformable subscription. |
|
DtsPackageName | Gets or sets the Data Transformation Services (DTS) package name used in a transformable subscription. |
|
DtsPackagePassword | Sets the password that is used with a transformable subscription. |
|
EnabledForSynchronizationManager | Specifies whether or not the subscription can be synchronized using Windows Synchronization Manager. (繼承自 PullSubscription。) |
|
FtpAddress | 基礎結構。 (繼承自 PullSubscription。) |
|
FtpLogin | 基礎結構。 (繼承自 PullSubscription。) |
|
FtpPassword | 基礎結構。 (繼承自 PullSubscription。) |
|
FtpPort | 基礎結構。 (繼承自 PullSubscription。) |
|
IsExistingObject | Gets whether the object exists on the server or not. (繼承自 ReplicationObject。) |
|
LastAgentDateTime | Gets the date and time when the subscription was last synchronized. (繼承自 PullSubscription。) |
|
LastAgentStatus | Gets the status of the most recent synchronization of the subscription. (繼承自 PullSubscription。) |
|
LastAgentSummary | Gets a summary of the result of the most recent synchronization of the subscription. (繼承自 PullSubscription。) |
|
LastSummaryDateTime | Gets the date and time that the last synchronization was completed. |
|
Name | Gets the name generated for the pull subscription. (繼承自 PullSubscription。) |
|
PublicationDBName | Gets or sets the name of the publication database. (繼承自 PullSubscription。) |
|
PublicationName | Gets or sets the name of the publication to which the subscription subscribes. (繼承自 PullSubscription。) |
|
PublisherName | Gets or sets the name of the Publisher. (繼承自 PullSubscription。) |
|
PublisherSecurity | Gets or sets the security context used by the Synchronization Agent when connecting to the Publisher. (繼承自 PullSubscription。) |
|
SecureFtpPassword | 基礎結構。 (繼承自 PullSubscription。) |
|
SqlServerName | Gets the name of the Microsoft SQL Server instance to which this object is connected. (繼承自 ReplicationObject。) |
|
SubscriberSecurity | Gets the security context that is used by the Synchronization Agent when connecting to the Subscriber. (繼承自 PullSubscription。) |
|
SubscriberType | Gets or sets the updating behavior of the subscription. |
|
SubscriptionId | Gets the subscription ID value. (繼承自 PullSubscription。) |
|
SubscriptionType | Gets whether the subscription registration is for a push, pull, or anonymous subscription. (繼承自 PullSubscription。) |
|
SynchronizationAgent | Gets an object that represents an instance of the Distribution Agent that can be used to synchronize the subscription. |
|
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. (繼承自 PullSubscription。) |
|
Type | 基礎結構。 (繼承自 PullSubscription。) |
|
UseFtp | 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). (繼承自 PullSubscription。) |
|
UserData | Gets or sets an object property that allows users to attach their own data to the object. (繼承自 ReplicationObject。) |
|
WorkingDirectory | Gets or sets the path of the directory at the Subscriber that is used to temporarily store and decompress downloaded snapshot files. (繼承自 PullSubscription。) |
上層
方法
| 名稱 | 說明 | |
|---|---|---|
.gif "受保護的方法") |
CheckValidCreation | 基礎結構。 (繼承自 ReplicationObject。) |
|
CheckValidDefinition | 基礎結構。 (繼承自 PullSubscription。) |
|
CommitPropertyChanges | Sends all the cached property change statements to the instance of Microsoft SQL Server. (繼承自 ReplicationObject。) |
|
Create | Creates the pull subscription on the Subscriber. (繼承自 PullSubscription。) |
|
CustomEnabledForSyncMgr | 基礎結構。 (繼承自 PullSubscription。) |
|
Decouple | Decouples the referenced replication object from the server. (繼承自 ReplicationObject。) |
|
Equals | (繼承自 Object。) |
|
Finalize | (繼承自 Object。) |
|
GetChangeCommand | 基礎結構。 (繼承自 ReplicationObject。) |
|
GetCreateCommand | 基礎結構。 (繼承自 ReplicationObject。) |
|
GetDropCommand | 基礎結構。 (繼承自 ReplicationObject。) |
|
GetHashCode | (繼承自 Object。) |
|
GetType | (繼承自 Object。) |
|
InitMemberVariables | 基礎結構。 (繼承自 PullSubscription。) |
|
InternalRefresh | 基礎結構。 (繼承自 ReplicationObject。) |
|
LastAgentJobHistoryInfo | Returns information on the last Synchronization Agent job that was run. (繼承自 PullSubscription。) |
|
Load | Loads the properties of an existing object from the server. (繼承自 ReplicationObject。) |
|
LoadProperties | Loads the properties of an existing object from the server. (繼承自 ReplicationObject。) |
|
MemberwiseClone | (繼承自 Object。) |
|
Refresh | Reloads the properties of the object. (繼承自 ReplicationObject。) |
|
Reinitialize | Marks the pull subscription for reinitialization. |
|
Remove | Removes the pull subscription. (繼承自 PullSubscription。) |
|
Script | Returns a Transact-SQL script to create or delete the pull subscription based on the current property setting of the PullSubscription object. (繼承自 PullSubscription。) |
|
StopSynchronizationJob | Attempts to stop a running Distribution Agent job that is currently synchronizing the subscription. (覆寫 PullSubscription. . :: . .StopSynchronizationJob() () () ()。) |
|
SynchronizeWithJob | Starts the agent job to synchronize the subscription. (覆寫 PullSubscription. . :: . .SynchronizeWithJob() () () ()。) |
|
ToString | (繼承自 Object。) |
上層
備註
For a pull subscription, the Distribution Agent runs at the Subscriber.
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.
範例
// Define the Publisher, publication, and databases.
string publicationName = "AdvWorksProductTran";
string publisherName = publisherInstance;
string subscriberName = subscriberInstance;
string subscriptionDbName = "AdventureWorks2008R2Replica";
string publicationDbName = "AdventureWorks2008R2";
//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 = "AdventureWorks2008R2Replica"
Dim publicationDbName As String = "AdventureWorks2008R2"
'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
執行緒安全性
這個型別的任何公用 static (在 Visual Basic 中為 Shared) 成員都是執行緒安全的。並不是所有的執行個體成員都保證可以用於所有的執行緒。