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

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

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

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

   Airtable への接続には、APIKey、BaseId、TableNames のプロパティが必須です。ViewNames は任意項目でテーブルのビューを指定することができます。

   • APIKey : アカウントのAPI Key。取得には、アカウントにログインして、API セクションで「Generate API Key」をクリックします。
   • BaseId : ベースのId。取得には、APIKey と同じ場所で、「Airtable API」をクリックするか、https://airtable.com/api に進み、ベースを選択します。"The ID of this base is appxxN2ftedc0nEG7." というメッセージがIntroduction セッションで表示されます。
   • TableNames : 選択されたベースのテーブル名のカンマ区切りのリスト。UI で見られるテーブル名と同じです。
   • ViewNames : table.view 形式のビューのカンマ区切りのリスト。UI でみられるビュー名と同じです。
   <configuration> ... <connectionStrings> <add name="AirtableContext" connectionString="Offline=False;APIKey=keymz3adb53RqsU;BaseId=appxxN2fe34r3rjdG7;TableNames=TableA,...;ViewNames=TableA.ViewA,...;" providerName="System.Data.CData.Airtable" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.Airtable" type="System.Data.CData.Airtable.AirtableProviderServices, System.Data.CData.Airtable.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.Airtable.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はAirtableContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。
   using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class AirtableContext :DbContext { public AirtableContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<AirtableContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているAirtable のエンティティ、例えば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. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例： AirtableContext context = new AirtableContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.SampleTable_1 select line;