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

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

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

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

   Certinia 接続プロパティの取得・設定方法

   デフォルトでは、CData 製品は本番環境に接続します。サンドボックスアカウントを使用するには、UseSandbox をtrue に設定します。User にサンドボックスのユーザー名を指定してください。

   Certinia への認証

   Certinia への接続に使用できる認証方法は以下のとおりです。

   • ログイン認証
   • SSO
   • OAuth

   ログインおよびトークン

   User およびPassword をログインクレデンシャルに設定します。さらにSecurityToken を設定します。SecurityToken については、信頼できるIP アドレスに利用中のIP を追加することで指定する必要がなくなります。

   セキュリティトークンを無効にするには、以下の手順を実行してください。

   1. Certinia にログインして、「設定」セクションの「Quick Find」ボックスに「Network Access」と入力します。
   2. 使用しているIP アドレスを信頼できるIP アドレスのリストに追加します。

   セキュリティトークンの取得には、以下を実行してください。

   1. Certinia の個人情報設定用ページを開きます。
   2. セキュリティトークンリセット用のリンクをクリックすると、トークンが指定したメールアドレスに送信されます。
   3. 取得したセキュリティトークンを、SecurityToken 接続プロパティに指定するか、Password に追加してください。

   OAuth

   すべてのOAuth フローで、AuthScheme をOAuth に設定する必要があります。詳しい設定方法については、ヘルプドキュメントの「OAuth」セクションを参照してください。

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