レプリケーション管理オブジェクトを使用したプログラミング

[アーティクル]
12/15/2008

更新 : 2006 年 7 月 17 日

レプリケーション管理オブジェクト (RMO) は、Microsoft SQL Server のレプリケーション機能をカプセル化するマネージコードアセンブリです。RMO は Microsoft.SqlServer.Replication 名前空間により実装されます。

RMO を使用して、次のようなレプリケーション作業をプログラムから制御できます。

トピック	説明
レプリケーションの構成 (RMO プログラミング)	ここでは、RMO を利用してパブリッシュとディストリビューションを構成する方法と、パブリケーション、アーティクル、サブスクリプションの作成、削除、変更を行う方法について説明します。
サブスクリプションの同期 (RMO プログラミング)	ここでは、サブスクリプションを同期する方法を説明します。
レプリケーショントポロジのメンテナンス (RMO プログラミング)	ここでは、マージパブリケーションにおけるパーティションの管理やサブスクリプションの検証など、レプリケーションのメンテナンス作業の実行方法を説明します。
レプリケーショントポロジの監視 (RMO プログラミング)	ここでは、プログラムからレプリケーショントポロジを監視する方法を説明します。

RMO プログラミングの概要

RMO は SQL Server レプリケーションのすべての機能をプログラミングできるように設計されています。RMO はレプリケーションのすべての新機能をサポートしています。新機能の詳細については、「レプリケーションの機能強化」を参照してください。RMO オブジェクトモデルは、DMO オブジェクトモデルのレプリケーション専用オブジェクトを拡張し、置き換えるものです。RMO は SQL Server 7.0、SQL Server 2000、および SQL Server 2005 と互換性があります。

RMO の名前空間は Microsoft.SqlServer.Replication です。これは Microsoft .NET Framework アセンブリである Microsoft.SqlServer.Rmo.dll により実装されます。同様に Microsoft.SqlServer.Replication 名前空間に属している Microsoft.SqlServer.Replication.dll アセンブリにより、さまざまなレプリケーションエージェント (スナップショットエージェント、ディストリビューションエージェント、マージエージェント) のプログラミングのためのマネージコードインターフェイスが実装されます。そのクラスには RMO からアクセスしてサブスクリプションを同期できます。Microsoft.SqlServer.Replication.BusinessLogicSupport.dll アセンブリにより実装される、Microsoft.SqlServer.Replication.BusinessLogicSupport 名前空間のクラスを使用して、マージレプリケーション用のカスタムビジネスロジックを作成できます。このアセンブリは RMO から独立しています。

RMO に基づくアプリケーションの配置

RMO は、SQL Server Compact Edition を除く SQL Server 2005 のすべてのバージョンに含まれるファイルに依存しています。RMO に基づいてアプリケーションを配置するには、アプリケーションを実行するコンピュータに SQL Server をインストールする必要があります。

RMO の概要

ここでは、Microsoft Visual Studio 2005 を使用して単純な RMO プロジェクトを開始する方法を説明します。

新しい Microsoft Visual C# プロジェクトを作成するには

