ReplicationServer クラス

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

レプリケーションに関係する Microsoft SQL Server のインスタンスを表します。このインスタンスの役割は、ディストリビューター、パブリッシャー、サブスクライバー、またはそれらの任意の組み合わせのいずれかになります。

継承階層

System.Object
Microsoft.SqlServer.Replication.ReplicationObject
Microsoft.SqlServer.Replication.ReplicationServer

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

構文

'宣言
<GuidAttribute("0D6A9404-D9B7-4972-82A4-D5663ECF709F")> _
Public NotInheritable Class ReplicationServer _
    Inherits ReplicationObject
'使用
Dim instance As ReplicationServer

[GuidAttribute("0D6A9404-D9B7-4972-82A4-D5663ECF709F")]
public sealed class ReplicationServer : ReplicationObject

[GuidAttribute(L"0D6A9404-D9B7-4972-82A4-D5663ECF709F")]
public ref class ReplicationServer sealed : public ReplicationObject

[<SealedAttribute>]
[<GuidAttribute("0D6A9404-D9B7-4972-82A4-D5663ECF709F")>]
type ReplicationServer =  
    class 
        inherit ReplicationObject 
    end

public final class ReplicationServer extends ReplicationObject

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

コンストラクター

	名前	説明
	ReplicationServer()	ReplicationServer クラスの新しいインスタンスを初期化します。
	ReplicationServer(ServerConnection)	Microsoft SQL Server のインスタンスとの接続を確立する際に使用される特定の接続コンテキストを使って、ReplicationServer クラスの新しいインスタンスを初期化します。

先頭に戻る

プロパティ

	名前	説明
	AgentCheckupInterval	ディストリビューションエージェントが照合を行う間隔を取得します。値の設定も可能です。
	CachePropertyChanges	レプリケーションプロパティに加えられた変更をキャッシュするか、またはすぐに適用するかを取得します。値の設定も可能です。 (ReplicationObject から継承されています。)
	ConnectionContext	Microsoft SQL Server のインスタンスへの接続を取得します。値の設定も可能です。 (ReplicationObject から継承されています。)
	DistributionDatabase	現在接続している SQL Server のインスタンスのディストリビューションデータベースの名前を取得します。
	DistributionDatabases	レプリケーションサーバーで定義されたディストリビューションデータベースを取得します。
	DistributionPublishers	現在接続している Microsoft SQL Server のインスタンスをディストリビューターとして使用しているパブリッシャーを取得します。
	DistributionServer	現在接続している SQL Server のインスタンスのディストリビューターの名前を取得します。値の設定も可能です。
	DistributorAvailable	現在接続している Microsoft SQL Server のインスタンスのディストリビューターが接続されており使用可能な状態であるかどうかを取得します。
	DistributorInstalled	現在接続している SQL Server のインスタンスが、ローカルディストリビューターとリモートディストリビューターのどちらを使用しているかを取得します。
	HasRemotePublisher	現在接続している Microsoft SQL Server のインスタンスがリモートパブリッシャーを使用したディストリビューターであるかどうかを取得します。
	IsDistributor	現在接続している SQL Server のインスタンスがディストリビューターかどうかを取得します。
	IsExistingObject	サーバーにオブジェクトが存在するかどうかを取得します。 (ReplicationObject から継承されています。)
	IsPublisher	現在接続している Microsoft SQL Server のインスタンスがパブリッシャーかどうかを取得します。
	Name	Microsoft SQL Server のインスタンスの名前を取得します。
	RegisteredSubscribers	パブリッシャーに登録されているサブスクライバーを取得します。
	ReplicationDatabases	接続している Microsoft SQL Server のインスタンスでレプリケーションが有効になっているデータベースを取得します。
	SqlServerName	このオブジェクトの接続先となる Microsoft SQL Server インスタンスの名前を取得します。 (ReplicationObject から継承されています。)
	UserData	ユーザーが独自のデータをオブジェクトにアタッチすることを許可するオブジェクトプロパティを取得します。値の設定も可能です。 (ReplicationObject から継承されています。)
	WorkingDirectory	パブリッシャーで使用される作業ディレクトリを取得します。

先頭に戻る

