Entity Frameworkを使ってPostgreSQLにアクセスする方法

.NET開発者のためのブログメディア

ASP.NETのC#でデータベースを利用する場合、一般的にはSQL Serverを利用することが多いですが、個人で気軽に使いたい場合はPostgreSQLを利用することもあります。
この記事ではEntity Frameworkを使って、PostgreSQLにアクセスする方法を確認します。

SE: Entity Frameworkを使って、PostgreSQLにアクセスする方法を教えてください。

PM: PostgreSQL にアクセスするには専用のライブラリを使ってアクセスすることになります。一緒に内容を確認しましょう。

Entity FrameworkとPostgreSQLの概要

Entity Frameworkはデータベースにアクセスするプログラムを簡単に実装できる機能です。
データの取得や登録、更新、削除などの各種処理を複雑なSQL文を記載することなく、簡単に実装できます。

SQL文を記載する際はコード量が多くなってしまいがちですが、Entity Frameworkを使うことで、コード量を少なくできるというメリットがあります。

PostgreSQLは、オープンソースのデータベース管理システムです。
無料で利用できるため、個人でアプリケーションを開発する場合などに利用されています。商用利用でも多くの機能が使えるため、使いやすいデータベースです。

Entity Frameworkを使ってPostgreSQLにアクセスする手順

Visual Studioを利用すると、ライブラリが簡単にインストールできます。
ここでは、Visual Studio 2017を使用します。

ソリューションエクスプローラーでプロジェクトを右クリックし、NuGetパッケージ管理を選択します。
「EntityFramework6.Npgsql」で検索します。

EF検索

検索すると、対象のライブラリが表示されるのでインストールを行います。
合わせて必要なライブラリも表示されるので、一緒にインストールしてください。

インストールが完了すると、以下のようにインストール済みと表示されます。

EFインストール完了

Web.configに必要な設定を追記します。

ライブラリインストール時に必要な設定が追記されますが、一部手動で追加する必要があるので、以下のように追加します。

DBの接続文字列を以下のように記述します。

<connectionStrings>
   <add name="DefaultConnection" connectionString="Server=localhost;Port=5432;User Id=postgres;Password=[設定したパスワード];Database=public;" providerName="Npgsql" />
</connectionStrings>

</connectionStrings>

以下のように、Npgsqlの設定を記述します。

<system.data>
  <DbProviderFactories>
    <add name="Npgsql Data Provider" invariant="Npgsql" description=".Net Data Provider for PostgreSQL" type="Npgsql.NpgsqlFactory, Npgsql, Culture=neutral, PublicKeyToken=5d8b90d52f46fda7"/>
  </DbProviderFactories>
</system.data>

<system.data>

</DbProviderFactories>

</system.data>

Modelクラスを作成します。

以下のように、テーブルのカラムを指定します。
本記事では「Movie」というテーブル名で「id」と「name」というカラムを指定しています。

using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;

namespace WebApplication1.Models
{
    public class Movie
    {
        [Key]
        [DatabaseGenerated(DatabaseGeneratedOption.Identity)]
        public int Id { get; set; }

        public string Name { get; set; }
    }
}

using System.ComponentModel.DataAnnotations;

using System.ComponentModel.DataAnnotations.Schema;

namespace WebApplication1.Models

{

public class Movie

{

[Key]

[DatabaseGenerated(DatabaseGeneratedOption.Identity)]

public int Id { get; set; }

public string Name { get; set; }

}

DBコンテキストクラスを作成します。

以下のように、先ほど作成したModelクラスを指定します。

using System.Data.Entity;
using System.Security.Claims;
using System.Threading.Tasks;
using Microsoft.AspNet.Identity;
using Microsoft.AspNet.Identity.EntityFramework;

namespace WebApplication1.Models
{
    public class ApplicationDbContext : IdentityDbContext<ApplicationUser>
    {
        public ApplicationDbContext()
            : base("DefaultConnection", throwIfV1Schema: false)
        {
        }

        public static ApplicationDbContext Create()
        {
            return new ApplicationDbContext();
        }

       public DbSet<Movie> Movies { get; set; }
    }
}

using System.Data.Entity;

using System.Security.Claims;

using System.Threading.Tasks;

using Microsoft.AspNet.Identity;

using Microsoft.AspNet.Identity.EntityFramework;

namespace WebApplication1.Models

{

public class ApplicationDbContext : IdentityDbContext<ApplicationUser>

{

public ApplicationDbContext()

: base("DefaultConnection", throwIfV1Schema: false)

{

}

public static ApplicationDbContext Create()

{

return new ApplicationDbContext();

}

public DbSet<Movie> Movies { get; set; }

}

これで、Entity Frameworkを使用して、PostgreSQLにアクセスすることができます。

SE: Visual Studio を使用することで、ライブラリのインストールも簡単ですし、追加する設定も多くないので簡単に使えますね。

PM: Entity Frameworkはデータベースの種類問わず、簡単に使えるものなので、PostgreSQLも簡単に利用できました。

必要な機能はライブラリをインストールして使うだけ

PostgreSQLへのアクセスはライブラリが用意されています。
そのため、Visual Studio を利用してライブラリをインストールすることで、簡単に使い始めることができます。
利用するデータベースも問わないので、Entity FrameworkでPostgreSQLを使ってみてはいかがでしょうか。