Entity Framework 6 からBigCommerce Data にアクセス

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

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

   BigCommerce authentication is based on the standard OAuth flow. To authenticate, you must initially create an app via the Big Commerce developer platform where you can obtain an OAuthClientId, OAuthClientSecret, and CallbackURL. These three parameters will be set as connection properties to your driver.

   Additionally, in order to connect to your BigCommerce Store, you will need your StoreId. To find your Store Id please follow these steps:

   1. Log in to your BigCommerce account.
   2. From the Home Page, select Advanced Settings > API Accounts.
   3. Click Create API Account.
   4. A text box named API Path will appear on your screen.
   5. Inside you can see a URL of the following structure: https://api.bigcommerce.com/stores/{Store Id}/v3.
   6. As demonstrated above, your Store Id will be between the 'stores/' and '/v3' path paramters.
   7. Once you have retrieved your Store Id you can either click Cancel or proceed in creating an API Account in case you do not have one already.
   <configuration> ... <connectionStrings> <add name="BigCommerceContext" connectionString="Offline=False;OAuthClientId=YourClientId; OAuthClientSecret=YourClientSecret; StoreId='YourStoreID'; CallbackURL='http://localhost:33333'" providerName="System.Data.CData.BigCommerce" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.BigCommerce" type="System.Data.CData.BigCommerce.BigCommerceProviderServices, System.Data.CData.BigCommerce.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.BigCommerce.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はBigCommerceContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。
   using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class BigCommerceContext :DbContext { public BigCommerceContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<BigCommerceContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているBigCommerce のエンティティ、例えばCustomers にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。 using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; public class Customers { [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)] public System.String Id { get; set; } public System.String FirstName { get; set; } } public class CustomersMap :EntityTypeConfiguration<Customers> { public CustomersMap() { this.ToTable("Customers"); this.HasKey(Customers => Customers.Id); this.Property(Customers => Customers.FirstName); } }
8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します： public DbSet<Customers> Customers { set; get; }
9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例： BigCommerceContext context = new BigCommerceContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Customers select line;