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

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

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

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

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

   ShipStation への接続には、BASIC 認証標準を使います。

   1. ShipStation アカウントにログインします。
   2. 右上隅にある［設定］アイコンをクリックします。左側にカラムメニューが表示されます。
   3. ［アカウント］->［API 設定］をクリックします。
   4. ［API 設定］ページで、API Key とAPI Secret を書き留めます。

   ShipStation への認証

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