各製品の資料を入手。
詳細はこちら →Entity Framework 6 からGreenhouse のデータに連携
この記事は、Entity Framework のcode-first アプローチを使って、Greenhouse に接続する方法を説明します。Entity Framework 6 は.NET 4.5 以上で利用可能です。
最終更新日:2022-04-04
この記事で実現できるGreenhouse 連携のシナリオ
こんにちは!ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Entity Framework はobject-relational mapping フレームワークで、データをオブジェクトとして扱うために使われます。Visual Studio のADO.NET Entity Data Model ウィザードを実行するとEntity Model を作成できますが、このモデルファーストアプローチでは、データソースに変更があった場合やエンティティ操作をより制御したい場合は不都合があります。この記事では、CData ADO.NET Provider を使いコードファーストアプローチでGreenhouse にアクセスします。
- Visual Studio を起動し、新しいWindows Form アプリケーションを作成します。ここでは、.NET 4.5 のC# プロジェクトを使います。
- Visual Studio の [パッケージ マネージャー コンソール]から'Install-Package EntityFramework' コマンドを実行し、最新のEntity Framework をインストールします。
- プロジェクトのApp.config ファイルを修正して、Greenhouse Entity Framework 6 アセンブリおよびコネクションストリングへの参照を追加します。
Greenhouse への接続にはAPI キーが必要です。API キーを作成するには、以下の手順に従います。
- ナビゲーションバーのConfigure アイコンをクリックし、左側にあるDev Center を見つけます。
- API Credential Management を選択します。
- Create New API Key をクリックします。
- "API Type" をHarvest に設定します。
- "Partner" をcustom に設定します。
- オプションで、説明を入力します。
- Manage permissions に進み、本製品を利用してアクセスしたいリソースに基づいて適切な権限を選択します。
- 作成されたキーをコピーし、APIKey にその値を設定します。
<configuration> ... <connectionStrings> <add name="GreenhouseContext" connectionString="Offline=False;APIKey=YourAPIKey;" providerName="System.Data.CData.Greenhouse" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.Greenhouse" type="System.Data.CData.Greenhouse.GreenhouseProviderServices, System.Data.CData.Greenhouse.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
- インストールディレクトリの[lib] > 4.0 サブフォルダにあるSystem.Data.CData.Greenhouse.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
- この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
- プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はGreenhouseContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます:
- PluralizingTableNameConvention をModelBuilder Conventions から削除。
- MigrationHistory テーブルへのリクエストを削除。
using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class GreenhouseContext :DbContext { public GreenhouseContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<GreenhouseContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
- もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているGreenhouse のエンティティ、例えばApplications にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。
using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; public class Applications { [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)] public System.String Id { get; set; } public System.String Id { get; set; } } public class ApplicationsMap :EntityTypeConfiguration<Applications> { public ApplicationsMap() { this.ToTable("Applications"); this.HasKey(Applications => Applications.Id); this.Property(Applications => Applications.Id); } }
- エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します:
public DbSet<Applications> Applications { set; get; }
- コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例:
GreenhouseContext context = new GreenhouseContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Applications select line;