EF Core2で実行したSQLの引数をログに出力する

EntityFramework Coreで実行したクエリのログを出力する設定は以下の通りDbContextクラスのOnConfiguringをオーバーライドしてoptionsBuilder.EnableSensitiveDataLogging();を設定すればOKです。ただ、SensitiveDataLoggingというパラメーター名からも分かる通りログにパラメターが出力されることがNGなケースもあるのでそのへんは注意が必要ですね。

public class BeagleBaseContext : DbContext
 {
        protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
        {
            // この設定により引数のログが出力される
            optionsBuilder.EnableSensitiveDataLogging();
        }
}

出力されるログ

出力されるログは正直あまり使い勝手がいいログではありません。せめてJSONとかならParseし易いのですが、そのままだと以下のように出力されます。

[14:56:28 INF] Executed DbCommand (0ms) [Parameters=[@__get_Item_0='b0d0d15e-8d35-4cf0-afcf-ffe3580ba264' (Size = 36)], CommandType='Text', CommandTimeout='30']
SELECT "e"."id", "e"."application_id", "e"."building_name", "e"."celler_phone_no", "e"."city_name", "e"."code", "e"."contractor_id", "e"."created_at", "e"."display_flg", "e"."email", "e"."fax_no", "e"."location", "e"."name", "e"."name_kana", "e"."phone_no", "e"."pref_code", "e"."street_name", "e"."town_name", "e"."unit_name", "e"."url", "e"."zip_code", "e"."xmin"
FROM "organizations" AS "e"
WHERE "e"."id" = @__get_Item_0
LIMIT 1

おそらく出力処理をカスタマイズできると思いますが、調査してみないとですね。

参考

c# - Lost parameter value during SQL trace in EF Core - Stack Overflow

DbContextOptionsBuilder Class (Microsoft.EntityFrameworkCore) | Microsoft Docs

実戦で役立つ C#プログラミングのイディオム/定石&パターン

実戦で役立つ C#プログラミングのイディオム/定石&パターン

migrationのテーブル名や列名をLowerSnakeCaseに設定する

EF Coreを利用してCodeFirstでMigrationによりデータベースのテーブルを作成するときですが、テーブル名と列名がC#のプロパティ名となるため、デフォルトではUpperCamelCaseになります。

これを変更するにはテーブル名であれば{Table("table_name")、列名であれば[Column("column_name")]とそれぞれに設定することで対応可能です。

しかし、このようにアノテーションを設定することは結構面倒です。特にPostgreSQLを使用している場合には列名に大文字を使用するとハマりどころとなったりします。

お手軽に列名をLowerSnakeCaseに変換する

少し調べてみたところ、EF CoreのIssueに以下のようにContextクラスのOnModelCreatingで列名とテーブル名を変換する方法が紹介されていましたので試してみました。

namespace Some.Models
{
    public class SomeContext:DbContext
    {
        public DbSet<...

        protected override void OnModelCreating(ModelBuilder modelBuilder)
        {
            ...
            base.OnModelCreating(modelBuilder);

            FixSnakeCaseNames(modelBuilder);
        }

        private static void FixSnakeCaseNames(ModelBuilder modelBuilder)
        {
            var mapper = new Npgsql.NpgsqlSnakeCaseNameTranslator();

            foreach (var entity in modelBuilder.Model.GetEntityTypes())
            {
                // modify column names
                foreach (var property in entity.GetProperties())
                {
                    property.Relational().ColumnName = mapper.TranslateMemberName(property.Relational().ColumnName);
                }

                // modify table name
                entity.Relational().TableName = mapper.TranslateMemberName(entity.Relational().TableName);

                // move asp_net tables into schema 'identity'
                if (entity.Relational().TableName.StartsWith("asp_net_"))
                {
                    entity.Relational().TableName = entity.Relational().TableName.Replace("asp_net_", string.Empty);
                    entity.Relational().Schema = "identity";
                }
            }
        }
    }
}

結果としてはこれで問題なくテーブル名と列名がLowerSnaleCaseになりましたので感謝感謝です。

参考

pluggable schemes for mapping c# names · Issue #5159 · aspnet/EntityFrameworkCore

このところPostgreSQLへC#から接続することを色々と試しているせいでしょうが、Shay Rojanskyさんには本当にお世話になっています。大抵の問題について回答されていてShay Rojanskyの回答からいろいろな人がいろいろな方法を紹介されている事が多いのでとても感謝しています。

C#実践開発手法 (マイクロソフト公式解説書)

C#実践開発手法 (マイクロソフト公式解説書)

異なるプロジェクトにあるContextでMigrationを実行する

複数のプロジェクトで構成されたソリューションのうち、Startupプロジェクト以外でef migrationsを実行する場合には以下のようにDbContextを含むプロジェクトでマイグレーションコマンドを実行する必要があります。

SampleSln
  -- StartupProject
  -- RepositoryProject
       -- SomeDbContext

仮に上記のようなプロジェクト構成となっている場合には、以下の通りコマンドを実行します。 (RepositoryProjectのSomeDbContextが参照する接続先はStartupProjectに定義されていることとします。)

$ cd RepositoryProject

# Migrationファイルを作成する
$ dotnet ef migrations add AddHogeTable --context SomeDbContext -v --startup-project ../StartupProject

# Migrationをデータベースへ反映する
$ dotnet ef database update AddHogeTable --context SomeDbContext -v --startup-project ../StartupProject

参考

Migration in different assembly than target assembly not supported · Issue #5900 · aspnet/EntityFrameworkCore

C# 7.0 Pocket Reference: Instant Help for C# 7.0 Programmers

C# 7.0 Pocket Reference: Instant Help for C# 7.0 Programmers