【EF Core】コードファーストでPostgreSQLのDBを作成する【ASP.NET】

はじめに

C#、ASP.NET初心者です。
コードファーストでPostgreSQLのDB構築を行う方法をまとめました。

コードファーストとは「項目を定義したクラスからDBを自動生成するEntity Frameworkの機能」です。
便利なのですが、C#の命名規則（パスカルケース）に合わせてクラスを作成すると、そのままテーブル名・カラム名になります。
過去に 公式のMovieチュートリアル をもとに作成したのがこちらです。

PostgreSQLでは、SQL発行時ダブルクォーテーションで囲っていないものは小文字に変換されるため、スネークケースで命名するのが望ましいです。
特にこだわりがなければSQL Serverを使用するのがいいのかもしれませんが、現場で使用しているPostgreSQLに慣れたい思いからいろいろ方法を調べ試行錯誤しました。

前提

• Visual Studioがインストールされていること
• PostgreSQLがインストールされていること

プロジェクトの作成

今までは.NET6.0でやっていたのですが、今回は.NET7.0でやってみます。
Model-View-Controller(MVC)を選択します。

私のVisual Studioは.NET6.0しか選べなかったので.NET7.0をインストールしました。
（.net7.0のインストール手順 を参考にしました。）

NuGetパッケージの追加

PostgreSQL で Movie チュートリアル (CORE) を参考に以下をインストールしました。
SqlServerはスキャフォールディングで必要になる場合があるそうです。

※.NETのバージョンアップをした場合、Visual Studioのアップデートを行っていないとエラーが出る場合があるのでご注意ください。

モデルの作成

モデル（エンティティクラス）を作成します。
今回はEntity Framework Coreのチュートリアルであるこちらをもとに作成します。

テーブル名には [Table("テーブル名")]、カラム名には[Column("カラム名")] とスネークケースで書きます。
※チュートリアルと違うプロジェクト名で作成してしまったためご注意ください

Student.cs

using System.ComponentModel.DataAnnotations.Schema;

namespace DotnetPractice.Models
{
    [Table("student")]
    public class Student
    {
        [Column("id")]
        public int ID { get; set; }

        [Column("last_name")]
        public string LastName { get; set; }

        [Column("first_mid_name")]
        public string FirstMidName { get; set; }

        [Column("enrollment_date")]
        public DateTime EnrollmentDate { get; set; }

        public ICollection<Enrollment> Enrollments { get; set; }
    }
}

Enrollment.cs

using System.ComponentModel.DataAnnotations.Schema;

namespace DotnetPractice.Models
{
    
    public enum Grade
    {
        A, B, C, D, F
    }

    [Table("enrollment")]
    public class Enrollment
    {
        [Column("enrollment_id")]
        public int EnrollmentID { get; set; }

        [Column("course_id")]
        public int CourseID { get; set; }

        [Column("student_id")]
        public int StudentID { get; set; }

        [Column("grade")]
        public Grade? Grade { get; set; }

        public Course Course { get; set; }
        public Student Student { get; set; }
    }
}

Course.cs

using System.ComponentModel.DataAnnotations.Schema;

namespace DotnetPractice.Models
{
    [Table("course")]
    public class Course
    {
        [Column("course_id")]
        [DatabaseGenerated(DatabaseGeneratedOption.None)]
        public int CourseID { get; set; }

        [Column("title")]
        public string Title { get; set; }

        [Column("credits")]
        public int Credits { get; set; }

        public ICollection<Enrollment> Enrollments { get; set; }
    }
}

スキャフォールディング

チュートリアルと手順は違いますが、ここでスキャフォールディングを行います。
（こちらの手順を参考）
作成したモデルそれぞれについて、スキャフォールディングを行います。
Studentクラスで行った例が以下です。
①Controllersフォルダを右クリック→「追加」→「新規スキャフォールディングアイテム」を選択
②「Entity Framework を使用したビューがある MVC コントローラー」を選択
③モデルクラス：作成したいモデルを選択
　Dbcontext：デフォルトだとプロジェクト名＋Contextになるようです。任意の名前にしたい場合は、チュートリアルを参考に先に作成するとよさそうです。
　データベースプロバイダー：PostgreSQLはないですがSQL Serverで問題ないです。

これでControllerやViewが自動生成されます。
残りのEnrollment、Courseクラスも同様に行います。

Dataフォルダに「プロジェクト名＋Context.cs」が自動生成されています。

DotnetPracticeContext.cs

using Microsoft.EntityFrameworkCore;

namespace DotnetPractice.Data
{
    public class DotnetPracticeContext : DbContext
    {
        public DotnetPracticeContext (DbContextOptions<DotnetPracticeContext> options)
            : base(options)
        {
        }

        public DbSet<DotnetPractice.Models.Student> Student { get; set; } = default!;

        public DbSet<DotnetPractice.Models.Enrollment> Enrollment { get; set; } = default!;

        public DbSet<DotnetPractice.Models.Course> Course { get; set; } = default!;

    }
}

PostgreSQLに合わせた修正

【Program.cs】
チュートリアルには「Startup.cs」とありますが、.NET6.0以降はありませんので「Program.cs」になります。
「var builder = WebApplication.CreateBuilder(args);」の下にコードが追加されています。
PostgreSQLの場合、「UseSqlServer」を「UseNpgsql」に書き換える必要があります。

Program.cs

using Microsoft.EntityFrameworkCore;
using DotnetPractice.Data;

var builder = WebApplication.CreateBuilder(args);
// 以下を修正
builder.Services.AddDbContext<DotnetPracticeContext>(options =>
    options.UseNpgsql(builder.Configuration.GetConnectionString("DotnetPracticeContext") ?? throw new InvalidOperationException("Connection string 'DotnetPracticeContext' not found.")));

// 以下略

【appsettings.json】
ConnectionStringsが追加されています。
以下がPostgreSQL用に書き換えたものです。「XXXXXXXX」に接続したいPostgreSQLのユーザ名とパスワードを入れてください。
Databaseは小文字で入力してください。ここに記載したものがそのままDB名になります。

appsettings.json

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*",
　// 以下を修正
  "ConnectionStrings": {
    "DotnetPracticeContext": "Server=localhost;Port=5432;Database=practice;Username=XXXXXXXX;Password=XXXXXXXX"
  }
}

Migrationの実行

ソリューションをリビルドしてエラーがないことを確認してから、Visual Studio のパッケージマネージャーコンソールで「Add-Migration InitialCreate」コマンドを実行します。
InitialCreateクラスがMigrationsフォルダに自動生成されます。

その後「Update-Database」コマンドを実行すると、DBが作成されます。
DB名・テーブル名・カラム名はスネークケースで作成できました。

しかしPKやFK名は大文字が含まれているので、Migrationで作成されたInitialCreateクラスを修正してから「Update-Database」コマンドを実行すれば反映されるんですかね。
（そこまでこだわってなかったので後で気づきました。。）

最後に

なかなか情報が見つけられなくて探すのに苦労しました。
Entity Framework Coreはいろいろなアノテーションがあってもっと勉強してみたいです。
SQL Serverも使ったことがないのでいずれ使ってみたいと思います。