Entity Framework 6 からMonday.com のデータに連携

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

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

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

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

   Monday AuditLog API

   Monday AuditLog API は、API トークンによる認証のみをサポートしています。

   監査ログAPI トークンを生成するには：

   1. monday.com アカウントにログインします。
   2. 画面右上のアバター（画像アイコン）をクリックします。
   3. 表示されたメニューからAdministration を選択します。
   4. 左側のナビゲーションでSecurity をクリックします。
   5. Audit タブをクリックします。
   6. Monitor by API -> Copy をクリックして、AuditLog API トークンをコピーします。

   API トークンを取得した後、以下の接続プロパティを設定します。

   • Schema："AuditLog" に設定。
   • AuthScheme：Token
   • APIToken：取得した監査ログAPI トークン
   • URL：Monday アカウントURL。ログイン後、自身のMonday ホームページのURL をコピーできます。例：https://your-account-name.monday.com/。

   Monday GraphQL API

   Monday GraphQL API は、API トークンまたはOAuth 標準による認証をサポートしています。

   API トークン

   API トークンで接続するには、AuthScheme をToken に設定し、次の手順でAPIToken を取得します。

   1. monday.com アカウントにログインします。
   2. 画面右上のアバター（画像アイコン）をクリックします。
   3. 表示されたメニューからAdministration を選択します（管理者権限が必要です）。
   4. 左側のナビゲーションでConnections をクリックし、表示されたページでAPI タブをクリックします。
   5. Personal API Token で、Create token をクリックしてパーソナルAPI トークンを作成します。APIToken 接続プロパティをこの値に設定します。
      • すでにトークンを作成している場合は、Personal API Token でCopy ボタンをクリックしてAPI トークンをコピーします。APIToken 接続プロパティをこの値に設定します。

   OAuth で認証する場合は、ヘルプドキュメントの「OAuth 認証の使用」セクションを参照してください。

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