各製品の資料を入手。
詳細はこちら →
Entity Framework 6 からJira Assets のデータに連携
この記事は、Entity Framework のcode-first アプローチを使って、Jira Assets に接続する方法を説明します。Entity Framework 6 は.NET 4.5 以上で利用可能です。
最終更新日：2022-04-04
この記事で実現できるJira Assets 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Entity Framework はobject-relational mapping フレームワークで、データをオブジェクトとして扱うために使われます。Visual Studio のADO.NET Entity Data Model ウィザードを実行するとEntity Model を作成できますが、このモデルファーストアプローチでは、データソースに変更があった場合やエンティティ操作をより制御したい場合は不都合があります。この記事では、CData ADO.NET Provider を使いコードファーストアプローチでJira Assets にアクセスします。
- Visual Studio を起動し、新しいWindows Form アプリケーションを作成します。ここでは、.NET 4.5 のC# プロジェクトを使います。
- Visual Studio の ［パッケージ マネージャー コンソール］から'Install-Package EntityFramework' コマンドを実行し、最新のEntity Framework をインストールします。
- プロジェクトのApp.config ファイルを修正して、Jira Assets Entity Framework 6 アセンブリおよびコネクションストリングへの参照を追加します。
Jira Assets は、APIToken 経由での接続と認証をサポートしています。
API トークンを生成するには：
- Atlassian アカウントにログインします。
- セキュリティ設定 > API トークン > API トークンを作成するをクリックします。
Atlassian がAPI トークンを生成して表示します。
API トークンを生成したら、以下のパラメータをセットします。
- AuthScheme：APIToken。
- User：認証するユーザーのログイン名。
- APIToken：生成したAPI トークン。
これでJira Assets に接続して認証する準備が整いました。
<configuration> ... <connectionStrings> <add name="JiraAssetsContext" connectionString="Offline=False;User=MyUser;APIToken=myApiToken;Url=https://yoursitename.atlassian.net" providerName="System.Data.CData.JiraAssets" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.JiraAssets" type="System.Data.CData.JiraAssets.JiraAssetsProviderServices, System.Data.CData.JiraAssets.Entities.EF6" /> </providers> <entityFramework> </configuration> </code> - インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.JiraAssets.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
- この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
- プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はJiraAssetsContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
- PluralizingTableNameConvention をModelBuilder Conventions から削除。
- MigrationHistory テーブルへのリクエストを削除。
using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class JiraAssetsContext :DbContext { public JiraAssetsContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<JiraAssetsContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } } - もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているJira Assets のエンティティ、例えばObjects にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。
using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; public class Objects { [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)] public System.String Id { get; set; } public System.String ID { get; set; } } public class ObjectsMap :EntityTypeConfiguration<Objects> { public ObjectsMap() { this.ToTable("Objects"); this.HasKey(Objects => Objects.Id); this.Property(Objects => Objects.ID); } } - エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します：
public DbSet<Objects> Objects { set; get; } - コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例：
JiraAssetsContext context = new JiraAssetsContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Objects select line;
関連コンテンツ
