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

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

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

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

   データに接続するには、次の接続プロパティが必要です。

   • Server：SingleStore データベースをホスティングしているサーバーのホスト名またはIP アドレス。
   • Port：SingleStore データベースをホスティングしているサーバーのポート。

   また、オプションで以下を設定することもできます。

   • SingleStore：SingleStore Server に接続する場合のデフォルトデータベース。設定されていない場合、すべてのデータベースのテーブルが返されます。

   標準認証

   標準認証で認証するには、次を設定します。

   • User：SingleStore サーバーに認証する際に使われるユーザー。
   • Password：SingleStore サーバーに認証する際に使われるパスワード。

   統合セキュリティを使用した接続

   標準のユーザー名とパスワードを提供する代わりに、Windows 認証を介して信頼されたされたユーザーをサーバーに認証できます。

   SSL 認証

   SSL 認証を活用してセキュアなセッションを介してSingleStore データに接続できます。次の接続プロパティを設定し、データに接続します。

   • SSLClientCert：クライアント証明書のための証明書ストア名に設定。クライアントとサーバーの両方のマシンでトラストストアとキーストアが保持される2-way SSL の場合に使用されます。
   • SSLClientCertPassword：クライアント証明書ストアがパスワードで保護されている場合、この値をストアのパスワードに設定します。
   • SSLClientCertSubject：TLS/SSL クライアント証明書のサブジェクト。ストア内の証明書を検索するために使用されます。
   • SSLClientCertType：クライアントストアの証明書タイプ。
   • SSLServerCert：サーバーが受け入れ可能な証明書。

   SSH 認証

   SSH を使用して、セキュアにリモートマシンにログインできます。SingleStore データにSSH 経由でアクセスするには、次の接続プロパティを設定します。

   • SSHClientCert：クライアント証明書のための証明書ストア名に設定。
   • SSHClientCertPassword：クライアント証明書ストアがパスワードで保護されている場合、この値をストアのパスワードに設定します。
   • SSHClientCertSubject：TLS/SSL クライアント証明書のサブジェクト。ストア内の証明書を検索するために使用されます。
   • SSHClientCertType：クライアントストアの証明書タイプ。
   • SSHPassword：SSH サーバーに認証するためのパスワード。
   • SSHPort：SSH 操作に使用するポート。
   • SSHServer：認証しようとしているSSH 認証サーバー。
   • SSHServerFingerPrint：接続先のホストの検証に使用するSSH サーバーのフィンガープリント。
   • SSHUser：SSH サーバーに認証するためのユーザー名。
   <configuration> ... <connectionStrings> <add name="SingleStoreContext" connectionString="Offline=False;User=myUser;Password=myPassword;Database=NorthWind;Server=myServer;Port=3306;" providerName="System.Data.CData.SingleStore" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.SingleStore" type="System.Data.CData.SingleStore.SingleStoreProviderServices, System.Data.CData.SingleStore.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.SingleStore.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はSingleStoreContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。
   using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class SingleStoreContext :DbContext { public SingleStoreContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<SingleStoreContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているSingleStore のエンティティ、例えば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. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例： SingleStoreContext context = new SingleStoreContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Orders select line;