DbSyncAdapter.DeleteCommand プロパティ

ベース テーブルからデータを削除するために使用されるクエリまたはストアド プロシージャを取得または設定します。

名前空間: Microsoft.Synchronization.Data
アセンブリ: Microsoft.Synchronization.Data (microsoft.synchronization.data.dll 内)

構文

'宣言
Public Property DeleteCommand As IDbCommand
'使用
Dim instance As DbSyncAdapter
Dim value As IDbCommand

value = instance.DeleteCommand

instance.DeleteCommand = value

public IDbCommand DeleteCommand { get; set; }

public:
property IDbCommand^ DeleteCommand {
    IDbCommand^ get ();
    void set (IDbCommand^ value);
}

/** @property */
public IDbCommand get_DeleteCommand ()

/** @property */
public void set_DeleteCommand (IDbCommand value)

public function get DeleteCommand () : IDbCommand

public function set DeleteCommand (value : IDbCommand)

プロパティ値

クエリまたはストアド プロシージャを格納する IDbCommand オブジェクト。

解説

同期アダプター コマンドにより、ピア データベースから選択してピア データベースにデータおよびメタデータの変更を適用するのに使用される、クエリとストアド プロシージャを指定できるようになります。詳細については、「コラボレーション同期用にサーバー データベースを準備する方法 (SQL Server 以外)」を参照してください。各コマンドは、同期中に値を渡すことができるセッション変数を使用します。これらの変数は、ADO.NET コマンドのクエリやストアド プロシージャに対する他のパラメーターと同じように指定します。詳細については、「コラボレーションでの同期でセッション変数を使用する方法」を参照してください。

例

次のコード例では、ピアの Customer テーブルから行を削除するコマンドを作成します。コマンドは、「データベース プロバイダーのセットアップ スクリプトに関するトピック」で定義されているストアド プロシージャです。完全なコンテキスト例でこのコードを表示するには、「コラボレーション同期用にサーバー データベースを準備する方法 (SQL Server 以外)」を参照してください。

SqlCommand delCustomerCmd = new SqlCommand();
delCustomerCmd.CommandType = CommandType.StoredProcedure;
delCustomerCmd.CommandText = "Sync.sp_Customer_ApplyDelete";
delCustomerCmd.Parameters.Add("@CustomerId", SqlDbType.UniqueIdentifier);
delCustomerCmd.Parameters.Add("@" + DbSyncSession.SyncMinTimestamp, SqlDbType.BigInt);
delCustomerCmd.Parameters.Add("@" + DbSyncSession.SyncRowCount, SqlDbType.Int).Direction = ParameterDirection.Output;
delCustomerCmd.Parameters.Add("@" + DbSyncSession.SyncForceWrite, SqlDbType.Int);

adapterCustomer.DeleteCommand = delCustomerCmd;

Dim delCustomerCmd As New SqlCommand()

With delCustomerCmd
    .CommandType = CommandType.StoredProcedure
    .CommandText = "Sync.sp_Customer_ApplyDelete"
    .Parameters.Add("@CustomerId", SqlDbType.UniqueIdentifier)
    .Parameters.Add("@" + DbSyncSession.SyncMinTimestamp, SqlDbType.BigInt)
    .Parameters.Add("@" + DbSyncSession.SyncRowCount, SqlDbType.Int).Direction = ParameterDirection.Output
    .Parameters.Add("@" + DbSyncSession.SyncForceWrite, SqlDbType.Int)
End With

adapterCustomer.DeleteCommand = delCustomerCmd

参照

リファレンス

DbSyncAdapter クラス
DbSyncAdapter メンバー
Microsoft.Synchronization.Data 名前空間