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

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

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

   Server およびPort プロパティがMySQL への接続には必須です。IntegratedSecurity をFALSE に設定した場合、User、Password も必須になります。 オプションで、Database を設定することもできます。Database は設定がない場合すべてのデータベースを使えるようになります。

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

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

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

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

   User=admin;Password=adminpassword;Database=test;Server=mysql-server;Port=3306;UseSSH=true;SSHAuthMode=Password;SSHPort=22;SSHServer=ssh-server;SSHUser=root;SSHPassword=sshpasswd;

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

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

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

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

   User=admin;Password=adminpassword;Database=test;Server=mysql-server;Port=3306;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="MySQLContext" connectionString="Offline=False;User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=3306;" providerName="System.Data.CData.MySQL" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.MySQL" type="System.Data.CData.MySQL.MySQLProviderServices, System.Data.CData.MySQL.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

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

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

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

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

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

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

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