チュートリアル : データソース構成ウィザードを使用した接続の頻度があまり高くないアプリケーションの作成

[アーティクル]
09/17/2008

更新 : 2008 年 7 月

Visual Studio 2008 SP1 以降では、同期を構成する場合に、[データ同期の構成] ダイアログボックスに加えて、データソース構成ウィザードも使用できます。このチュートリアルでは、データソース構成ウィザードの実行時に Synchronization Services を組み込むことによって、接続の頻度があまり高くないアプリケーションを開発する詳細な手順について説明します。

接続の頻度があまり高くないアプリケーションとは、リモートデータに常にアクセスできるとは限らないアプリケーションのことです。これらのアプリケーションは常にアクセスできるとは限らないため、クライアントに存在するローカルデータベースのデータを使用し、リモートデータベースとローカルデータベースの間でデータを定期的に同期します。ローカルデータベースとリモートデータベースの間のデータの同期は、Microsoft Synchronization Services for ADO.NET (Microsoft.Synchronization.Data 名前空間) によって行います。この同期を新規に作成するには、[新しい項目の追加] ダイアログボックスでローカルデータベースキャッシュをアプリケーションに追加する方法と、データソース構成ウィザードを実行する方法があります。このチュートリアルでは、後者について説明します。

このチュートリアルでは次のタスクを行います。

新しい Windows フォームアプリケーションを作成します。
データソース構成ウィザードを実行して、ローカルデータベースキャッシュを持つ型指定されたデータセットの作成と構成を行います。
データの表示および同期の確認を行う Windows フォームを作成します。
データベース間の同期を開始するコードを追加します。
同期されたレコードの数に関する情報を表示するメッセージボックスを追加します。

前提条件

このチュートリアルを完了するには、次の条件が必要です。

Northwind サンプルデータベースの SQL Server バージョンにアクセスします。詳細については、「方法 : サンプルデータベースをインストールする」を参照してください。
Visual Studio を実行しているコンピュータに SQL Server Compact 3.5 をインストールする必要があります。

Windows フォームアプリケーションの作成

Windows フォームにデータを表示するので (同期が成功したことを検証するため)、このチュートリアルでは最初に新しい Windows フォームアプリケーションを作成します。

メモ :
お使いのマシンで、Visual Studio ユーザーインターフェイスの一部の要素の名前や場所が、次の手順とは異なる場合があります。これらの要素は、使用している Visual Studio のエディションや独自の設定によって決まります。詳細については、「Visual Studio の設定」を参照してください。

新しい Windows フォームアプリケーションを作成するには

[ファイル] メニューで新しいプロジェクトを作成します。
プロジェクトに「OCSWalkthrough2」という名前を付けます。
[Windows フォームアプリケーション] テンプレートをクリックし、[OK] をクリックします。詳細については、「Windows ベースのアプリケーションの作成」を参照してください。

OCSWalkthrough2 プロジェクトが作成され、ソリューションエクスプローラに追加されます。

ローカルデータベースキャッシュが含まれるデータソースの作成

このチュートリアルでは、データソース構成ウィザードを使用してアプリケーションに Synchronization Services を組み込むので、次の手順はウィザードの起動です。この手順では、ウィザードを起動し、Northwind サンプルデータベース内の Customers テーブルに基づくデータセットを作成します。データセットに追加するデータベーステーブルを選択するときに、ローカルデータキャッシュを有効にするオプションを選択します。

ローカルデータベースキャッシュが含まれるデータソースを作成するには

[データ] メニューの [データソースの表示] をクリックします。
[データソース] ウィンドウで、[新しいデータソースの追加] をクリックしてデータソース構成ウィザードを起動します。
[データソースの種類を選択] ページで、[データベース] を選択されている既定値のままにし、[次へ] をクリックします。
[データ接続の選択] ページで、次のいずれかの操作を行います。
- SQL Server バージョンの Northwind サンプルデータベースへのデータ接続がドロップダウンリストに表示されている場合は、これを選択します。
  
  または
