各製品の資料を入手。
詳細はこちら →
Entity Framework 6 からCouchDB のデータに連携
この記事は、Entity Framework のcode-first アプローチを使って、CouchDB に接続する方法を説明します。Entity Framework 6 は.NET 4.5 以上で利用可能です。
最終更新日：2022-04-04
この記事で実現できるCouchDB 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Entity Framework はobject-relational mapping フレームワークで、データをオブジェクトとして扱うために使われます。Visual Studio のADO.NET Entity Data Model ウィザードを実行するとEntity Model を作成できますが、このモデルファーストアプローチでは、データソースに変更があった場合やエンティティ操作をより制御したい場合は不都合があります。この記事では、CData ADO.NET Provider を使いコードファーストアプローチでCouchDB にアクセスします。
- Visual Studio を起動し、新しいWindows Form アプリケーションを作成します。ここでは、.NET 4.5 のC# プロジェクトを使います。
- Visual Studio の ［パッケージ マネージャー コンソール］から'Install-Package EntityFramework' コマンドを実行し、最新のEntity Framework をインストールします。
- プロジェクトのApp.config ファイルを修正して、CouchDB Entity Framework 6 アセンブリおよびコネクションストリングへの参照を追加します。
Apache CouchDB 接続プロパティの取得・設定方法
Url 接続プロパティをApache CouchDB インスタンスのURL に設定します。例：http://localhost:5984
ユーザー（またはJWT）が特定のデータベースだけにアクセスできるようにしたい場合は、Apache CouchDB インスタンスで"admin_only_all_dbs" オプションを設定し、テーブルをリストするために本製品が必要とする"/_all_dbs" エンドポイントへのアクセス権をすべてのユーザーに付与する必要があります。
Apache CouchDB への認証
3種類の認証をサポートします。- Basic：基本的なユーザー名 / パスワード認証。
- JWT：JWT 認証。
- None：パブリックなデータベースへの匿名アクセス。
Basic 認証
データに接続するには以下を設定します。
- AuthScheme：Basic。
- User：認証に使用されるApache CouchDB ユーザーアカウント。
- Password：認証するユーザーに関連付けられたApache CouchDB パスワード。
その他の認証方法は、ヘルプドキュメント の「接続の確立」セクションを参照してください。
<configuration> ... <connectionStrings> <add name="ApacheCouchDBContext" connectionString="Offline=False;Url=http://localhost:5984;User=abc123;Password=abcdef;" providerName="System.Data.CData.ApacheCouchDB" /> </connectionStrings> <entityFramework> <providers> ... <provider invariantName="System.Data.CData.ApacheCouchDB" type="System.Data.CData.ApacheCouchDB.ApacheCouchDBProviderServices, System.Data.CData.ApacheCouchDB.Entities.EF6" /> </providers> <entityFramework> </configuration> </code> - インストールディレクトリの［lib］ > 4.0 サブフォルダにあるSystem.Data.CData.ApacheCouchDB.Entities.EF6.dll を設定し、プロジェクトを作成してEntity Framework 6 を使うためのセットアップを完了します。
- この時点でプロジェクトを作成し、すべてが正しく動作していることを確認してください。これで、Entity Framework を使ってコーディングを開始できます。
- プロジェクトに新しい.cs ファイルを追加し、そこにクラスを追加します。これがデータベースのコンテキストとなり、DbContext クラスを拡張します。この例では、クラス名はApacheCouchDBContext です。以下のサンプルコードは、OnModelCreating メソッドをオーバーライドして次の変更を加えます：
- PluralizingTableNameConvention をModelBuilder Conventions から削除。
- MigrationHistory テーブルへのリクエストを削除。
using System.Data.Entity; using System.Data.Entity.Infrastructure; using System.Data.Entity.ModelConfiguration.Conventions; class ApacheCouchDBContext :DbContext { public ApacheCouchDBContext() { } protected override void OnModelCreating(DbModelBuilder modelBuilder) { // To remove the requests to the Migration History table Database.SetInitializer<ApacheCouchDBContext>(null); // To remove the plural names modelBuilder.Conventions.Remove<PluralizingTableNameConvention>(); } } - もう一つ.cs ファイルを作成し、ファイル名を呼び出そうとしているCouchDB のエンティティ、例えばMovies にします。このファイルでは、エンティティとエンティティ設定の両方を定義します。以下に例を示します。
using System.Data.Entity.ModelConfiguration; using System.ComponentModel.DataAnnotations.Schema; public class Movies { [DatabaseGeneratedAttribute(DatabaseGeneratedOption.Identity)] public System.String Id { get; set; } public System.String MovieRuntime { get; set; } } public class MoviesMap :EntityTypeConfiguration<Movies> { public MoviesMap() { this.ToTable("Movies"); this.HasKey(Movies => Movies.Id); this.Property(Movies => Movies.MovieRuntime); } } - エンティティの作成が済んだので、コンテキストクラスにエンティティを追加します：
public DbSet<Movies> Movies { set; get; } - コンテキストとエンティティの作成が完了したら、別クラスでデータをクエリできます。例：
ApacheCouchDBContext context = new ApacheCouchDBContext(); context.Configuration.UseDatabaseNullSemantics = true; var query = from line in context.Movies select line;
関連コンテンツ
