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

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

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

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

   Zuora はユーザー認証にOAuth 標準を使用しています。OAuth 認証ついて詳しくは、オンラインヘルプドキュメントを参照してください。

   Tenant プロパティの設定

   プロバイダへの有効な接続を作成するには、アカウントの設定と合致するテナント値を1つ選択する必要があります。以下は、利用可能なオプションのリストです。
   • USProduction：リクエストはhttps://rest.zuora.com に送信されます。
   • USAPISandbox：リクエストはhttps://rest.apisandbox.zuora.com に送信されます。
   • USPerformanceTest：リクエストはhttps://rest.pt1.zuora.com に送信されます。
   • EUProduction：リクエストはhttps://rest.eu.zuora.com に送信されます。
   • EUSandbox：リクエストはhttps://rest.sandbox.eu.zuora.com に送信されます。

   デフォルトではUSProduction テナントを使用します。

   Zuora サービスの選択

   データクエリとAQuA API の2つのZuora サービスを使用します。デフォルトでは、ZuoraService はAQuADataExport に設定されています。

   DataQuery

   データクエリ機能は、非同期の読み取り専用SQL クエリを実行することで、Zuora テナントからのデータのエクスポートを実現します。 このサービスは、素早く軽量なSQL クエリでの使用を推奨します。

   制限

   • フィルタ適用後の、テーブルごとの入力レコードの最大数： 1,000,000
   • 出力レコードの最大数： 100,000
   • テナントごとの、実行用に送信される同時クエリの最大数： 5
   • テナントごとの、同時クエリの制限に達した後に実行用に送信され、キューに追加されるクエリの最大数： 10
   • 1時間単位での、各クエリの最大処理時間： 1
   • GB 単位での、各クエリに割り当てられるメモリの最大サイズ： 2
   • Index Join を使用する際のインデックスの最大値。言い換えれば、Index Join を使用する際にWHERE 句で使われる一意の値に基づいた、左のテーブルから返されるレコードの最大数： 20.000

   AQuADataExport

   AQuA API のエクスポートは、すべてのオブジェクト（テーブル）のすべてのレコードをエクスポートするように設計されています。AQuA のクエリジョブには以下の制限があります。

   制限

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