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

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

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

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

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

   CockroachDB に接続するには以下を設定します。

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