- [新しい接続] をクリックして [データソースの選択] ダイアログボックスまたは [接続の追加]/[接続の変更] ダイアログボックスを開き、SQL Server バージョンの Northwind データベースへの新しい接続を作成します。詳細については、「[接続の追加] ダイアログボックスと [接続の変更] ダイアログボックス (一般)」を参照してください。
データベースにパスワードが必要な場合は、該当するオプションを選択して重要情報を含め、[次へ] をクリックします。
[アプリケーション構成ファイルへの接続文字列を保存] ページで、[次へ] をクリックします。
[データベースオブジェクトの選択] ページの [テーブル] ノードを展開します。
Customers テーブルを選択します。
[ローカルデータベースキャッシュを有効にする] をオンにします。
[データベースオブジェクトの選択] ページで [次へ] をクリックします

[キャッシュするテーブルの選択] ページで Customers テーブルを選択します。

メモ :
[同期モード] は既定値の増分のままにします。増分モードでは、最後の同期以降に行われた変更のみを同期します。スナップショットモードでは、ローカルにキャッシュされたテーブル全体が、サーバーにある現在のテーブルで置き換えられます。どちらを選択しても、初回時はテーブル全体がローカルデータベースキャッシュに読み込まれ、必ず現在のデータ一式から開始することになります。

[同期モード] は既定値の増分のままにします。増分モードでは、最後の同期以降に行われた変更のみを同期します。スナップショットモードでは、ローカルにキャッシュされたテーブル全体が、サーバーにある現在のテーブルで置き換えられます。どちらを選択しても、初回時はテーブル全体がローカルデータベースキャッシュに読み込まれ、必ず現在のデータ一式から開始することになります。

[終了] をクリックします。
ローカルにキャッシュされたいずれかのテーブルの同期モードが [初回同期後の新規および増分の変更] に設定されている場合、SQL Server データベースについて更新が必要となり、[SQL スクリプト生成] ダイアログボックスが開きます。既定では、このダイアログボックスの両方のオプションが選択されています。
- [増分の変更のためにサーバーを更新する]。サーバーを自動的に更新して、このダイアログボックスを閉じた直後から増分の同期を有効にするには、このオプションを選択します。
- [SQL スクリプトを後で使用するためプロジェクトに保存する]。生成された SQL スクリプトをプロジェクトへ追加して、後で SQL Server データベースで実行できるようにするには、このオプションを選択します。元に戻すスクリプトも生成されてプロジェクトに追加されます。
[開く] をクリックします。

アプリケーションでの同期の有効化

前の手順でデータソース構成ウィザードの実行を完了すると、データ同期が構成されます。これで、アプリケーションに次のものが含まれました。

Northwind データベースのローカルバージョン (Northwind.sdf)。
データ同期設定情報ファイル (NorthwindCache.sync)。
データソース構成ウィザードによって生成された、型指定されたデータセット NorthwindDataSet.xsd。これには、ローカルデータベースからデータが読み込まれた Customers テーブルが含まれます。

初回の同期が実行されると、ローカルデータベースキャッシュ内の Customers テーブルがサーバーデータベースと同期されます。つまり、ローカル SQL Server Compact 3.5 データベース (Northwind.sdf) の Customers テーブルには、サーバー上のデータベースの Customers テーブルに現在含まれているデータが読み込まれます。
SQLScripts フォルダ。トラッキング列、削除された項目テーブル、サーバーでの変更を追跡する必要なトリガの作成に使用されるスクリプトが含まれています。

SQLUndoScripts フォルダ。トラッキング列、削除された項目テーブル、サーバーに追加された必要なトリガを削除するスクリプトが含まれています。

メモ :
SQL スクリプトは、サーバーで変更を加える必要がある場合にのみ作成されます。削除された項目テーブルとトラッキング列が既にサーバーにある場合は、スクリプトは作成されません。

