Entity Framework 6 からBasecamp データに連携

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

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

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

   Basecamp はBasic 認証もしくはOAuth 2.0 認証を使います。Basic 認証を使用するには、Basecamp へのログインに使用するuser およびpassword が必要です。OAuth 2.0 を使用して認証するには、Basecamp にアプリを登録してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得する必要があります。

   詳しくは、ヘルプドキュメントの「はじめに」セクションを参照してください。

   さらに、AccountId 接続プロパティを設定する必要があります。これはBasecamp にログイン後にURL で確認できます。

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