TransPublication クラス

[アーティクル]
02/01/2013

トランザクションパブリケーションを表します。

継承階層

System.Object
  Microsoft.SqlServer.Replication.ReplicationObject
    Microsoft.SqlServer.Replication.Publication
      Microsoft.SqlServer.Replication.TransPublication

名前空間: Microsoft.SqlServer.Replication
アセンブリ: Microsoft.SqlServer.Rmo (Microsoft.SqlServer.Rmo.dll)

構文

'宣言
Public NotInheritable Class TransPublication _
    Inherits Publication
'使用
Dim instance As TransPublication

public sealed class TransPublication : Publication

public ref class TransPublication sealed : public Publication

[<SealedAttribute>]
type TransPublication =  
    class 
        inherit Publication 
    end

public final class TransPublication extends Publication

TransPublication 型は、以下のメンバーを公開しています。

コンストラクター

	名前	説明
	TransPublication()	TransPublication クラスの新しいインスタンスを作成します。
	TransPublication(String, String, ServerConnection)	必須プロパティを使用して TransPublication クラスの新しいインスタンスを作成します。
	TransPublication(String, String, ServerConnection, Boolean)	必須プロパティを使用して TransPublication クラスの新しいインスタンスを作成し、パブリケーションのスナップショットエージェントジョブが作成されるかどうかを示します。

先頭に戻る

