Entity Framework 6 からIBM Cloud Object Storage のデータに連携

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

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

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

   Cloud Object Storage 接続プロパティの取得・設定方法

   Cloud Object Storage に接続する前に、Cloud Object Storage インスタンスを登録してCloud Object Storage API キーとCRN を取得していきます。

   Cloud Object Storage の新規インスタンスの登録

   IBM Cloud アカウントにCloud Object Storage がまだない場合は、以下の手順に従ってアカウントにSQL Query のインスタンスをインストールできます。

   1. IBM Cloud アカウントにログインします。
   2. Cloud Object Storage ページに移動して、インスタンス名を指定して「作成」をクリックします。Cloud Object Storage の新規インスタンスにリダイレクトされます。

   API キー

   API キーは以下の手順で取得できます。

   1. まずは、IBM Cloud アカウントにログインします。
   2. API キーページに移動します。
   3. 中央右隅のIBM Cloud APIキーの作成 をクリックして、新しいAPI キーを作成します。
   4. ポップアップウィンドウが表示されたら、API キーの名前を指定して作成をクリックします。ダッシュボードからはアクセスできなくなるため、API Key を控えておきましょう。

   Cloud Object Storage CRN

   デフォルトでは、CData 製品はCloud Object Storage CRN を自動で取得します。ただし、複数のアカウントがある場合は、CloudObjectStorageCRN を明示的に指定する必要があります。この値は、次の2つの方法で取得できます。

   • Services ビューをクエリする。これにより、IBM Cloud Object Storage インスタンスとそれぞれのCRN がリストされます。
   • IBM Cloud で直接CRN を見つける。これを行うには、IBM Cloud のダッシュボードに移動します。リソースリストで、ストレージからCloud Object Storage リソースを選択してCRN を取得します。

   IBM Cloud Object Storage への接続

   これで準備は完了です。以下の接続プロパティを設定してください。

   • InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 認証を繰り返す必要がなく、さらに自動でアクセストークンを設定できます。
   • ApiKey：セットアップ中に控えたAPI キーを指定。
   • CloudObjectStorageCRN（オプション）：控えておいたCloud Object Storage のCRN に設定。Cloud Object Storage アカウントが複数ある場合のみ設定する必要があります。

   プロパティを設定したら、これで接続設定は完了です。

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