メソッド

	名前	説明
	AttachSubscriptionDatabase	サブスクライバー側でコピーされたサブスクリプションデータベースをアタッチします。
	ChangeDistributorPassword(SecureString)	ディストリビューターのパスワードを変更します。新しいパスワードは SecureString オブジェクトとして指定されます。
	ChangeDistributorPassword(String)	ディストリビューターのパスワードを変更します。
	ChangeReplicationServerPasswords(ReplicationSecurityMode, String, SecureString)	SecureString オブジェクトを使用して、レプリケーションサーバーで保持されるログインのパスワードの格納されたすべてのインスタンスを変更します。
	ChangeReplicationServerPasswords(ReplicationSecurityMode, String, String)	レプリケーションサーバーで保持されるログインのパスワードの格納されたすべてのインスタンスを変更します。
	CommitPropertyChanges	キャッシュされているすべてのプロパティ変更ステートメントを、Microsoft SQL Server のインスタンスに送信します。 (ReplicationObject から継承されています。)
	CopySubscriptionDatabase	既存のプルサブスクリプションデータベースをコピーします。
	Decouple	参照先のレプリケーションオブジェクトをサーバーから切断します。 (ReplicationObject から継承されています。)
	EnumAgentProfiles	サーバーでサポートされるレプリケーションエージェントのパフォーマンスプロファイルを返します。
	EnumBusinessLogicHandlers	サーバーで登録されたビジネスロジックハンドラーを返します。
	EnumCurrentPrincipals	データベースミラーリングに参加しているパブリッシュされたすべてのデータベースの情報を返します。
	EnumCustomResolvers	接続している SQL Server のインスタンスに登録されているすべてのカスタム競合回避モジュールを返します。
	EnumDistributionDatabases	現在接続している Microsoft SQL Server のインスタンスがディストリビューターである場合に、インストールされているディストリビューションデータベースを返します。
	EnumDistributionPublishers	現在接続している Microsoft SQL Server のインスタンスをディストリビューターとして使用しているパブリッシャーを返します。
	EnumHeterogeneousColumns	SQL Server 以外のパブリッシャーのテーブルの列を返します。
	EnumHeterogeneousTables	SQL Server 以外のパブリッシャーで使用可能なテーブルを返します。
	EnumLightPublications	インフラストラクチャです。ライトパブリケーションを返します。
	EnumRegisteredSubscribers	パブリッシャーに登録されるサブスクライバーを返します。
	EnumReplicationDatabases	レプリケーションが有効になっているデータベースを返します。
	EnumSubscriberSubscriptions	サブスクライバーサーバーでのサブスクリプションを返します。
	Equals	(Object から継承されています。)
	GetCurrentPrincipal	指定したパブリケーションデータベースの現在のデータベースミラーリングプリンシパルを返します。
	GetHashCode	(Object から継承されています。)
	GetOriginalPublisher	データベースミラーリングセッションに参加している、パブリッシュされたデータベースの発行元パブリッシャーの名前を返します。
	GetType	(Object から継承されています。)
	InstallDistributor(SecureString, DistributionDatabase)	現在接続されている Microsoft SQL Server のインスタンスに、ディストリビューターをインストールします。ここでは、パスワードは SecureString オブジェクトを使用して指定されます。
	InstallDistributor(String, DistributionDatabase)	現在接続されている Microsoft SQL Server のインスタンスにディストリビューターをインストールします。
	InstallDistributor(String, SecureString)	リモートディストリビューターを登録します。ここでは、パスワードは SecureString オブジェクトを使用して指定されます。
	InstallDistributor(String, String)	リモートディストリビューターを登録します。
	Load	サーバーから既存のオブジェクトのプロパティを読み込みます。 (ReplicationObject から継承されています。)
	LoadProperties	サーバーから既存のオブジェクトのプロパティを読み込みます。 (ReplicationObject から継承されています。)
	Refresh	オブジェクトのプロパティを再度読み込みます。 (ReplicationObject から継承されています。)
	Script	サーバーでのレプリケーションのインストールまたはアンインストールに使用する Transact-SQL スクリプトを返します。
	ScriptInstallDistributor	ディストリビューターをインストールする Transact-SQL スクリプトを返します。
	ScriptUninstallDistributor	ディストリビューターのアンインストールに使用できる Transact-SQL スクリプトを返します。
	ToString	(Object から継承されています。)
	UninstallDistributor	現在接続されている SQL Server のインスタンスのレプリケーションパブリッシングとディストリビューションをアンインストールします。

先頭に戻る

説明

スレッドセーフ

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

使用例