プロパティ

	名前	説明
	AltSnapshotFolder	パブリケーションのスナップショットファイルの代替場所を取得します。値の設定も可能です。 (Publication から継承されています。)
	Attributes	パブリケーション属性を取得します。値の設定も可能です。 (Publication から継承されています。)
	CachePropertyChanges	レプリケーションプロパティに加えられた変更をキャッシュするか、またはすぐに適用するかを取得します。値の設定も可能です。 (ReplicationObject から継承されています。)
	CompatibilityLevel	サブスクライバーで実行されている、参照対象パブリケーションでサポート可能な Microsoft SQL Server の最も古いバージョンを取得します。値の設定も可能です。 (Publication から継承されています。)
	ConflictPolicy	更新サブスクリプションをサポートするパブリケーションの競合ポリシーを取得します。値の設定も可能です。
	ConflictRetention	競合するデータ行が競合テーブルに保持される日数を取得します。値の設定も可能です。 (Publication から継承されています。)
	ConnectionContext	Microsoft SQL Server のインスタンスへの接続を取得します。値の設定も可能です。 (ReplicationObject から継承されています。)
	ContinueOnConflict	競合の検出後にディストリビューションエージェントで変更の処理を続行するかどうかを示します。
	CreateSnapshotAgentByDefault	パブリケーションが作成されるときにスナップショットエージェントジョブが自動的に追加されるかどうかを取得します。値の設定も可能です。 (Publication から継承されています。)
	DatabaseName	パブリケーションデータベースの名前を取得します。値の設定も可能です。 (Publication から継承されています。)
	Description	パブリケーションの説明テキストを取得します。値の設定も可能です。 (Publication から継承されています。)
	FtpAddress	ファイル転送プロトコル (FTP) を介してサブスクリプションを初期化できるパブリケーションの、FTP サーバーコンピューターのアドレスを取得します。値の設定も可能です。 (Publication から継承されています。)
	FtpLogin	ファイル転送プロトコル (FTP) を介してサブスクリプションを初期化できるパブリケーションの、FTP サーバーへの接続に使用するログインを取得します。値の設定も可能です。 (Publication から継承されています。)
	FtpPassword	ファイル転送プロトコル (FTP) を介してサブスクリプションを初期化できるパブリケーションの、FTP サーバーへの接続に使用するログインのパスワードを設定します。 (Publication から継承されています。)
	FtpPort	ファイル転送プロトコル (FTP) を介してサブスクリプションを初期化できるパブリケーションの、FTP サーバーコンピューターのポートを取得します。値の設定も可能です。 (Publication から継承されています。)
	FtpSubdirectory	ファイル転送プロトコル (FTP) を介してサブスクリプションを初期化できるパブリケーションの、FTP サーバーコンピューター上のサブディレクトリを取得します。値の設定も可能です。 (Publication から継承されています。)
	HasSubscription	パブリケーションに 1 つ以上のサブスクリプションがあるかどうかを取得します。 (Publication から継承されています。)
	IsExistingObject	サーバーにオブジェクトが存在するかどうかを取得します。 (ReplicationObject から継承されています。)
	Name	パブリケーションの名前を取得します。値の設定も可能です。 (Publication から継承されています。)
	PeerConflictDetectionEnabled	SetPeerConflictDetection を使用してピアツーピア競合検出が有効化されたかどうかを取得します。
	PeerOriginatorID	ピアツーピアトポロジ内のノードの ID を取得します。PeerConflictDetectionEnabled が true に設定されている場合、競合検出にこの ID が使用されます。
	PostSnapshotScript	初期スナップショットをサブスクライバーに適用した後で実行される Transact-SQL スクリプトファイルの名前と完全なパスを取得します。値の設定も可能です。 (Publication から継承されています。)
	PreSnapshotScript	初期スナップショットをサブスクライバーに適用する前に実行される Transact-SQL スクリプトファイルの名前と完全なパスを取得します。値の設定も可能です。 (Publication から継承されています。)
	PubId	パブリケーションを一意に識別する値を取得します。 (Publication から継承されています。)
	PublisherName	SQL Server 以外のパブリッシャーの名前を取得します。値の設定も可能です。
	QueueType	キュー更新サブスクリプションを許可するパブリケーションに使用するキューの種類を取得します。値の設定も可能です。
	ReplicateDdl	データ定義言語 (DDL) の変更をレプリケートするかどうかを決定する DDL レプリケーションオプションを取得します。値の設定も可能です。 (Publication から継承されています。)
	RetentionPeriod	サブスクリプションがパブリケーションと同期されていない場合に、サブスクリプションの有効期限が切れるまでの時間を取得します。値の設定も可能です。 (Publication から継承されています。)
	SecureFtpPassword	ファイル転送プロトコル (FTP) を介してサブスクリプションを初期化できるパブリケーションの、FTP サーバーへの接続に使用するログインのパスワードを SecureString オブジェクトとして設定します。 (Publication から継承されています。)
	SnapshotAgentExists	このパブリケーションの初期スナップショットを生成するための SQL Server エージェントジョブが存在するかどうかを取得します。 (Publication から継承されています。)
	SnapshotAvailable	このパブリケーションのスナップショットファイルが使用できるかどうかを取得します。
	SnapshotGenerationAgentProcessSecurity	スナップショットエージェントジョブを実行する Windows アカウントを設定するオブジェクトを取得します。 (Publication から継承されています。)
	SnapshotGenerationAgentPublisherSecurity	パブリッシャーに接続するためにスナップショットエージェントが使用するセキュリティコンテキストを取得します。 (Publication から継承されています。)
	SnapshotJobId	現在のパブリケーションのスナップショットエージェントジョブ ID を取得します。 (Publication から継承されています。)
	SnapshotMethod	初期スナップショットのデータファイル形式を取得します。値の設定も可能です。 (Publication から継承されています。)
	SnapshotSchedule	現在のパブリケーションのスナップショットエージェントのスケジュールを設定するオブジェクトを取得します。 (Publication から継承されています。)
	SqlServerName	このオブジェクトの接続先となる Microsoft SQL Server インスタンスの名前を取得します。 (ReplicationObject から継承されています。)
	Status	パブリケーションの状態を取得します。値の設定も可能です。 (Publication から継承されています。)
	TransArticles	パブリケーション内のアーティクルを表します。
	TransSubscriptions	パブリケーションへのサブスクリプションを表します。
	Type	パブリケーションの種類を取得します。値の設定も可能です。 (Publication から継承されています。)
	UserData	ユーザーが独自のデータをオブジェクトにアタッチすることを許可するオブジェクトプロパティを取得します。値の設定も可能です。 (ReplicationObject から継承されています。)

