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

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

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

1. Visual Studio を起動し、新しいWindows Form アプリケーションを作成します。ここでは、.NET 4.5 のC# プロジェクトを使います。
2. Visual Studio の ［パッケージ マネージャー コンソール］から'Install-Package EntityFramework' コマンドを実行し、最新のEntity Framework をインストールします。
3. プロジェクトのApp.config ファイルを修正して、Salesloft Entity Framework 6 アセンブリおよびコネクションストリングへの参照を追加します。 SalesLoft はOAuth 認証標準またはAPI キーを使って認証します。OAuth では認証するユーザーにブラウザでSalesloft との通信を要求します。

   OAuth

   OAuth で認証するには、OAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得するためにOAuth アプリを作成する必要があります。認証手順は、ヘルプドキュメントのOAuth セクションを参照してください。

   API キー

   または、APIKeyで認証します。SalesLoft ユーザーインターフェース：https://accounts.salesloft.com/oauth/applications/ で、API キーをプロビジョニングします。リクエストを発行し、使用するキーを受け取ります。

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