この例では、ReplicationServer オブジェクトを使用してパブリッシングを有効化します。

         // Set the server and database names
            string distributionDbName = "distribution";
            string publisherName = publisherInstance;
            string publicationDbName = "AdventureWorks2012";

            DistributionDatabase distributionDb;
            ReplicationServer distributor;
            DistributionPublisher publisher;
            ReplicationDatabase publicationDb;

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

            try
            {
                // Connect to the server acting as the Distributor 
                // and local Publisher.
                conn.Connect();

                // Define the distribution database at the Distributor,
                // but do not create it now.
                distributionDb = new DistributionDatabase(distributionDbName, conn);
                distributionDb.MaxDistributionRetention = 96;
                distributionDb.HistoryRetention = 120;

                // Set the Distributor properties and install the Distributor.
                // This also creates the specified distribution database.
                distributor = new ReplicationServer(conn);
                distributor.InstallDistributor((string)null, distributionDb);

                // Set the Publisher properties and install the Publisher.
                publisher = new DistributionPublisher(publisherName, conn);
                publisher.DistributionDatabase = distributionDb.Name;
                publisher.WorkingDirectory = @"\\" + publisherName + @"\repldata";
                publisher.PublisherSecurity.WindowsAuthentication = true;
                publisher.Create();

                // Enable AdventureWorks2012 as a publication database.
                publicationDb = new ReplicationDatabase(publicationDbName, conn);

                publicationDb.EnabledTransPublishing = true;
                publicationDb.EnabledMergePublishing = true;
            }
            catch (Exception ex)
            {
                // Implement appropriate error handling here.
                throw new ApplicationException("An error occured when installing distribution and publishing.", ex);
            }
            finally
            {
                conn.Disconnect();
            }

' Set the server and database names
Dim distributionDbName As String = "distribution"
Dim publisherName As String = publisherInstance
Dim publicationDbName As String = "AdventureWorks2012"

Dim distributionDb As DistributionDatabase
Dim distributor As ReplicationServer
Dim publisher As DistributionPublisher
Dim publicationDb As ReplicationDatabase

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

Try
    ' Connect to the server acting as the Distributor 
    ' and local Publisher.
    conn.Connect()

    ' Define the distribution database at the Distributor,
    ' but do not create it now.
    distributionDb = New DistributionDatabase(distributionDbName, conn)
    distributionDb.MaxDistributionRetention = 96
    distributionDb.HistoryRetention = 120

    ' Set the Distributor properties and install the Distributor.
    ' This also creates the specified distribution database.
    distributor = New ReplicationServer(conn)
    distributor.InstallDistributor((CType(Nothing, String)), distributionDb)

    ' Set the Publisher properties and install the Publisher.
    publisher = New DistributionPublisher(publisherName, conn)
    publisher.DistributionDatabase = distributionDb.Name
    publisher.WorkingDirectory = "\\" + publisherName + "\repldata"
    publisher.PublisherSecurity.WindowsAuthentication = True
    publisher.Create()

    ' Enable AdventureWorks2012 as a publication database.
    publicationDb = New ReplicationDatabase(publicationDbName, conn)

    publicationDb.EnabledTransPublishing = True
    publicationDb.EnabledMergePublishing = True

Catch ex As Exception
    ' Implement appropriate error handling here.
    Throw New ApplicationException("An error occured when installing distribution and publishing.", ex)

Finally
    conn.Disconnect()

End Try

この例では、ReplicationServer オブジェクトを使用してディストリビューターのプロパティを変更します。

            // Set the Distributor and distribution database names.
            string distributionDbName = "distribution";
            string distributorName = publisherInstance;

            ReplicationServer distributor;
            DistributionDatabase distributionDb;

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

            try
            {
                // Open the connection. 
                conn.Connect();

                distributor = new ReplicationServer(conn);

                // Load Distributor properties, if it is installed.
                if (distributor.LoadProperties())
                {
                    // Password supplied at runtime.
                    distributor.ChangeDistributorPassword(password);
                    distributor.AgentCheckupInterval = 5;

                    // Save changes to the Distributor properties.
                    distributor.CommitPropertyChanges();
                }
                else
                {
                    throw new ApplicationException(
                        String.Format("{0} is not a Distributor.", publisherInstance));
                }

                // Create an object for the distribution database 
                // using the open Distributor connection.
                distributionDb = new DistributionDatabase(distributionDbName, conn);

                // Change distribution database properties.
                if (distributionDb.LoadProperties())
                {
                    // Change maximum retention period to 48 hours and history retention 
                    // period to 24 hours.
                    distributionDb.MaxDistributionRetention = 48;
                    distributionDb.HistoryRetention = 24;

                    // Save changes to the distribution database properties.
                    distributionDb.CommitPropertyChanges();
                }
                else
                {
                    // Do something here if the distribution database does not exist.
                }
            }
            catch (Exception ex)
            {
                // Implement the appropriate error handling here. 
                throw new ApplicationException("An error occured when changing Distributor " +
                    " or distribution database properties.", ex);
            }
            finally
            {
                conn.Disconnect();
            }

