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

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

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

   Databricks Lakebase に接続するには、以下のプロパティを設定します。

   • DatabricksInstance: Databricks インスタンスまたはサーバーホスト名を指定します。形式は instance-abcdef12-3456-7890-abcd-abcdef123456.database.cloud.databricks.com です。
   • Server: Lakebase データベースをホストするサーバーのホスト名または IP アドレスを指定します。
   • Port（オプション）: Lakebase データベースをホストするサーバーのポート番号を指定します。デフォルトは 5432 です。
   • Database（オプション）: Lakebase サーバーへの認証後に接続するデータベースを指定します。デフォルトでは認証ユーザーのデフォルトデータベースに接続します。

   OAuth クライアント認証

   OAuth クライアント資格情報を使用して認証するには、サービスプリンシパルで OAuth クライアントを構成します。手順の概要は以下のとおりです。

   1. 新しいサービスプリンシパルを作成・構成する
   2. サービスプリンシパルに権限を割り当てる
   3. サービスプリンシパル用の OAuth シークレットを作成する

   詳細については、ヘルプドキュメントの「Setting Up OAuthClient Authentication」セクションをご参照ください。

   OAuth PKCE 認証

   PKCE（Proof Key for Code Exchange）を使用した OAuth code タイプで認証するには、以下のプロパティを設定します。

   • AuthScheme: OAuthPKCE を指定します。
   • User: 認証ユーザーのユーザー ID を指定します。

   詳細については、ヘルプドキュメントをご参照ください。

   
   <configuration>
      ... <connectionStrings>
       <add name="LakebaseContext" connectionString="Offline=False;DatabricksInstance=lakebase;Server=127.0.0.1;Port=5432;Database=my_database;" providerName="System.Data.CData.Lakebase" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.Lakebase" type="System.Data.CData.Lakebase.LakebaseProviderServices, System.Data.CData.Lakebase.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

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

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

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

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

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

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

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

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