次の Microsoft Synchronization Services for ADO.NET DLL への参照。
- Microsoft.Synchronization.Data
- Microsoft.Synchronization.Data.Server
- Microsoft.Synchronization.Data.SqlServerCe

アプリケーションへの同期機能の追加

データ同期を構成した後も、アプリケーションに同期機能を追加する必要があります。具体的には、同期処理を開始するコードを追加する必要があります。さらに、データを表示し、同期処理を開始するコントロールもフォームに追加します。

まず、[データソース] ウィンドウから [Customers] ノードをフォームにドラッグして、DataGridView コントロールを追加します。DataGridView には、ローカルデータベースキャッシュ (プロジェクトに置かれている Northwind.sdf データベース) から Customers テーブルが表示されるので、ローカルデータベースとリモートデータベースの間でデータが同期されていることを検証できます。同期処理を開始するボタンを追加することもできます。

データバインドフォームを作成してデータ同期を開始および検証するには

[データソース] ウィンドウから Form1 に [Customers] ノードをドラッグします。
ツールボックスから Form1 に Button コントロールをドラッグします。Name プロパティを「SynchronizeButton」に設定し、Text プロパティを「Synchronize Now」に変更します。
[同期] をダブルクリックし、ダブルクリックイベントハンドラを作成して、コードエディタでフォームを開きます。

同期処理を開始するコードを追加し、データセットで Customers テーブルを再入力します。イベントハンドラのコードは次のようになります。

メモ :
syncStats 変数を宣言するコードの行については、このドキュメントで後に説明します。

' Call the Synchronize method to synchronize
' data between local and remote databases.
Dim syncAgent As NorthwindCacheSyncAgent = New NorthwindCacheSyncAgent()
Dim syncStats As Microsoft.Synchronization.Data.SyncStatistics = _
    syncAgent.Synchronize()

' After synchronizing the data, refill the
' table in the dataset.
Me.CustomersTableAdapter.Fill(NorthwindDataSet.Customers)

// Call the Synchronize method to synchronize
// data between local and remote databases.
NorthwindCacheSyncAgent syncAgent = new NorthwindCacheSyncAgent();
Microsoft.Synchronization.Data.SyncStatistics syncStats;
syncStats = syncAgent.Synchronize();
// After synchronizing the data, refill the
// table in the dataset.
this.customersTableAdapter.Fill(this.northwindDataSet.Customers);

アプリケーションのテスト

アプリケーションをテストするには

F5 キーを押します。
アプリケーションを実行している状態で、サーバーエクスプローラまたはデータベースエクスプローラ (または他のデータベース管理ツール) を使用し、リモートサーバーデータベースに接続してレコードを変更します。
1. サーバーエクスプローラまたはデータベースエクスプローラで、リモートデータベースサーバー (Northwind.sdf への接続ではありません) 上の Customers テーブルを探します。
2. Customers テーブルを右クリックし、[テーブルデータの表示] をクリックします。
3. 1 つ以上のレコードを変更し、変更をコミットします (変更した行以外に移動します)。
フォームに戻り、[同期] をクリックします。
リモートデータベースへの変更がローカルデータベースと同期され、フォームに表示されることを検証します。
フォームを閉じます。(デバッグを停止します)。

同期からの情報の取得

Synchronize メソッドの呼び出しは、同期処理を開始するだけではありません。Synchronize メソッドは、同期に関する情報にアクセス可能な SyncStatistics オブジェクトも返します。

同期の統計にアクセスするには

コードエディタで Form1 を開き、前の手順で追加したコードの下にある SynchronizeButton_Click イベントハンドラの末尾に次のコードを追加します。
```
    MessageBox.Show("Changes downloaded: " & _
syncStats.TotalChangesDownloaded.ToString)
```
```
MessageBox.Show("Changes downloaded: " +
    syncStats.TotalChangesDownloaded.ToString());
```

