Entity Framework 6 を使って QuickBooks データにアクセス

Entity Framework は、データをオブジェクトとして扱うことができるオブジェクトリレーショナルマッピングフレームワークです。Visual Studio で ADO.NET Entity Data Model ウィザードを実行して Entity Model を生成する「モデルファーストアプローチ」もありますが、データソースに変更があった場合や、エンティティの動作をより細かく制御したい場合には不利になることがあります。この記事では、CData ADO.NET Provider を使用して QuickBooks データにアクセスする「コードファーストアプローチ」を紹介します。

以下の手順は、Entity Framework 6 を介してデータにアクセスするために、すべての CData ADO.NET Data Provider で使用できます。モデルファーストアプローチについては、ヘルプドキュメントのガイドを参照してください。

Visual Studio を開き、新しい Windows フォームアプリケーションを作成します。この記事では、.NET 4.5 を使用する C# プロジェクトを使用します。
Visual Studio のパッケージマネージャーコンソールで「Install-Package EntityFramework」コマンドを実行し、最新リリースの Entity Framework をインストールします。
プロジェクトの App.config ファイルを変更して、QuickBooks Entity Framework 6 アセンブリへの参照と接続文字列を追加します。
```
<configuration>
  
  <connectionStrings>
    <add name="QuickBooksContext" connectionString="Offline=False;User=USERNAME;Password=PASSWORD;URL=http://localhost:2080;QBXML Version=12.0" providerName="System.Data.CData.QuickBooks" />
  </connectionStrings>
  <entityFramework>
    <providers>
      
      <provider invariantName="System.Data.CData.QuickBooks" type="System.Data.CData.QuickBooks.QuickBooksProviderServices, System.Data.CData.QuickBooks.Entities.EF6" />
    </providers>
  <entityFramework>
</configuration>
```
QuickBooks のデスクトップエディションに接続するには、アプリケーションと一緒にインストールされる Remote Connector アプリケーションを使用します。 Remote Connector は、リモートの QuickBooks インスタンスへの接続を可能にする軽量なスタンドアロンサーバーです。また、QuickBooks への直接 COM アクセスが利用できない状況（例: ASP.NET、Java、またはリモートマシン上の会社ファイル）でも、アプリケーションを QuickBooks に接続するために使用されます。詳細情報と接続確立の手順については、ヘルプドキュメントの「はじめに」ガイドを参照してください。
インストールディレクトリの lib -> 4.0 サブフォルダにある System.Data.CData.QuickBooks.Entities.EF6.dll への参照を追加し、プロジェクトをビルドして Entity Framework 6 を使用するためのセットアップを完了します。
この時点でプロジェクトをビルドし、すべてが正しく動作していることを確認してください。

以下の手順に従って、Entity Framework を使用したコーディングを開始しましょう。

プロジェクトに新しい .cs ファイルを追加し、クラスを作成します。これがデータベースコンテキストとなり、DbContext クラスを継承します。この例では、このクラスを QuickBooksContext と名付けています。以下のコード例では、OnModelCreating メソッドをオーバーライドして、次の変更を行います。
- ModelBuilder Conventions から PluralizingTableNameConvention を削除します。
- MigrationHistory テーブルへのリクエストを削除します。
```
using System.Data.Entity;
using System.Data.Entity.Infrastructure;
using System.Data.Entity.ModelConfiguration.Conventions;

class QuickBooksContext : DbContext {
  public QuickBooksContext() { }

  protected override void OnModelCreating(DbModelBuilder modelBuilder)
  {
    // MigrationHistory テーブルへのリクエストを削除
    Database.SetInitializer<QuickBooksContext>(null);
    // 複数形の名前を削除
    modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
  }
}
```

別の .cs ファイルを作成し、取得する QuickBooks エンティティの名前（例: Accounts）を付けます。このファイルで、以下の例のようにエンティティとエンティティ構成の両方を定義します。

using System.Data.Entity.ModelConfiguration;
using System.ComponentModel.DataAnnotations.Schema;

public class Accounts {

  [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)]
  public System.String ID { get; set; }
  public System.String Name { get; set; }
  public System.String Type { get; set; }
  public System.Double Balance { get; set; }
  public System.DateTime TimeCreated { get; set; }
}

public class AccountMap : EntityTypeConfiguration<Accounts> {
  public AccountMap() {
    this.ToTable("Accounts");
    this.HasKey(Account => Account.ID);
    this.Property(Account => Account.Name);
    this.Property(Account => Account.Type);
    this.Property(Account => Account.Balance);
    this.Property(Account => Account.TimeCreated);
  }
}

エンティティを作成したら、コンテキストクラスにエンティティを追加します。
```
public DbSet<Accounts> Account { set; get; }
```
コンテキストとエンティティが完成したら、別のクラスでデータをクエリする準備が整いました。例えば、以下のようになります。
```
QuickBooksContext context = new QuickBooksContext();
context.Configuration.UseDatabaseNullSemantics = true;
var query = from line in context.Account select line;
```

サンプルプロジェクト

QuickBooks Data Provider を Entity Framework コードファーストアプローチで使い始めるために、完全に機能するサンプルプロジェクトをダウンロードしてください。このプロジェクトには、QuickBooks からのデータの選択、挿入、更新、削除の例が含まれています。また、接続を行うには QuickBooks ADO.NET Data Provider が必要です。こちらから無料トライアルをダウンロードできます。

Entity Framework 6 を使って QuickBooks データにアクセス

サンプルプロジェクト

In this article

Related articles