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

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

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

   ドライバーはOAuth 2.0 のリソースオーナーパスワードクレデンシャル（ROPC）グラントを使用してSuadeo に認証します。認証は直接資格情報を使用して行われます。ブラウザーベースの認証フローやリフレッシュトークンはありません。

   以下の接続プロパティを設定します：

   • URL：Suadeo インスタンスのベースURL。
   • User：Suadeo のユーザー名。
   • Password：Suadeo のパスワード。
   • AuthenticationName：Suadeo インスタンスの認証設定の名前識別子。異なる環境やユースケースに対して異なる認証名を設定できます。

   接続すると、ドライバーは資格情報をSuadeo のOAuth トークンエンドポイントに送信してアクセストークンを受け取り、以降のすべてのリクエストに使用します。セッション中に必要に応じて新しいアクセストークンが自動的に取得されます。

   
   <configuration>
      ... 
     <connectionStrings>
       <add name="SuadeoContext" connectionString="Offline=False;URL=https://mysuadeoinstance;User=username;Password=password;AuthenticationName=your_auth_name;" providerName="System.Data.CData.Suadeo" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.Suadeo" type="System.Data.CData.Suadeo.SuadeoProviderServices, System.Data.CData.Suadeo.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

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

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

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

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

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

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

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

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