アプリケーションのテスト

アプリケーションをテストするには

F5 キーを押します。
アプリケーションを実行している状態で、サーバーエクスプローラまたはデータベースエクスプローラ (または他のデータベース管理ツール) を使用し、リモートサーバーデータベースに接続してレコードを変更します。
1. サーバーエクスプローラまたはデータベースエクスプローラで、リモートデータベースサーバー (Northwind.sdf への接続ではありません) 上の Customers テーブルを探します。
2. Customers テーブルを右クリックし、[テーブルデータの表示] をクリックします。
3. 1 つ以上のレコードを変更し、変更をコミットします (変更した行以外に移動します)。
フォームに戻り、[同期] をクリックします。
同期されたレコードに関する情報が含まれるメッセージボックスが表示されます。
リモートデータベースへの変更がローカルデータベースと同期され、フォームに表示されることを検証します。

次の手順

アプリケーションの要件によっては、アプリケーションにローカルデータベースキャッシュを構成した後で、さらに操作を追加する必要があります。たとえば、このアプリケーションに対して次のような拡張を行うことができます。

双方向同期を実装して、ローカルデータベースキャッシュでの変更をサーバーにアップロードできるようにします。詳細については、「方法 : ローカルデータベースとリモートデータベースで双方向同期を構成する」を参照してください。
クライアントアプリケーションを、ローカルデータベースキャッシュと共に配置します。詳細については、「チュートリアル : 接続の頻度があまり高くないクライアントアプリケーションとローカルデータベースの配置」を参照してください。

参照

処理手順

チュートリアル : 接続の頻度があまり高くないクライアントアプリケーションとローカルデータベースの配置

概念

接続の頻度があまり高くないアプリケーションの概要

SQL Server Compact 3.5 と Visual Studio

変更履歴

日付	履歴	原因
2008 年 7 月	トピックを追加	SP1 機能変更

次の方法で共有

チュートリアル : データソース構成ウィザードを使用した接続の頻度があまり高くないアプリケーションの作成

前提条件

Windows フォームアプリケーションの作成

新しい Windows フォームアプリケーションを作成するには

ローカルデータベースキャッシュが含まれるデータソースの作成

ローカルデータベースキャッシュが含まれるデータソースを作成するには

アプリケーションでの同期の有効化

アプリケーションへの同期機能の追加

データバインドフォームを作成してデータ同期を開始および検証するには

アプリケーションのテスト

アプリケーションをテストするには

同期からの情報の取得

同期の統計にアクセスするには

アプリケーションのテスト

アプリケーションをテストするには

次の手順

参照

処理手順

概念

変更履歴

その他のリソース

次の方法で共有

チュートリアル : データ ソース構成ウィザードを使用した接続の頻度があまり高くないアプリケーションの作成

前提条件

Windows フォーム アプリケーションの作成

新しい Windows フォーム アプリケーションを作成するには

ローカル データベース キャッシュが含まれるデータ ソースの作成

ローカル データベース キャッシュが含まれるデータ ソースを作成するには

アプリケーションでの同期の有効化

アプリケーションへの同期機能の追加

データ バインド フォームを作成してデータ同期を開始および検証するには

アプリケーションのテスト

アプリケーションをテストするには

同期からの情報の取得

同期の統計にアクセスするには

アプリケーションのテスト

アプリケーションをテストするには

次の手順

参照

処理手順

概念

変更履歴

その他のリソース

チュートリアル : データソース構成ウィザードを使用した接続の頻度があまり高くないアプリケーションの作成

Windows フォームアプリケーションの作成

新しい Windows フォームアプリケーションを作成するには

ローカルデータベースキャッシュが含まれるデータソースの作成

ローカルデータベースキャッシュが含まれるデータソースを作成するには

データバインドフォームを作成してデータ同期を開始および検証するには