先頭に戻る

メソッド

	名前	説明
	BrowseSnapshotFolder	特定のサブスクリプションに対してスナップショットファイルが生成された場所の完全なパスを返します。
	CommitPropertyChanges	キャッシュされているすべてのプロパティ変更ステートメントを、Microsoft SQL Server のインスタンスに送信します。 (ReplicationObject から継承されています。)
	CopySnapshot	目的のフォルダーに特定のサブスクリプションの最新のスナップショットファイルをコピーします。
	Create	パブリケーションを作成します。 (Publication から継承されています。)
	CreateSnapshotAgent	パブリケーションの初期スナップショットを生成するために使用される SQL Server エージェントジョブがまだ存在しない場合、このジョブを作成します。 (Publication から継承されています。)
	Decouple	参照先のレプリケーションオブジェクトをサーバーから切断します。 (ReplicationObject から継承されています。)
	EnumArticles	パブリケーション内のアーティクルを返します。 (Publication から継承されています。)
	EnumPublicationAccesses	パブリッシャーに対するアクセス権を持つログインを返します。 (Publication から継承されています。)
	EnumSubscriptions	パブリケーションをサブスクライブするサブスクリプションを返します。 (Publication から継承されています。)
	Equals	(Object から継承されています。)
	GetHashCode	(Object から継承されています。)
	GetType	(Object から継承されています。)
	GrantPublicationAccess	パブリケーションアクセスリスト (PAL) に指定したログインを追加します。 (Publication から継承されています。)
	Load	サーバーから既存のオブジェクトのプロパティを読み込みます。 (ReplicationObject から継承されています。)
	LoadProperties	サーバーから既存のオブジェクトのプロパティを読み込みます。 (ReplicationObject から継承されています。)
	MakePullSubscriptionWellKnown	パブリッシャー側でプルサブスクリプションを登録します。
	PostTracerToken	待機時間を確認する処理を開始するために、パブリッシャーログにトレーサートークンを送信します。
	Refresh	オブジェクトのプロパティを再度読み込みます。 (ReplicationObject から継承されています。)
	RefreshSubscriptions	パブリケーションに対するすべてのサブスクリプションを更新して、新たに追加されたアーティクルを含めます。
	ReinitializeAllSubscriptions()	パブリケーションに対するすべてのサブスクリプションに再初期化のマークを付けます。
	ReinitializeAllSubscriptions(Boolean)	既存のスナップショットを無効にするオプションを指定して、パブリケーションに対するすべてのサブスクリプションに再初期化のマークを付けます。
	Remove()	既存のパブリケーションを削除します。 (Publication から継承されています。)
	Remove(Boolean)	ディストリビューターにアクセスできない場合でも、既存のパブリケーションを削除します。 (Publication から継承されています。)
	RemovePullSubscription	パブリッシャー側のプルサブスクリプションの登録を削除します。
	ReplicateUserDefinedScript	ユーザー定義スクリプトの実行を、指定したパブリケーションのサブスクライバーにレプリケートします。 (Publication から継承されています。)
	RevokePublicationAccess	パブリケーションアクセスリスト (PAL) から指定したログインを削除します。 (Publication から継承されています。)
	Script	スクリプトオプションで指定したとおりにパブリケーションを再作成するために使用できる Transact-SQL スクリプトを生成します。 (Publication から継承されています。)
	SetPeerConflictDetection	ピアツーピアトポロジ内のノードの競合検出を有効または無効にします。
	StartSnapshotGenerationAgentJob	パブリケーションの初期スナップショットを生成するジョブを開始します。 (Publication から継承されています。)
	StopSnapshotGenerationAgentJob	実行中のスナップショットエージェントジョブの停止を試みます。 (Publication から継承されています。)
	ToString	(Object から継承されています。)
	ValidatePublication	すべてのサブスクリプションのインラインパブリケーション検証を呼び出します。
	ValidateSubscriptions	指定されたサブスクリプションのインラインパブリケーション検証を呼び出します。

