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

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

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

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

   ActiveCampaign 接続プロパティの取得・設定方法

   ActiveCampaign はAPI キーによる認証をサポートしています。ActiveCampaign に接続するには以下を設定します。

   • URL：アカウントのDeveloper タブのMy Settings ページで確認できます。次に例を示します。https://{yourAccountName}.api-us1.com
   • APIKey：アカウントのDeveloper タブのSettings ページで確認できます。ActiveCampaign アカウントの各ユーザーには、それぞれ固有のAPI キーがあります。

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