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

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

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

   Amazon Redshift への接続

   それでは、早速Amazon Redshift に接続していきましょう。データに接続するには、以下の接続パラメータを指定します。

   • Server：Amazon Redshift データベースをホスティングしているサーバーのホスト名またはIP アドレス
   • Database：Amazon Redshift クラスター用に作成したデータベース
   • Port（オプション）：Amazon Redshift データベースをホスティングしているサーバーのポート。デフォルトは5439です

   これらの値は、以下のステップでAWS マネージメントコンソールから取得できます。

   1. Amazon Redshift コンソールを開きます（http://console.aws.amazon.com/redshift）
   2. Clusters ページで、クラスター名をクリックしてください
   3. Configuration タブの"Cluster Database Properties" セクションからプロパティを取得します。接続プロパティの値は、ODBC URL で設定された値と同じになります

   Amazon Redshiftへの認証

   CData 製品では幅広い認証オプションに対応しています。標準認証情報からIAM クレデンシャル、ADFS、Ping Federate、Microsoft Entra ID（Azure AD）、Azure AD PKCE まで利用可能です。

   標準認証

   ログイン資格情報を使用してAmazon Redshift に接続するには、以下のプロパティを設定してみましょう。
   • AuthScheme：Basic
   • User：認証するユーザーのログイン情報
   • Password：認証するユーザーのパスワード

   その他の認証方法については、ヘルプドキュメントをご確認ください。

   
   <configuration>
      ... <connectionStrings>
       <add name="RedshiftContext" connectionString="Offline=False;User=admin;Password=admin;Database=dev;Server=examplecluster.my.us-west-2.redshift.amazonaws.com;Port=5439;" providerName="System.Data.CData.Redshift" />
     </connectionStrings>
     <entityFramework>
       <providers>
          ... <provider invariantName="System.Data.CData.Redshift" type="System.Data.CData.Redshift.RedshiftProviderServices, System.Data.CData.Redshift.Entities.EF6" />
       </providers>
     <entityFramework>
   </configuration>
   </code>
   

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

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

7. もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているRedshift のエンティティ、例えば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. コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例：

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