Entity Framework はobject-relational mapping フレームワークで、データをオブジェクトとして扱うために使われます。Visual Studio のADO.NET Entity Data Model ウィザードを実行するとEntity Model を作成できますが、このモデルファーストアプローチでは、データソースに変更があった場合やエンティティ操作をより制御したい場合は不都合があります。この記事では、CData ADO.NET Provider を使いコードファーストアプローチでExact Online にアクセスします。
- Visual Studio を起動し、新しいWindows Form アプリケーションを作成します。ここでは、.NET 4.5 のC# プロジェクトを使います。
- Visual Studio の ［パッケージ マネージャー コンソール］から'Install-Package EntityFramework' コマンドを実行し、最新のEntity Framework をインストールします。
- プロジェクトのApp.config ファイルを修正して、Exact Online Entity Framework 6 アセンブリおよびコネクションストリングへの参照を追加します。
Exact Online はOAuth 認証標準を使用します。InitiateOAuth 接続プロパティはOAuth フローを容易にします。デフォルトではGETANDREFRESH です。埋め込みクレデンシャルを使用する、またはExact にOAuth アプリを登録して独自のクレデンシャルを取得することもできます。
OAuth 値に加え、Region を指定します。Division が設定されない場合は、デフォルトのDivision が使用されます。
詳しくは、ヘルプドキュメントの「はじめに」を参照してください。
<configuration>
... <connectionStrings>
<add name="ExactOnlineContext" connectionString="Offline=False;Region='United States';Division=5512;" providerName="System.Data.CData.ExactOnline" />
</connectionStrings>
<entityFramework>
<providers>
... <provider invariantName="System.Data.CData.ExactOnline" type="System.Data.CData.ExactOnline.ExactOnlineProviderServices, System.Data.CData.ExactOnline.Entities.EF6" />
</providers>
<entityFramework>
</configuration>
</code>
- インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.ExactOnline.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
-
この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
- プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はExactOnlineContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
- PluralizingTableNameConvention をModelBuilder Conventions から削除。
- MigrationHistory テーブルへのリクエストを削除。
using System.Data.Entity;
using System.Data.Entity.Infrastructure;
using System.Data.Entity.ModelConfiguration.Conventions;
class ExactOnlineContext :DbContext {
public ExactOnlineContext() { }
protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table
Database.SetInitializer<ExactOnlineContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
}
}
- もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているExact Online のエンティティ、例えばAccounts にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。
using System.Data.Entity.ModelConfiguration;
using System.ComponentModel.DataAnnotations.Schema;
public class Accounts {
[DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)]
public System.String Id { get; set; }
public System.String Name { get; set; }
}
public class AccountsMap :EntityTypeConfiguration<Accounts> {
public AccountsMap() {
this.ToTable("Accounts");
this.HasKey(Accounts => Accounts.Id);
this.Property(Accounts => Accounts.Name);
}
}
- エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します：
public DbSet<Accounts> Accounts { set; get; }
- コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例：
ExactOnlineContext context = new ExactOnlineContext();
context.Configuration.UseDatabaseNullSemantics = true;
var query = from line in context.Accounts select line;