先頭に戻る

説明

スレッドセーフ

この型の public static (Microsoft Visual Basic では Shared) のすべてのメンバーは、マルチスレッド操作で安全に使用できます。インスタンスメンバーの場合は、スレッドセーフであるとは限りません。

使用例

この例では、トランザクションパブリケーションを作成します。

          // Set the Publisher, publication database, and publication names.
            string publicationName = "AdvWorksProductTran";
            string publicationDbName = "AdventureWorks2012";
            string publisherName = publisherInstance;

            ReplicationDatabase publicationDb;
            TransPublication publication;

            // Create a connection to the Publisher using Windows Authentication.
            ServerConnection conn;
            conn = new ServerConnection(publisherName);


            try
            {
                // Connect to the Publisher.
                conn.Connect();

                // Enable the AdventureWorks2012 database for transactional publishing.
                publicationDb = new ReplicationDatabase(publicationDbName, conn);

                // If the database exists and is not already enabled, 
                // enable it for transactional publishing.
                if (publicationDb.LoadProperties())
                {
                    if (!publicationDb.EnabledTransPublishing)
                    {
                        publicationDb.EnabledTransPublishing = true;
                    }

                    // If the Log Reader Agent does not exist, create it.
                    if (!publicationDb.LogReaderAgentExists)
                    {
                        // Specify the Windows account under which the agent job runs.
                        // This account will be used for the local connection to the 
                        // Distributor and all agent connections that use Windows Authentication.
                        publicationDb.LogReaderAgentProcessSecurity.Login = winLogin;
                        publicationDb.LogReaderAgentProcessSecurity.Password = winPassword;

                        // Explicitly set authentication mode for the Publisher connection
                        // to the default value of Windows Authentication.
                        publicationDb.LogReaderAgentPublisherSecurity.WindowsAuthentication = true;

                        // Create the Log Reader Agent job.
                        publicationDb.CreateLogReaderAgent();
                    }
                }
                else
                {
                    throw new ApplicationException(String.Format(
                        "The {0} database does not exist at {1}.",
                        publicationDb, publisherName));
                }

                // Set the required properties for the transactional publication.
                publication = new TransPublication();
                publication.ConnectionContext = conn;
                publication.Name = publicationName;
                publication.DatabaseName = publicationDbName;

                // Specify a transactional publication (the default).
                publication.Type = PublicationType.Transactional;

                // Activate the publication so that we can add subscriptions.
                publication.Status = State.Active;

                // Enable push and pull subscriptions and independent Distribition Agents.
                publication.Attributes |= PublicationAttributes.AllowPull;
                publication.Attributes |= PublicationAttributes.AllowPush;
                publication.Attributes |= PublicationAttributes.IndependentAgent;

                // Specify the Windows account under which the Snapshot Agent job runs.
                // This account will be used for the local connection to the 
                // Distributor and all agent connections that use Windows Authentication.
                publication.SnapshotGenerationAgentProcessSecurity.Login = winLogin;
                publication.SnapshotGenerationAgentProcessSecurity.Password = winPassword;

                // Explicitly set the security mode for the Publisher connection
                // Windows Authentication (the default).
                publication.SnapshotGenerationAgentPublisherSecurity.WindowsAuthentication = true;

                if (!publication.IsExistingObject)
                {
                    // Create the transactional publication.
                    publication.Create();

                    // Create a Snapshot Agent job for the publication.
                    publication.CreateSnapshotAgent();
                }
                else
                {
                    throw new ApplicationException(String.Format(
                        "The {0} publication already exists.", publicationName));
                }
            }

            catch (Exception ex)
            {
                // Implement custom application error handling here.
                throw new ApplicationException(String.Format(
                    "The publication {0} could not be created.", publicationName), ex);
            }
            finally
            {
                conn.Disconnect();
            }

