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

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

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

   Salesforce 接続プロパティの設定方法

   埋め込みOAuth（UI でのログイン）による接続設定

   それでは、Salesforce への接続について説明していきましょう。最も簡単な方法として、Salesforce にログインする際と同様にUI 上からログインするだけで接続設定が完了します（埋め込みOAuth）。この方法をご利用になる場合は、「Salesforce への接続」をクリックしてください。

   標準認証の設定

   埋め込みOAuth 以外の方法を利用する場合、以下の3つの認証方式をご利用いただけます。標準的な認証方式では、以下の情報が必要となります。

   • ユーザー名
   • パスワード
   • セキュリティトークン

   セキュリティトークンの取得方法については、セキュリティトークン取得手順をご確認ください。

   OAuth 認証の設定

   ユーザー名とパスワードによる認証がご利用いただけない（避けたい）場合は、OAuth 認証をお使いいただけます。

   SSO（シングルサインオン）の設定

   最後に、IDプロバイダー経由でのシングルサインオンをご利用になる場合は、以下のプロパティを設定してください。

   • SSOProperties
   • SSOLoginUrl
   • TokenUrl

   より詳細な設定手順については、ヘルプドキュメントの「はじめに」セクションをご確認ください。

   
   <configuration>
      ... <connectionStrings>
       <add name="SalesforceContext" connectionString="Offline=False;User=username;Password=password;SecurityToken=Your_Security_Token;" providerName="System.Data.CData.Salesforce" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.Salesforce" type="System.Data.CData.Salesforce.SalesforceProviderServices, System.Data.CData.Salesforce.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

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

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

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

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

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

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

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

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