Entity Framework 6 からQuickbase のデータに連携

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

Entity Framework はobject-relational mapping フレームワークで、データをオブジェクトとして扱うために使われます。Visual Studio のADO.NET Entity Data Model ウィザードを実行するとEntity Model を作成できますが、このモデルファーストアプローチでは、データソースに変更があった場合やエンティティ操作をより制御したい場合は不都合があります。この記事では、CData ADO.NET Provider を使いコードファーストアプローチでQuickbase にアクセスします。

1. Visual Studio を起動し、新しいWindows Form アプリケーションを作成します。ここでは、.NET 4.5 のC# プロジェクトを使います。
2. Visual Studio の ［パッケージ マネージャー コンソール］から'Install-Package EntityFramework' コマンドを実行し、最新のEntity Framework をインストールします。
3. プロジェクトのApp.config ファイルを修正して、Quickbase Entity Framework 6 アセンブリおよびコネクションストリングへの参照を追加します。

   ユーザー認証方法

   ユーザー資格情報で認証するには、次の接続プロパティを設定してください。

   1. User とPassword を設定します。
   2. アプリケーションがApplicationToken を必要とする場合には、指定しない場合にはエラーが発生します。 ApplicationToken は、SpecificApp > Settings > App management > App properties > Advanced settings > Security options > Manage Application Token に移動して取得できます。

   ユーザートークン認証

   ユーザートークンで認証するには、次の接続プロパティを設定してください。

   1. UserToken を設定すれば接続できます。UserToken は、Quick Base > My Preferences > My User Information > Manage User Tokens から確認できます。
   <configuration> ... <connectionStrings> <add name="QuickbaseContext" connectionString="Offline=False;[email protected];Password=password;Domain=myinstance.quickbase.com;ApplicationToken=bwkxrb5da2wn57bzfh9xn24" providerName="System.Data.CData.Quickbase" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.Quickbase" type="System.Data.CData.Quickbase.QuickbaseProviderServices, System.Data.CData.Quickbase.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.Quickbase.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はQuickbaseContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。
   using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class QuickbaseContext :DbContext { public QuickbaseContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<QuickbaseContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているQuickbase のエンティティ、例えばSampleTable_1 にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。 using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; public class SampleTable_1 { [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)] public System.String Id { get; set; } public System.String Id { get; set; } } public class SampleTable_1Map :EntityTypeConfiguration<SampleTable_1> { public SampleTable_1Map() { this.ToTable("SampleTable_1"); this.HasKey(SampleTable_1 => SampleTable_1.Id); this.Property(SampleTable_1 => SampleTable_1.Id); } }
8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します： public DbSet<SampleTable_1> SampleTable_1 { set; get; }
9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例： QuickbaseContext context = new QuickbaseContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.SampleTable_1 select line;