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

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

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

   Klaviyo に認証するには、API キーを取得します。API キーは「My Account」から生成・確認できます。

   1. 「Settings」>「API Keys」に移動します。
   2. 「Create API Key」をクリックします。
   3. API キーに名前を付け、必要なスコープを選択します。

   CData 製品から接続するには、API Key に取得した Klaviyo API キーを設定してください。

   OAuth 認証を使用する場合は、ヘルプドキュメントをご参照ください。

   
   <configuration>
      ... <connectionStrings>
       <add name="KlaviyoContext" connectionString="Offline=False;APIKey=my_api_key;" providerName="System.Data.CData.Klaviyo" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.Klaviyo" type="System.Data.CData.Klaviyo.KlaviyoProviderServices, System.Data.CData.Klaviyo.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.Klaviyo.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はKlaviyoContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。

   
   using System.Data.Entity;
   using System.Data.Entity.Infrastructure;
   using System.Data.Entity.ModelConfiguration.Conventions;
   class KlaviyoContext :DbContext {
   	public KlaviyoContext() { }
   	protected override void OnModelCreating(DbModelBuilder modelBuilder) {  // To remove the requests to the Migration History table
   		Database.SetInitializer<KlaviyoContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
   	}
   }
   

7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているKlaviyo のエンティティ、例えばCampaigns にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。

   
   using System.Data.Entity.ModelConfiguration;
   using System.ComponentModel.DataAnnotations.Schema;
   public class Campaigns {
   	[DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)]
   	public System.String Id { get; set; }
   	public System.String Id { get; set; }
   }
   public class CampaignsMap :EntityTypeConfiguration<Campaigns> {
   	public CampaignsMap() {
   		this.ToTable("Campaigns");
   		this.HasKey(Campaigns => Campaigns.Id);
   		this.Property(Campaigns => Campaigns.Id);
   	}
   }
   

8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します：

   
   public DbSet<Campaigns> Campaigns { set; get; }
   

9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例：

   KlaviyoContext context = new KlaviyoContext();
   context.Configuration.UseDatabaseNullSemantics = true;
   var query = from line in context.Campaigns select line;