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

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

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

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

   HubSpot はOAuth 認証 およびPrivateAppToken ベース認証をサポートします。

   OAuth

   HubSpot は埋め込みOAuth 認証情報を提供しており、デスクトップアプリケーションまたはヘッドレスマシンから簡単に接続できます。 Web アプリケーションから接続するには、カスタムOAuth アプリケーションを作成する必要があります。 OAuth 経由で接続するには、すべての認証フローでAuthScheme をOAuth に設定します。 ヘルプドキュメントでは、利用可能なOAuth フローでのHubSpot への認証について詳しく説明します。 カスタムOAuth アプリケーションの作成についての情報と、すでに埋め込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、「カスタムOAuth アプリケーションの作成」セクション を参照してください。

   また、PrivateAppToken ベース認証についてはヘルプドキュメントの「接続の確立」セクションを参照してください。

   
   <configuration>
      ... <connectionStrings>
       <add name="HubSpotContext" connectionString="Offline=False;" providerName="System.Data.CData.HubSpot" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.HubSpot" type="System.Data.CData.HubSpot.HubSpotProviderServices, System.Data.CData.HubSpot.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

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

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

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

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

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

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

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

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