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

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

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

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

   Authentication セクションのExcelFile には有効なExcel ファイルを設定する必要があります。

   Amazon S3 内のExcel への接続

   URI をバケット内のExcel ファイルに設定します。さらに、次のプロパティを設定して認証します。

   • AWSAccessKey：AWS アクセスキー（username）に設定。
   • AWSSecretKey：AWS シークレットキーに設定。

   Box 内のExcel への接続

   URI をExcel ファイルへのパスに設定します。Box へ認証するには、OAuth 認証標準を使います。 認証方法については、Box への接続 を参照してください。

   Dropbox 内のExcel への接続

   URI をExcel ファイルへのパスに設定します。Dropbox へ認証するには、OAuth 認証標準を使います。 認証方法については、Dropbox への接続 を参照してください。ユーザーアカウントまたはサービスアカウントで認証できます。ユーザーアカウントフローでは、以下の接続文字列で示すように、ユーザー資格情報の接続プロパティを設定する必要はありません。

   SharePoint Online SOAP 内のExcel への接続

   URI をExcel ファイルを含むドキュメントライブラリに設定します。認証するには、User、Password、およびStorageBaseURL を設定します。

   SharePoint Online REST 内のExcel への接続

   URI をExcel ファイルを含むドキュメントライブラリに設定します。StorageBaseURL は任意です。指定しない場合、ドライバーはルートドライブで動作します。 認証するには、OAuth 認証標準を使用します。

   FTP 内のExcel への接続

   URI をExcel ファイルへのパスが付いたサーバーのアドレスに設定します。認証するには、User およびPassword を設定します。

   Google Drive 内のExcel への接続

   デスクトップアプリケーションからのGoogle への認証には、InitiateOAuth をGETANDREFRESH に設定して、接続してください。詳細はドキュメントの「Google Drive への接続」を参照してください。

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