Entity Framework 6 からCosmos DB データに連携

詳細情報をご希望ですか?

無償トライアル:

ダウンロードへ

製品の詳細情報へ:

Cosmos DB ADO.NET Provider

Cosmos DB ドキュメントデータベース連携のパワフルな.NET アプリケーションを素早く作成して配布。



この記事は、Entity Framework のcode-first アプローチを使って、Cosmos DB に接続する方法を説明します。Entity Framework 6 は.NET 4.5 以上で利用可能です。



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

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

    SQL API を使ってCosmos DB アカウントに接続するために必要な接続文字列を取得するには、Azure Portal にログインして[Azure Cosmos DB]を選択し、自分のアカウントを選択します。[Settings]セクションで、[Connection String]をクリックして次の値を設定します。

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