Visual Studio 2005 を起動します。
[ファイル] メニューの [新規作成] をポイントし、[プロジェクト] をクリックします。[新しいプロジェクト] ダイアログボックスが開きます。
[プロジェクトの種類] ダイアログボックスで [Visual C# プロジェクト] を選択します。[テンプレート] ペインで [Windows アプリケーション] を選択します。
(省略可) [名前] に、新しいアプリケーションの名前を入力します。
[OK] をクリックして、Visual C# Windows テンプレートを読み込みます。
[プロジェクト] メニューの [参照の追加] を選択します。[参照の追加] ダイアログボックスが表示されます。
[.NET] タブの一覧から、次のアセンブリを選択して [OK] をクリックします。
- Microsoft.SqlServer.Replication .NET プログラミングインターフェイス
- Microsoft.SqlServer.ConnectionInfo
- レプリケーションエージェントライブラリ
メモ :

複数のファイルを選択するには、Ctrl キーを押しながら各ファイルをクリックします。
(省略可) 手順 6. を繰り返します。[参照] タブをクリックして C:\Program Files\Microsoft SQL Server\90\COM に移動し、Microsoft.SqlServer.Replication.BusinessLogicSupport.dll を選択した後、[OK] をクリックします。
[表示] メニューの [コード] をクリックします。

メモ :
複数のファイルを選択するには、Ctrl キーを押しながら各ファイルをクリックします。

コード内で、名前空間のステートメントの前に次の using ステートメントを入力し、RMO 名前空間内の型を修飾します。

// These namespaces are required.
using Microsoft.SqlServer.Replication;
using Microsoft.SqlServer.Management.Common;
// This namespace is only used when creating custom business
// logic for merge replication.
using Microsoft.SqlServer.Replication.BusinessLogicSupport;

新しい Microsoft Visual Basic .NET プロジェクトを作成するには

Visual Studio 2005 を起動します。
[ファイル] メニューの [新しいプロジェクト] を選択します。[新しいプロジェクト] ダイアログボックスが開きます。
[プロジェクトの種類] ペインで [Visual Basic] を選択します。[テンプレート] ペインで [Windows アプリケーション] を選択します。
(省略可) [名前] ボックスに、新しいアプリケーションの名前を入力します。
[OK] をクリックして、Visual Basic Windows テンプレートを読み込みます。
[プロジェクト] メニューの [参照の追加] を選択します。[参照の追加] ダイアログボックスが表示されます。
[.NET] タブの一覧から、次のアセンブリを選択して [OK] をクリックします。
- Microsoft.SqlServer.Replication .NET プログラミングインターフェイス
- Microsoft.SqlServer.ConnectionInfo
- レプリケーションエージェントライブラリ
メモ :

複数のファイルを選択するには、Ctrl キーを押しながら各ファイルをクリックします。
(省略可) 手順 6. を繰り返します。[参照] タブをクリックして C:\Program Files\Microsoft SQL Server\90\COM に移動し、Microsoft.SqlServer.Replication.BusinessLogicSupport.dll を選択した後、[OK] をクリックします。
[表示] メニューの [コード] をクリックします。

メモ :
複数のファイルを選択するには、Ctrl キーを押しながら各ファイルをクリックします。

コード内で、すべての宣言の前に次の Imports ステートメントを入力し、RMO 名前空間内の型を修飾します。

' These namespaces are required.
Imports Microsoft.SqlServer.Replication
Imports Microsoft.SqlServer.Management.Common
' This namespace is only used when creating custom business
' logic for merge replication.
Imports Microsoft.SqlServer.Replication.BusinessLogicSupport

レプリケーションサーバーへの接続

RMO プログラミングオブジェクトでは、ServerConnection クラスのインスタンスを使用して SQL Server インスタンスへの接続を作成する必要があります。サーバーへの接続は、RMO プログラミングオブジェクトとは別に作成されます。接続はインスタンスの作成中に RMO オブジェクトに渡されるか、オブジェクトの ConnectionContext プロパティに割り当てることで渡されます。このように、RMO プログラミングオブジェクトと接続オブジェクトインスタンスを別々に作成し、管理することができ、1 つの接続オブジェクトを複数の RMO プログラミングオブジェクトで再利用できます。レプリケーションサーバーへの接続には、次の規則が適用されます。

指定された ServerConnection オブジェクトに、すべての接続プロパティを定義します。
各 SQL Server インスタンスに対する接続に、それぞれ独自の ServerConnection オブジェクトが含まれている必要があります。
ServerConnection オブジェクトが、サーバー上で作成またはアクセスされる RMO プログラミングオブジェクトの ConnectionContext プロパティに割り当てられます。
Connect メソッドにより、サーバーへの接続が開かれます。接続を使用してサーバー上の RMO プログラミングオブジェクトにアクセスするメソッドを呼び出す前に、このメソッドを呼び出しておく必要があります。
RMO でも SMO (SQL Server 管理オブジェクト) でも、SQL Server への接続には ServerConnection クラスを使用するため、RMO オブジェクトと SMO オブジェクトの両方で同じ接続を使用できます。詳細については、「SQL Server のインスタンスへの接続」を参照してください。
接続を作成し、サーバーに正常にログオンするための認証情報はすべて ServerConnection オブジェクトで指定されます。
既定は Windows 認証です。SQL Server 認証を使用するには、LoginSecure を false に設定し、Login および Password に有効な SQL Server ログインおよびパスワードを設定する必要があります。セキュリティ資格情報は常にセキュリティ保護された状態で保存し、処理する必要があります。可能な限り、実行時に入力するようにします。
マルチスレッド化されたアプリケーションの場合、各スレッドで別々の ServerConnection オブジェクトを使用します。

RMO オブジェクトで使用された、アクティブなサーバー接続を閉じるには、ServerConnection オブジェクトに対して Disconnect メソッドを呼び出します。

RMO プロパティの設定

RMO プログラミングオブジェクトのプロパティは、サーバー上のこれらのレプリケーションオブジェクトのプロパティを表します。サーバー上に新しいレプリケーションオブジェクトを作成するとき、RMO プロパティを使用してこれらのオブジェクトを定義します。既存のオブジェクトの場合、RMO プロパティは既存のオブジェクトのプロパティを表しますが、変更できるのは書き込み可能または設定可能なプロパティのみです。プロパティは、新しいオブジェクトまたは既存のオブジェクトに設定できます。

新しいレプリケーションオブジェクトのプロパティの設定

サーバーに新しいレプリケーションオブジェクトを作成する際、必要なプロパティをすべて指定した後で、オブジェクトの Create メソッドを呼び出す必要があります。新しいレプリケーションオブジェクトのプロパティの設定の詳細については、「パブリッシングおよびディストリビューションを構成する方法 (RMO プログラミング)」を参照してください。

既存のレプリケーションオブジェクトのプロパティの設定

サーバー上に存在するレプリケーションオブジェクトの場合、RMO ではオブジェクトの種類に応じて、プロパティの一部またはすべてを変更することがサポートされます。書き込み可能または設定可能なプロパティのみを変更できます。プロパティを変更するには、Load または LoadProperties メソッドを呼び出して、サーバーから現在のプロパティを取得しておく必要があります。これらのメソッドを呼び出すことは、既存のオブジェクトが変更されることを表します。

既定では、オブジェクトのプロパティを変更するときに、使用される ServerConnection の実行モードに基づいてこれらの変更がサーバーにコミットされます。オブジェクトのプロパティを取得または変更する前に、IsExistingObject メソッドを使用して、そのオブジェクトがサーバー上に存在するかどうかを確認できます。レプリケーションオブジェクトのプロパティ変更の詳細については、「パブリッシャとディストリビュータのプロパティを表示および変更する方法 (RMO プログラミング)」を参照してください。

メモ :
複数の RMO クライアントまたは複数の RMO プログラミングオブジェクトインスタンスが、サーバー上の同じレプリケーションオブジェクトにアクセスする場合、RMO オブジェクトの Refresh メソッドを呼び出して、サーバー上のオブジェクトの現在の状態に基づいてプロパティを更新できます。

プロパティの変更のキャッシュ

SqlExecutionModes プロパティが CaptureSql に設定されている場合、RMO により生成されるすべての Transact-SQL ステートメントがキャプチャされ、いずれかの実行メソッドを使用して 1 つのバッチで手動で実行できます。RMO を使用するとプロパティの変更をキャッシュでき、オブジェクトの CommitPropertyChanges メソッドを使用して 1 つのバッチでまとめてコミットできます。プロパティの変更をキャッシュするには、オブジェクトの CachePropertyChanges プロパティを true に設定する必要があります。RMO におけるプロパティの変更がキャッシュされる場合でも、変更がいつサーバーに送られるのかは ServerConnection オブジェクトによって制御されます。レプリケーションオブジェクトのプロパティのキャッシュの詳細については、「パブリッシャとディストリビュータのプロパティを表示および変更する方法 (RMO プログラミング)」を参照してください。

重要 :
ServerConnection クラスでは、プロパティを設定するときに明示的なトランザクションの宣言がサポートされますが、そのようなトランザクションでは内部的なレプリケーショントランザクションに干渉する場合があるため、予期しない結果が生じる可能性があります。RMO では使用しないでください。

ServerConnection クラスでは、プロパティを設定するときに明示的なトランザクションの宣言がサポートされますが、そのようなトランザクションでは内部的なレプリケーショントランザクションに干渉する場合があるため、予期しない結果が生じる可能性があります。RMO では使用しないでください。

例

この例では、プロパティ変更のキャッシュを示します。トランザクションパブリケーションの属性に加えられた変更は、明示的にサーバーに送られるまでキャッシュされます。

// Define the server, database, and publication names
string publisherName = publisherInstance;
string publicationName = "AdvWorksProductTran";
string publicationDbName = "AdventureWorks";

TransPublication publication;

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

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

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

    // Explicitly enable caching of property changes on this object.
    publication.CachePropertyChanges = true;

    // If we can't get the properties for this publication, 
    // throw an application exception.
    if (publication.LoadProperties())
    {
        // Enable support for push subscriptions and disable support 
        // for pull subscriptions.
        if ((publication.Attributes & PublicationAttributes.AllowPull) != 0)
        {
            publication.Attributes ^= PublicationAttributes.AllowPull;
        }
        if ((publication.Attributes & PublicationAttributes.AllowPush) == 0)
        {
            publication.Attributes |= PublicationAttributes.AllowPush;
        }

        // Send changes to the server.
        publication.CommitPropertyChanges();
    }
    else
    {
        throw new ApplicationException(String.Format(
            "Settings could not be retrieved for the publication. " +
            "Ensure that the publication {0} exists on {1}.",
            publicationName, publisherName));
    }
}
catch (Exception ex)
{
    // Do error handling here.
    throw new ApplicationException(
        "The publication property could not be changed.", ex);
}
finally
{
    conn.Disconnect();
}