' Set the Publisher, publication database, and publication names.
Dim publicationName As String = "AdvWorksProductTran"
Dim publicationDbName As String = "AdventureWorks2012"
Dim publisherName As String = publisherInstance

Dim publicationDb As ReplicationDatabase
Dim publication As TransPublication

' Create a connection to the Publisher using Windows Authentication.
Dim conn As ServerConnection
conn = New ServerConnection(publisherName)

Try
    ' Connect to the Publisher.
    conn.Connect()

    ' Enable the AdventureWorks2012 database for transactional publishing.
    publicationDb = New ReplicationDatabase(publicationDbName, conn)

    ' If the database exists and is not already enabled, 
    ' enable it for transactional publishing.
    If publicationDb.LoadProperties() Then
        If Not publicationDb.EnabledTransPublishing Then
            publicationDb.EnabledTransPublishing = True
        End If

        ' If the Log Reader Agent does not exist, create it.
        If Not publicationDb.LogReaderAgentExists Then
            ' Specify the Windows account under which the agent job runs.
            ' This account will be used for the local connection to the 
            ' Distributor and all agent connections that use Windows Authentication.
            publicationDb.LogReaderAgentProcessSecurity.Login = winLogin
            publicationDb.LogReaderAgentProcessSecurity.Password = winPassword

            ' Explicitly set authentication mode for the Publisher connection
            ' to the default value of Windows Authentication.
            publicationDb.LogReaderAgentPublisherSecurity.WindowsAuthentication = True

            ' Create the Log Reader Agent job.
            publicationDb.CreateLogReaderAgent()
        End If
    Else
        Throw New ApplicationException(String.Format( _
         "The {0} database does not exist at {1}.", _
         publicationDb, publisherName))
    End If

    ' Set the required properties for the transactional publication.
    publication = New TransPublication()
    publication.ConnectionContext = conn
    publication.Name = publicationName
    publication.DatabaseName = publicationDbName

    ' Specify a transactional publication (the default).
    publication.Type = PublicationType.Transactional

    'Enable push and pull subscriptions and independent Distribition Agents.
    publication.Attributes = _
    publication.Attributes Or PublicationAttributes.AllowPull
    publication.Attributes = _
    publication.Attributes Or PublicationAttributes.AllowPush
    publication.Attributes = _
    publication.Attributes Or PublicationAttributes.IndependentAgent

    ' Activate the publication so that we can add subscriptions.
    publication.Status = State.Active

    ' Specify the Windows account under which the Snapshot Agent job runs.
    ' This account will be used for the local connection to the 
    ' Distributor and all agent connections that use Windows Authentication.
    publication.SnapshotGenerationAgentProcessSecurity.Login = winLogin
    publication.SnapshotGenerationAgentProcessSecurity.Password = winPassword

    ' Explicitly set the security mode for the Publisher connection
    ' Windows Authentication (the default).
    publication.SnapshotGenerationAgentPublisherSecurity.WindowsAuthentication = True

    If Not publication.IsExistingObject Then
        ' Create the transactional publication.
        publication.Create()

        ' Create a Snapshot Agent job for the publication.
        publication.CreateSnapshotAgent()
    Else
        Throw New ApplicationException(String.Format( _
            "The {0} publication already exists.", publicationName))
    End If
Catch ex As Exception
    ' Implement custom application error handling here.
    Throw New ApplicationException(String.Format( _
        "The publication {0} could not be created.", publicationName), ex)
Finally
    conn.Disconnect()
End Try