' Set the Distributor and distribution database names.
Dim distributionDbName As String = "distribution"
Dim distributorName As String = publisherInstance

Dim distributor As ReplicationServer
Dim distributionDb As DistributionDatabase

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

Try
    ' Open the connection. 
    conn.Connect()

    distributor = New ReplicationServer(conn)

    ' Load Distributor properties, if it is installed.
    If distributor.LoadProperties() Then
        ' Password supplied at runtime.
        distributor.ChangeDistributorPassword(password)
        distributor.AgentCheckupInterval = 5

        ' Save changes to the Distributor properties.
        distributor.CommitPropertyChanges()
    Else
        Throw New ApplicationException( _
            String.Format("{0} is not a Distributor.", publisherInstance))
    End If

    ' Create an object for the distribution database 
    ' using the open Distributor connection.
    distributionDb = New DistributionDatabase(distributionDbName, conn)

    ' Change distribution database properties.
    If distributionDb.LoadProperties() Then
        ' Change maximum retention period to 48 hours and history retention 
        ' period to 24 hours.
        distributionDb.MaxDistributionRetention = 48
        distributionDb.HistoryRetention = 24

        ' Save changes to the distribution database properties.
        distributionDb.CommitPropertyChanges()
    Else
        ' Do something here if the distribution database does not exist.
    End If
Catch ex As Exception
    ' Implement the appropriate error handling here. 
    Throw New ApplicationException("An error occured when changing Distributor " + _
        " or distribution database properties.", ex)
Finally
    conn.Disconnect()
End Try

この例では、ReplicationServer オブジェクトを使用してパブリッシングを無効化します。

            // Set the Distributor and publication database names.
            // Publisher and Distributor are on the same server instance.
            string publisherName = publisherInstance;
            string distributorName = publisherInstance;
            string distributionDbName = "distribution";
            string publicationDbName = "AdventureWorks2012";

            // Create connections to the Publisher and Distributor
            // using Windows Authentication.
            ServerConnection publisherConn = new ServerConnection(publisherName);
            ServerConnection distributorConn = new ServerConnection(distributorName);

            // Create the objects we need.
            ReplicationServer distributor =
                new ReplicationServer(distributorConn);
            DistributionPublisher publisher;
            DistributionDatabase distributionDb =
                new DistributionDatabase(distributionDbName, distributorConn);
            ReplicationDatabase publicationDb;
            publicationDb = new ReplicationDatabase(publicationDbName, publisherConn);

            try
            {
                // Connect to the Publisher and Distributor.
                publisherConn.Connect();
                distributorConn.Connect();

                // Disable all publishing on the AdventureWorks2012 database.
                if (publicationDb.LoadProperties())
                {
                    if (publicationDb.EnabledMergePublishing)
                    {
                        publicationDb.EnabledMergePublishing = false;
                    }
                    else if (publicationDb.EnabledTransPublishing)
                    {
                        publicationDb.EnabledTransPublishing = false;
                    }
                }
                else
                {
                    throw new ApplicationException(
                        String.Format("The {0} database does not exist.", publicationDbName));
                }

                // We cannot uninstall the Publisher if there are still Subscribers.
                if (distributor.RegisteredSubscribers.Count == 0)
                {
                    // Uninstall the Publisher, if it exists.
                    publisher = new DistributionPublisher(publisherName, distributorConn);
                    if (publisher.LoadProperties())
                    {
                        publisher.Remove(false);
                    }
                    else
                    {
                        // Do something here if the Publisher does not exist.
                        throw new ApplicationException(String.Format(
                            "{0} is not a Publisher for {1}.", publisherName, distributorName));
                    }

                    // Drop the distribution database.
                    if (distributionDb.LoadProperties())
                    {
                        distributionDb.Remove();
                    }
                    else
                    {
                        // Do something here if the distribition DB does not exist.
                        throw new ApplicationException(String.Format(
                            "The distribution database '{0}' does not exist on {1}.",
                            distributionDbName, distributorName));
                    }

                    // Uninstall the Distributor, if it exists.
                    if (distributor.LoadProperties())
                    {
                        // Passing a value of false means that the Publisher 
                        // and distribution databases must already be uninstalled,
                        // and that no local databases be enabled for publishing.
                        distributor.UninstallDistributor(false);
                    }
                    else
                    {
                        //Do something here if the distributor does not exist.
                        throw new ApplicationException(String.Format(
                            "The Distributor '{0}' does not exist.", distributorName));
                    }
                }
                else
                {
                    throw new ApplicationException("You must first delete all subscriptions.");
                }
            }
            catch (Exception ex)
            {
                // Implement appropriate error handling here.
                throw new ApplicationException("The Publisher and Distributor could not be uninstalled", ex);
            }
            finally
            {
                publisherConn.Disconnect();
                distributorConn.Disconnect();
            }

