ReplicationServer クラス

リファレンス

定義

名前空間:: Microsoft.SqlServer.Replication

アセンブリ:: Microsoft.SqlServer.Rmo.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

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

public ref class ReplicationServer sealed : Microsoft::SqlServer::Replication::ReplicationObject

[System.Runtime.InteropServices.Guid("94506773-2893-4401-8D6E-8CACCBDE4BDB")]
public sealed class ReplicationServer : Microsoft.SqlServer.Replication.ReplicationObject

[<System.Runtime.InteropServices.Guid("94506773-2893-4401-8D6E-8CACCBDE4BDB")>]
type ReplicationServer = class
    inherit ReplicationObject

Public NotInheritable Class ReplicationServer
Inherits ReplicationObject

継承: Object

ReplicationObject
ReplicationServer

属性: GuidAttribute

例

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

コンストラクター

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(String, String, ConnectionSecurityContext)	サブスクライバー側でコピーされたサブスクリプションデータベースをアタッチします。
ChangeDistributorPassword(SecureString)	ディストリビューターのパスワードを変更します。新しいパスワードは SecureString オブジェクトとして指定されます。
ChangeDistributorPassword(String)	ディストリビューターのパスワードを変更します。
ChangeReplicationServerPasswords(ReplicationSecurityMode, String, SecureString)	SecureString オブジェクトを使用して、レプリケーションサーバーで保持されるログインのパスワードの格納されたすべてのインスタンスを変更します。
ChangeReplicationServerPasswords(ReplicationSecurityMode, String, String)	レプリケーションサーバーで保持されるログインのパスワードの格納されたすべてのインスタンスを変更します。
CheckValidCreation()	有効なレプリケーションの作成を確認します。 (継承元 ReplicationObject)
CheckValidDefinition(Boolean)	定義が有効かどうかを示します。 (継承元 ReplicationObject)
CommitPropertyChanges()	キャッシュされたすべてのプロパティ変更ステートメントを Microsoft SQL Serverのインスタンスに送信します。 (継承元 ReplicationObject)
CopySubscriptionDatabase(String, String, Boolean)	既存のプルサブスクリプションデータベースをコピーします。
Decouple()	参照先のレプリケーションオブジェクトをサーバーから切断します。 (継承元 ReplicationObject)
EnumAgentProfiles(AgentType)	サーバーでサポートされるレプリケーションエージェントのパフォーマンスプロファイルを返します。
EnumBusinessLogicHandlers()	サーバーで登録されたビジネスロジックハンドラーを返します。
EnumCurrentPrincipals()	データベースミラーリングに参加しているパブリッシュされたすべてのデータベースの情報を返します。
EnumCustomResolvers()	SQL Serverの接続されたインスタンスに登録されているすべてのカスタム競合回避モジュールを返します。
EnumDistributionDatabases()	Microsoft SQL Server の現在接続されているインスタンスがディストリビューターである場合にインストールされたディストリビューションデータベースを返します。
EnumDistributionPublishers()	現在接続されている Microsoft SQL Server のインスタンスをディストリビューターとして使用してパブリッシャーを返します。
EnumHeterogeneousColumns(String, String, String)	SQL Server以外のパブリッシャーのテーブル内の列を返します。
EnumHeterogeneousTables(String)	SQL Server以外のパブリッシャーで使用可能なテーブルを返します。
EnumLightPublications(String, Int32, Boolean, Boolean)	ライトパブリケーションを返します。
EnumRegisteredSubscribers()	パブリッシャーに登録されるサブスクライバーを返します。
EnumReplicationDatabases()	レプリケーションが有効になっているデータベースを返します。
EnumSubscriberSubscriptions(String, Int32)	サブスクライバーサーバーでのサブスクリプションを返します。
GetChangeCommand(StringBuilder, String, String)	レプリケーションの変更コマンドを返します。 (継承元 ReplicationObject)
GetCreateCommand(StringBuilder, Boolean, ScriptOptions)	レプリケーションの作成コマンドを返します。 (継承元 ReplicationObject)
GetCurrentPrincipal(String)	指定したパブリケーションデータベースの現在のデータベースミラーリングプリンシパルを返します。
GetDropCommand(StringBuilder, Boolean)	レプリケーションの削除コマンドを返します。 (継承元 ReplicationObject)
GetOriginalPublisher(String)	データベースミラーリングセッションに参加しているパブリッシュされたデータベースの元のパブリッシャーの名前を返します。
InstallDistributor(SecureString, DistributionDatabase)	Microsoft SQL Server の現在接続されているインスタンスにディストリビューターをインストールします。ここで、オブジェクトを使用してSecureStringパスワードを指定します。
InstallDistributor(String, DistributionDatabase)	Microsoft SQL Serverの現在接続されているインスタンスにディストリビューターをインストールします。
InstallDistributor(String, SecureString)	リモートディストリビューターを登録します。ここでは、パスワードは SecureString オブジェクトを使用して指定されます。
InstallDistributor(String, String)	リモートディストリビューターを登録します。
InternalRefresh(Boolean)	レプリケーションで内部更新を開始します。 (継承元 ReplicationObject)
Load()	サーバーから既存のオブジェクトのプロパティを読み込みます。 (継承元 ReplicationObject)
LoadProperties()	サーバーから既存のオブジェクトのプロパティを読み込みます。 (継承元 ReplicationObject)
Refresh()	オブジェクトのプロパティを再度読み込みます。 (継承元 ReplicationObject)
Script(ScriptOptions)	サーバーにレプリケーションをインストールまたはアンインストールするための Transact-SQL スクリプトを返します。
ScriptInstallDistributor(String, ScriptOptions)	ディストリビューターをインストールする Transact-SQL スクリプトを返します。
ScriptUninstallDistributor(ScriptOptions)	ディストリビューターのアンインストールに使用できる Transact-SQL スクリプトを返します。
UninstallDistributor(Boolean)	SQL Serverの現在接続されているインスタンスでレプリケーションの発行と配布をアンインストールします。

適用対象

次の方法で共有

ReplicationServer クラス

定義

例

注釈

スレッドセーフ

コンストラクター

プロパティ

メソッド

適用対象

こちらもご覧ください

その他のリソース

次の方法で共有

ReplicationServer クラス

定義

例

注釈

スレッド セーフ

コンストラクター

プロパティ

メソッド

適用対象

こちらもご覧ください

その他のリソース

スレッドセーフ