参照

概念

システムストアドプロシージャを使用したレプリケーションのプログラミング
 レプリケーションのプログラミング計画

ヘルプおよび情報

SQL Server 2005 の参考資料の入手

変更履歴

リリース	履歴
2006 年 7 月 17 日	新しい内容 : RMO アプリケーションの配置に関する説明を追加しました。
2006 年 4 月 14 日	変更内容 : SQL Server 2005 Service Pack 1 から、MergeSynchronizationAgent オブジェクトを使用するアプリケーションでは、シングルスレッドアパートメントのスレッドモデルを使用する必要がなくなりました。

次の方法で共有

レプリケーション管理オブジェクトを使用したプログラミング

RMO プログラミングの概要

RMO に基づくアプリケーションの配置

RMO の概要

レプリケーションサーバーへの接続

RMO プロパティの設定

新しいレプリケーションオブジェクトのプロパティの設定

既存のレプリケーションオブジェクトのプロパティの設定

プロパティの変更のキャッシュ

例

参照

概念

ヘルプおよび情報

変更履歴

その他のリソース

次の方法で共有

レプリケーション管理オブジェクトを使用したプログラミング

RMO プログラミングの概要

RMO に基づくアプリケーションの配置

RMO の概要

レプリケーション サーバーへの接続

RMO プロパティの設定

新しいレプリケーション オブジェクトのプロパティの設定

既存のレプリケーション オブジェクトのプロパティの設定

プロパティの変更のキャッシュ

例

参照

概念

ヘルプおよび情報

変更履歴

その他のリソース

レプリケーションサーバーへの接続

新しいレプリケーションオブジェクトのプロパティの設定

既存のレプリケーションオブジェクトのプロパティの設定