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

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

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

   DB2 に接続するには以下のプロパティを設定します。

   • Server: DB2 を実行するサーバー名。
   • Port: DB2 サーバーのポート。
   • Database: DB2 データベース名。

   接続の準備ができたら、認証スキームを選択し、以下で説明するように適切なプロパティを設定します。

   CData 製品 は、DB2 への認証に4つの異なるスキームをサポートします。DB2 ユーザー資格情報（デフォルト）、暗号化されたユーザー資格情報、IBM Identity and Access Management（IAM）認証、および Kerberos です。

   DB2 ユーザー資格情報

   ユーザー資格情報を使用して認証するには、次のプロパティを設定します。
   • AuthScheme：USRIDPWD。
   • User：データベースへのアクセス権を持つユーザーのユーザー名。
   • Password：データベースへのアクセス権を持つユーザーのパスワード。

   暗号化されたユーザー資格情報

   サーバーがセキュア認証に対応しており、暗号化されたユーザー資格情報を使用して認証を行いたい場合は、このプロパティを設定します。
   • AuthScheme：EUSRIDPWD

   IAM、Kerberos で認証したい場合は、ヘルプドキュメントの「はじめに」セクションを参照してください。

   パスワード方式によるSSH 接続

   パスワード方式によるSSH接続時に必要なプロパティ一覧を以下に示します。

   • User: DB2 のユーザ
   • Password: DB2 のパスワード
   • Database: DB2 の接続先データベース
   • Server: DB2 のサーバー
   • Port: DB2 のポート
   • UserSSH: "true"
   • SSHAuthMode: "Password"
   • SSHPort: SSH のポート
   • SSHServer: SSH サーバー
   • SSHUser: SSH ユーザー
   • SSHPassword: SSH パスワード

   接続文字列形式では以下のようになります。

   Server=10.0.1.2;Port=50000;User=admin;Password=admin;Database=testUseSSH=true;SSHAuthMode=Password;SSHPort=22;SSHServer=ssh-server;SSHUser=root;SSHPassword=sshpasswd;

   公開鍵認証方式方式によるSSH 接続

   公開鍵認証によるSSH接続時に必要なプロパティ一覧を以下に示します。

   • User: DB2 のユーザ
   • Password: DB2 のパスワード
   • Database: DB2 の接続先データベース
   • Server: DB2 のサーバー
   • Port: DB2 のポート
   • UserSSH: "true"
   • SSHAuthMode: "Public_Key"
   • SSHClientCertType: キーストアの種類
   • SSHPort: SSH のポート
   • SSHServer: SSH サーバー
   • SSHUser: SSH ユーザー
   • SSHClientCert: 秘密鍵ファイルのパス

   接続文字列形式では以下のようになります。

   Server=10.0.1.2;Port=50000;User=admin;Password=admin;Database=test;UseSSH=true;SSHAuthMode=Public_Key;SSHClientCertType=PUBLIC_KEY_FILE;SSHPort=22;SSHServer=ssh-server;SSHUser=root;SSHClientCert=C:\Keys\key.pem;

   
   <configuration>
      ... <connectionStrings>
       <add name="DB2Context" connectionString="Offline=False;Server=10.0.1.2;Port=50000;User=admin;Password=admin;Database=test;" providerName="System.Data.CData.DB2" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.DB2" type="System.Data.CData.DB2.DB2ProviderServices, System.Data.CData.DB2.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

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

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

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

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

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

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

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

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