' Set the Distributor and publication database names.
' Publisher and Distributor are on the same server instance.
Dim publisherName As String = publisherInstance
Dim distributorName As String = subscriberInstance
Dim distributionDbName As String = "distribution"
Dim publicationDbName As String = "AdventureWorks2012"

' Create connections to the Publisher and Distributor
' using Windows Authentication.
Dim publisherConn As ServerConnection = New ServerConnection(publisherName)
Dim distributorConn As ServerConnection = New ServerConnection(distributorName)

' Create the objects we need.
Dim distributor As ReplicationServer
distributor = New ReplicationServer(distributorConn)
Dim publisher As DistributionPublisher
Dim distributionDb As DistributionDatabase
distributionDb = New DistributionDatabase(distributionDbName, distributorConn)
Dim publicationDb As ReplicationDatabase
publicationDb = New ReplicationDatabase(publicationDbName, publisherConn)

Try
    ' Connect to the Publisher and Distributor.
    publisherConn.Connect()
    distributorConn.Connect()

    ' Disable all publishing on the AdventureWorks2012 database.
    If publicationDb.LoadProperties() Then
        If publicationDb.EnabledMergePublishing Then
            publicationDb.EnabledMergePublishing = False
        ElseIf publicationDb.EnabledTransPublishing Then
            publicationDb.EnabledTransPublishing = False
        End If
    Else
        Throw New ApplicationException( _
            String.Format("The {0} database does not exist.", publicationDbName))
    End If

    ' We cannot uninstall the Publisher if there are still Subscribers.
    If distributor.RegisteredSubscribers.Count = 0 Then
        ' Uninstall the Publisher, if it exists.
        publisher = New DistributionPublisher(publisherName, distributorConn)
        If publisher.LoadProperties() Then
            publisher.Remove(False)
        Else
            ' Do something here if the Publisher does not exist.
            Throw New ApplicationException(String.Format( _
                "{0} is not a Publisher for {1}.", publisherName, distributorName))
        End If

        ' Drop the distribution database.
        If distributionDb.LoadProperties() Then
            distributionDb.Remove()
        Else
            ' Do something here if the distribition DB does not exist.
            Throw New ApplicationException(String.Format( _
             "The distribution database '{0}' does not exist on {1}.", _
             distributionDbName, distributorName))
        End If

        ' Uninstall the Distributor, if it exists.
        If distributor.LoadProperties() Then
            ' Passing a value of false means that the Publisher 
            ' and distribution databases must already be uninstalled,
            ' and that no local databases be enabled for publishing.
            distributor.UninstallDistributor(False)
        Else
            'Do something here if the distributor does not exist.
            Throw New ApplicationException(String.Format( _
                "The Distributor '{0}' does not exist.", distributorName))
        End If
    Else
        Throw New ApplicationException("You must first delete all subscriptions.")
    End If

Catch ex As Exception
    ' Implement appropriate error handling here.
    Throw New ApplicationException("The Publisher and Distributor could not be uninstalled", ex)

Finally
    publisherConn.Disconnect()
    distributorConn.Disconnect()

End Try

スレッドセーフ

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

次の方法で共有

ReplicationServer クラス

継承階層

構文

コンストラクター

プロパティ

メソッド

説明

スレッドセーフ

使用例

スレッドセーフ

関連項目

参照

その他の技術情報

その他のリソース

次の方法で共有

ReplicationServer クラス

継承階層

構文

コンストラクター

プロパティ

メソッド

説明

スレッド セーフ

使用例

スレッド セーフ

関連項目

参照

その他の技術情報

その他のリソース

スレッドセーフ

スレッドセーフ