Entity Framework 6 からSage Cloud Accounting データに連携

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

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

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

   埋め込みOAuth 接続を使用することでSage Business Cloud Accounting に接続できます。接続すると、ブラウザにSage Business Cloud Accounting OAuth エンドポイントが開きます。 OAuth 処理を完了するにはログインして権限を付与します。OAuth 認証フローの詳細については、オンラインヘルプドキュメントの「OAuth」セクションを参照してください。

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