ReplicationDatabase クラス
レプリケーション トポロジのパブリケーション データベースまたはサブスクリプション データベースを表します。
継承階層
System.Object
Microsoft.SqlServer.Replication.ReplicationObject
Microsoft.SqlServer.Replication.ReplicationDatabase
名前空間: Microsoft.SqlServer.Replication
アセンブリ: Microsoft.SqlServer.Rmo (Microsoft.SqlServer.Rmo.dll)
構文
'宣言
Public NotInheritable Class ReplicationDatabase _
Inherits ReplicationObject
'使用
Dim instance As ReplicationDatabase
public sealed class ReplicationDatabase : ReplicationObject
public ref class ReplicationDatabase sealed : public ReplicationObject
[<SealedAttribute>]
type ReplicationDatabase =
class
inherit ReplicationObject
end
public final class ReplicationDatabase extends ReplicationObject
ReplicationDatabase 型は、以下のメンバーを公開しています。
コンストラクター
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック メソッド") |
ReplicationDatabase() | ReplicationDatabase クラスの新しいインスタンスを初期化します。 |
|
ReplicationDatabase(String, ServerConnection) | データベースが存在するサーバーへの接続を提供し、指定したデータベース名を使用して ReplicationDatabase クラスの新しいインスタンスを初期化します。 |
先頭に戻る
プロパティ
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック プロパティ") |
AllowMergePublication | マージ レプリケーションを使用してデータベースをパブリッシュできるかどうかを指定します。 |
|
CachePropertyChanges | レプリケーション プロパティに加えられた変更をキャッシュするか、またはすぐに適用するかを取得します。値の設定も可能です。 (ReplicationObject から継承されています。) |
|
CompatibilityLevel | データベースの動作に関して互換性のある、SQL Server の最低バージョンを取得します。 |
|
ConnectionContext | Microsoft SQL Server のインスタンスへの接続を取得します。値の設定も可能です。 (ReplicationObject から継承されています。) |
|
DBOwner | 現在の接続で使用されているログインがデータベースに対する所有権を持っているかどうかを取得します。 |
|
DBReadOnly | データベースが読み取り専用かどうかを取得します。 |
|
EnabledMergePublishing | データベースでマージ パブリッシングが有効かどうかを取得します。値の設定も可能です。 |
|
EnabledTransPublishing | データベースでトランザクション パブリッシングまたはスナップショット パブリッシングが有効かどうかを取得します。値の設定も可能です。 |
|
HasPublications | データベースに既存のパブリケーションがあるかどうかを取得します。 |
|
HasPullSubscriptions | データベースに既存のプル サブスクリプションがあるかどうかを取得します。 |
|
IsExistingObject | サーバーにオブジェクトが存在するかどうかを取得します。 (ReplicationObject から継承されています。) |
|
LogReaderAgentExists | ログ リーダー エージェントがパブリケーション データベースに対して作成されているかどうかを取得します。 |
|
LogReaderAgentName | 既存のログ リーダー エージェントの名前を取得します。パブリッシュされたデータベースに対する新しいログ リーダー エージェントを作成するときには、ログ リーダー エージェントの名前の設定も可能です。 |
|
LogReaderAgentProcessSecurity | ディストリビューター側でログ リーダー エージェント ジョブを実行する Microsoft Windows アカウントを取得します。 |
|
LogReaderAgentPublisherSecurity | パブリッシャーに接続するためにログ リーダー エージェントが使用するログインを取得します。 |
|
MergePublications | レプリケーション データベースで定義されたマージ パブリケーションを返します。 |
|
MergePullSubscriptions | レプリケーション データベースで定義されたマージ プル サブスクリプションを返します。 |
|
Name | レプリケーション データベースの名前を取得します。値の設定も可能です。 |
|
QueueReaderAgentExists | キュー リーダー エージェント ジョブがデータベースに存在するかどうかを取得します。 |
|
QueueReaderAgentProcessSecurity | ディストリビューター側でキュー リーダー エージェント ジョブを実行する Microsoft Windows アカウントを取得します。 |
|
SqlServerName | このオブジェクトの接続先となる Microsoft SQL Server インスタンスの名前を取得します。 (ReplicationObject から継承されています。) |
|
TransPublications | レプリケーション データベースで定義されたトランザクション パブリケーションまたはスナップショット パブリケーションを返します。 |
|
TransPullSubscriptions | レプリケーション データベースで定義されたトランザクション パブリケーションまたはスナップショット パブリケーションへのプル サブスクリプションを表します。 |
|
UserData | ユーザーが独自のデータをオブジェクトにアタッチすることを許可するオブジェクト プロパティを取得します。値の設定も可能です。 (ReplicationObject から継承されています。) |
先頭に戻る
メソッド
| 名前 | 説明 | |
|---|---|---|
|
CommitPropertyChanges | キャッシュされているすべてのプロパティ変更ステートメントを、Microsoft SQL Server のインスタンスに送信します。 (ReplicationObject から継承されています。) |
|
CreateLogReaderAgent | トランザクション レプリケーションでパブリッシュされるデータベースに対するログ リーダー エージェント ジョブを作成します。 |
|
CreateQueueReaderAgent | ディストリビューション データベースに対するキュー リーダー エージェント ジョブを作成します。 |
|
Decouple | 参照先のレプリケーション オブジェクトをサーバーから切断します。 (ReplicationObject から継承されています。) |
|
EnumConflictTables | レプリケーション データベースを使用するすべてのマージ パブリケーションとマージ サブスクリプションに対する競合情報を返します。 |
|
EnumMergeConflictCounts | マージ パブリケーションまたはサブスクリプション データベースに格納されている競合についての情報を返します。 |
|
EnumMergePublications | レプリケーション データベースを使用するマージ パブリケーションの一覧を返します。 |
|
EnumMergePullSubscriptions | このレプリケーション データベースを使用するすべてのマージ プル サブスクリプションを返します。 |
|
EnumPublicationArticles | レプリケーション データベース内でパブリッシュされたオブジェクトのレプリケーション情報を返します。 |
|
EnumReplicationSchemaBoundViews | データベース内のすべてのユーザー定義スキーマ バインド ビュー オブジェクトを返します。 |
|
EnumReplicationStoredProcedures | データベース内のすべてのユーザー定義ストアド プロシージャ オブジェクトを返します。 |
|
EnumReplicationTables | データベース内のすべてのユーザー定義テーブル オブジェクトを返します。 |
|
EnumReplicationUserDefinedAggregates | データベース内のユーザー定義集計の一覧を返します。 |
|
EnumReplicationUserDefinedFunctions | データベース内のユーザー定義関数の一覧を返します。 |
|
EnumReplicationViews | データベース内のユーザー定義ビュー オブジェクトの一覧を返します。 |
|
EnumTransConflictCounts | 更新トランザクション パブリケーションまたはサブスクリプション データベースに格納されている競合についての情報を返します。 |
|
EnumTransPublications | データベースを使用するトランザクション パブリケーションとスナップショット パブリケーションの一覧を返します。 |
|
EnumTransPullSubscriptions | データベースを使用するトランザクション プル サブスクリプションとスナップショット プル サブスクリプションの一覧を返します。 |
|
Equals | (Object から継承されています。) |
|
GetHashCode | (Object から継承されています。) |
|
GetType | (Object から継承されています。) |
|
LinkPublicationForUpdateableSubscription | パブリッシャーへの接続時に更新可能なサブスクリプションの同期トリガーが使用する、構成およびセキュリティの情報を設定します。 |
|
Load | サーバーから既存のオブジェクトのプロパティを読み込みます。 (ReplicationObject から継承されています。) |
|
LoadProperties | サーバーから既存のオブジェクトのプロパティを読み込みます。 (ReplicationObject から継承されています。) |
|
ReadSubscriptionFailoverMode | トランザクション パブリケーションまたはスナップショット パブリケーションに対する更新サブスクリプションのフェールオーバー モードを返します。 |
|
Refresh | オブジェクトのプロパティを再度読み込みます。 (ReplicationObject から継承されています。) |
|
Script | ReplicationDatabase のプロパティに基づくデータベースでのレプリケーションのパブリッシングとサブスクリプションを有効化または無効化する Transact-SQL スクリプトを返します。 |
|
ScriptReplicationDBOption | ReplicationDatabase のプロパティに基づくデータベースでのレプリケーション オプションを有効化または無効化する Transact-SQL スクリプトを返します。 |
|
ToString | (Object から継承されています。) |
|
WriteSubscriptionFailoverMode | トランザクション パブリケーションまたはスナップショット パブリケーションに対する更新サブスクリプションのフェールオーバー モードを設定します。 |
先頭に戻る
説明
ReplicationDatabase を使用して、パブリケーション データベースまたはサブスクリプション データベースを表すことができます。 ReplicationDatabase を使用して、master、tempdb、msdb、model などのシステム データベースを表すことはできません。 ディストリビューション データベースは、DistributionDatabase によって表されます。
スレッド セーフ
この型の public static (Microsoft Visual Basic では Shared) のすべてのメンバーは、マルチスレッド操作で安全に使用できます。 インスタンス メンバーの場合は、スレッド セーフであるとは限りません。
使用例
この例では、ディストリビューターをインストールするときにディストリビューション データベースを作成します。 また、AdventureWorks データベースでのマージとトランザクション パブリッシングを有効化します。
// 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
この例では、ディストリビューション データベースのプロパティを変更します。
// 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
この例では、AdventureWorks データベースでのマージとトランザクション パブリッシングを無効化し、ディストリビューション データベースを削除します。
// 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) のメンバーはすべて、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。
関連項目
参照
Microsoft.SqlServer.Replication 名前空間