Entity Framework 6 からX-Cart データに連携

詳細情報をご希望ですか?

無償トライアル:

ダウンロードへ

製品の詳細情報へ:

X-Cart ADO.NET Provider

  • X-Cart に標準Visual Studio ウィザードからデータバインド。
  • CRUD(Create、Read、Update、Delete)オペレーションをサポート。
  • X-Cart の多様なデータに.NET アプリケーションから連携。


  • この記事は、Entity Framework のcode-first アプローチを使って、X-Cart に接続する方法を説明します。Entity Framework 6 は.NET 4.5 以上で利用可能です。

    

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

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

      An API Key must be created for your XCart Installation. In order to obtain the API Key, you need to install and configure the REST API Module for your X-Cart installation.

      • Login to your X-Cart Installation. Click on My addons on the bottom of the left side-bar navigation panel.
      • Search for REST API Module. Install the Module.
      • After the module has been installed, you need to set it up.
        • Go to the Settings section for the REST API Module.
        • On the settings page specify the API Key (only read)
      • Set the ApiKey and Url to the connection property to connect to data.
      <configuration> ... <connectionStrings> <add name="XCartContext" connectionString="Offline=False;Url=https://example.com/shop;ApiKey=MyApiKey;" providerName="System.Data.CData.XCart" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.XCart" type="System.Data.CData.XCart.XCartProviderServices, System.Data.CData.XCart.Entities.EF6" /> </providers> <entityFramework> </configuration> </code>
    4. インストールディレクトリの[lib] > 4.0 サブフォルダにあるSystem.Data.CData.XCart.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
    5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
    6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はXCartContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます:
      • PluralizingTableNameConvention をModelBuilder Conventions から削除。
      • MigrationHistory テーブルへのリクエストを削除。
      using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class XCartContext :DbContext { public XCartContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<XCartContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } }
    7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているX-Cart のエンティティ、例えばPROFILES にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。 using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; public class PROFILES { [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)] public System.String Id { get; set; } public System.String ProfileId { get; set; } } public class PROFILESMap :EntityTypeConfiguration<PROFILES> { public PROFILESMap() { this.ToTable("PROFILES"); this.HasKey(PROFILES => PROFILES.Id); this.Property(PROFILES => PROFILES.ProfileId); } }
    8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します: public DbSet<PROFILES> PROFILES { set; get; }
    9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例: XCartContext context = new XCartContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.PROFILES select line;