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

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

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

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

   Connecting to Zendesk

   接続するには、URL を設定して認証を提供します。URL は、Zendesk Support のURL：https://{subdomain}.zendesk.com です。

   Zendesk への接続

   Zendesk は、Basic 認証またはOAuth 2 認証標準を利用しています。

   ベーシック認証

   ベーシック認証では、E メールアドレスとパスワード、もしくは、E メールアドレスとAPI token で接続します。User をE メールアドレスに設定し、次の方法でPassword とAPI Token を提供します。

   • Admin、Channels、API でZendesk Support Admin からパスワードを有効化します。
   • Zendesk Support Admin からAdmin->Channels->API と操作し、API token を管理します。同時に複数のトークンを有効化させることが可能です。

   OAuth 認証

   詳細はヘルプドキュメントを参照してください。

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