この例では、トランザクションパブリケーションを削除します。

            // Define the Publisher, publication database, 
            // and publication names.
            string publisherName = publisherInstance;
            string publicationName = "AdvWorksProductTran";
            string publicationDbName = "AdventureWorks2012";

            TransPublication publication;
            ReplicationDatabase publicationDb;

            // Create a connection to the Publisher 
            // using Windows Authentication.
            ServerConnection conn = new ServerConnection(publisherName);

            try
            {
                conn.Connect();

                // Set the required properties for the transactional publication.
                publication = new TransPublication();
                publication.ConnectionContext = conn;
                publication.Name = publicationName;
                publication.DatabaseName = publicationDbName;

                // Delete the publication, if it exists and has no subscriptions.
                if (publication.LoadProperties() && !publication.HasSubscription)
                {
                    publication.Remove();
                }
                else
                {
                    // Do something here if the publication does not exist
                    // or has subscriptions.
                    throw new ApplicationException(String.Format(
                        "The publication {0} could not be deleted. " +
                        "Ensure that the publication exists and that all " +
                        "subscriptions have been deleted.",
                        publicationName, publisherName));
                }

                // If no other transactional publications exists,
                // disable publishing on the database.
                publicationDb = new ReplicationDatabase(publicationDbName, conn);
                if (publicationDb.LoadProperties())
                {
                    if (publicationDb.TransPublications.Count == 0)
                    {
                        publicationDb.EnabledTransPublishing = false;
                    }
                }
                else
                {
                    // Do something here if the database does not exist.
                    throw new ApplicationException(String.Format(
                        "The database {0} does not exist on {1}.",
                        publicationDbName, publisherName));
                }
            }
            catch (Exception ex)
            {
                // Implement application error handling here.
                throw new ApplicationException(String.Format(
                    "The publication {0} could not be deleted.",
                    publicationName), ex);
            }
            finally
            {
                conn.Disconnect();
            }

' Define the Publisher, publication database, 
' and publication names.
Dim publisherName As String = publisherInstance
Dim publicationName As String = "AdvWorksProductTran"
Dim publicationDbName As String = "AdventureWorks2012"

Dim publication As TransPublication
Dim publicationDb As ReplicationDatabase

' Create a connection to the Publisher 
' using Windows Authentication.
Dim conn As ServerConnection = New ServerConnection(publisherName)

Try
    conn.Connect()

    ' Set the required properties for the transactional publication.
    publication = New TransPublication()
    publication.ConnectionContext = conn
    publication.Name = publicationName
    publication.DatabaseName = publicationDbName

    ' Delete the publication, if it exists and has no subscriptions.
    If publication.LoadProperties() And Not publication.HasSubscription Then
        publication.Remove()
    Else
        ' Do something here if the publication does not exist
        ' or has subscriptions.
        Throw New ApplicationException(String.Format( _
         "The publication {0} could not be deleted. " + _
         "Ensure that the publication exists and that all " + _
         "subscriptions have been deleted.", _
         publicationName, publisherName))
    End If

    ' If no other transactional publications exists,
    ' disable publishing on the database.
    publicationDb = New ReplicationDatabase(publicationDbName, conn)
    If publicationDb.LoadProperties() Then
        If publicationDb.TransPublications.Count = 0 Then
            publicationDb.EnabledTransPublishing = False
        End If
    Else
        ' Do something here if the database does not exist.
        Throw New ApplicationException(String.Format( _
         "The database {0} does not exist on {1}.", _
         publicationDbName, publisherName))
    End If
Catch ex As Exception
    ' Implement application error handling here.
    Throw New ApplicationException(String.Format( _
     "The publication {0} could not be deleted.", _
     publicationName), ex)
Finally
    conn.Disconnect()
End Try

スレッドセーフ

この型の public static (Visual Basic では Shared) のメンバーはすべて、スレッドセーフです。インスタンスメンバーの場合は、スレッドセーフであるとは限りません。

次の方法で共有

TransPublication クラス

継承階層

構文

コンストラクター

プロパティ

メソッド

説明

スレッドセーフ

使用例

スレッドセーフ

関連項目

参照

その他の技術情報

その他のリソース

次の方法で共有

TransPublication クラス

継承階層

構文

コンストラクター

プロパティ

メソッド

説明

スレッド セーフ

使用例

スレッド セーフ

関連項目

参照

その他の技術情報

その他のリソース

スレッドセーフ

スレッドセーフ