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

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

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

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

   API Token を取得する方法

   API token は、アカウントへの認証に必須です。トークンの生成には、Atlassian アカウントでサービスにログインし、API tokens > Create API token に進みます。生成されたトークンが表示されます。

   Confluence Cloud Account への接続

   Cloud アカウントへの接続には、以下のプロパティを設定します（Password は、Server Instance への接続時のみ必要で、Cloud Account への接続には不要になりました。）:

   • User: Confluence サーバーに認証するユーザー名。
   • APIToken: 認証するユーザーに紐付けられたAPI Token。
   • Url: JIRA エンドポイントのURL。例： https://yoursitename.atlassian.net

   Confluence Server Instance への接続

   Server instance への接続には以下を設定します:

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