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

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

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

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

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

   Box は、認証にOAuth スタンダードを使用します。Box への認証には、登録アプリのOAuthClientId、OAuthClientSecret、CallbackURL を取得して、接続プロパティに設定してください。詳細はヘルプドキュメントの「はじめに」を参照してください。

   なお、Box Driver はBox のファイルの一覧表示やユーザー管理情報の取得用です。Box に保管されているExcel、CSV、JSON などのファイル内のデータを読み込みたい場合には、それぞれExcel Driver、CSV Driver、JSON Driver をご利用ください。

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