Entity Framework 6 からAzure Synapse のデータに連携

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

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

   Azure Synapse への接続

   Azure Synapse データベースに接続するには、認証に加えて（下記参照）、次のプロパティを設定します。

   • Server：Azure を実行しているサーバー。Azure ポータルにログインして、［Azure Synapse Analytics］->［Select your database］->［Overview］->［Server name］に進むと確認できます。
   • Database：［Azure Synapse Analytics］ページのAzure ポータルに表示されるデータベース名。

   Azure Synapse への認証

   Azure Synapse は、Entra ID（Azure AD）、Azure サービスプリンシパル、Managed Service Identity（MSI）、パスワード（デフォルト）、Azure Password を使用する認証をサポートします。

   パスワードでAzure Synapse に直接認証するには、以下のプロパティを設定します。

   • AuthScheme：Password
   • User：認証するAzure Synapse ユーザー。
   • Password：認証するAzure Synapse ユーザーのパスワード。

   その他の認証方法については、ヘルプドキュメント の「はじめに」セクションを参照してください。

   
   <configuration>
      ... <connectionStrings>
       <add name="AzureSynapseContext" connectionString="Offline=False;User=myuser;Password=mypassword;Server=localhost;Database=Northwind;" providerName="System.Data.CData.AzureSynapse" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.AzureSynapse" type="System.Data.CData.AzureSynapse.AzureSynapseProviderServices, System.Data.CData.AzureSynapse.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

4. インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.AzureSynapse.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
5. この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
6. プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はAzureSynapseContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
   • PluralizingTableNameConvention をModelBuilder Conventions から削除。
   • MigrationHistory テーブルへのリクエストを削除。

   
   using System.Data.Entity;
   using System.Data.Entity.Infrastructure;
   using System.Data.Entity.ModelConfiguration.Conventions;
   class AzureSynapseContext :DbContext {
   	public AzureSynapseContext() { }
   	protected override void OnModelCreating(DbModelBuilder modelBuilder) {  // To remove the requests to the Migration History table
   		Database.SetInitializer<AzureSynapseContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>();
   	}
   }
   

7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているAzure Synapse のエンティティ、例えばProducts にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。

   
   using System.Data.Entity.ModelConfiguration;
   using System.ComponentModel.DataAnnotations.Schema;
   public class Products {
   	[DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)]
   	public System.String Id { get; set; }
   	public System.String Id { get; set; }
   }
   public class ProductsMap :EntityTypeConfiguration<Products> {
   	public ProductsMap() {
   		this.ToTable("Products");
   		this.HasKey(Products => Products.Id);
   		this.Property(Products => Products.Id);
   	}
   }
   

8. エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します：

   
   public DbSet<Products> Products { set; get; }
   

9. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例：

   AzureSynapseContext context = new AzureSynapseContext();
   context.Configuration.UseDatabaseNullSemantics = true;
   var query = from line in context.Products select line;