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

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

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

   それでは、Salesforce Data Cloud への認証方法を設定していきましょう。Salesforce Data Cloud では、OAuth 標準による認証をサポートしています。

   OAuth 認証

   AuthScheme をOAuth に設定してください。

   デスクトップアプリケーション

   CData 製品では、デスクトップでの認証を簡略化する埋め込みOAuth アプリケーションを提供しています。

   また、Salesforce Data Cloud コンソールで設定および登録するカスタムOAuth アプリケーションを介してデスクトップから認証することも可能です。詳しくは、ヘルプドキュメントのカスタムOAuth アプリの作成をご確認ください。

   接続する前に、以下のプロパティを設定してください。

   • InitiateOAuth：GETANDREFRESH。InitiateOAuth を使用すれば、繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要がなくなります
   • OAuthClientId（カスタムアプリケーションのみ）：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントID
   • OAuthClientSecret（カスタムアプリケーションのみ）：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット

   接続すると、CData 製品がデフォルトブラウザでSalesforce Data Cloud のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えてください。

   以下のようにドライバーがOAuth プロセスを完了します。

   • コールバックURL からアクセストークンを取得します
   • 古いトークンの期限が切れた際は、新しいアクセストークンを取得します
   • OAuthSettingsLocation にOAuth 値を保存し、接続間で永続化します

   Web アプリケーションやヘッドレスマシンを含むその他のOAuth 認証方法については、ヘルプドキュメントをご確認ください。

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

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

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

7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているSalesforce Data Cloud のエンティティ、例えば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 [Account ID] { get; set; }
   }
   public class AccountMap :EntityTypeConfiguration<Account> {
   	public AccountMap() {
   		this.ToTable("Account");
   		this.HasKey(Account => Account.Id);
   		this.Property(Account => Account.[Account ID]);
   	}
   }
   

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

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

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

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