PostgreSQL環境下では正常動作してたプログラムをMySql環境へ移行したところ例外「System.InvalidCastException」が発生する。それを解決したい。

Question

実現したいこと

以下の事を実現したい
１．DBをPostgreSQL 16.0からMySql8.0.36へ移行する。
２．EFCoreをNpgsql.EntityFrameworkCore.PostgreSQL8.0.2からMySql.EntityFrameworkCore8.0.0へ移行する。
３．Npgsql.EntityFrameworkCore.PostgreSQL8.0.2では、動作確認が取れている既存プログラムを動かしたい

発生している問題・分からないこと

該当ソース13行目のToList()メソッド実行時に例外「System.InvalidCastException」が発生する。

上記キャスト例外が発生している箇所と思われる関連情報

該当テーブル
CREATE TABLE `tr_user` (
	`user_id` BIGINT(19) NOT NULL AUTO_INCREMENT COMMENT 'ユーザID',
<中略>
	`birth_day` DATE NULL DEFAULT NULL COMMENT '生年月日',
<中略>
	`withdrawal_date` DATE NULL DEFAULT NULL COMMENT '退会日付',
<中略>
)
COMMENT='ユーザ情報'
COLLATE='utf8mb4_0900_ai_ci'
ENGINE=InnoDB
AUTO_INCREMENT=18
;

モデル

    public partial class TrUser
    {
        /// <summary>
        /// ユーザID
        /// </summary>
        public long UserId { get; set; }
        /// <summary>
<中略>
        /// 生年月日
        /// </summary>
        public DateOnly? BirthDay { get; set; }
<中略>
        /// <summary>
        /// 退会日付
        /// </summary>
        public DateOnly? WithdrawalDate { get; set; }
<中略>
    }

ＤＢコンテキスト

    public partial class XXXDbContext : DbContext
    {

<中略>
        protected override void OnModelCreating(ModelBuilder modelBuilder)
        {
<中略>
            modelBuilder.Entity<TrUser>(entity =>
            {
                entity.HasKey(e => e.UserId)
                    .HasName("pk_tr_user");

<中略>
                entity.Property(e => e.UserId)
                    .HasColumnName("user_id")
                    .HasComment("ユーザID")
                    .UseIdentityAlwaysColumn();

<中略>

                entity.Property(e => e.BirthDay)
                    .HasColumnName("birth_day")
                    .HasComment("生年月日");

<中略>
                entity.Property(e => e.WithdrawalDate)
                    .HasColumnName("withdrawal_date")
                    .HasComment("退会日付");

<中略>
            });
        }
    }

エラーメッセージ

Unable to cast object of type 'System.DateTime' to type 'System.DateOnly'.

該当のソースコード

        public List<TrUser> SelectByMailAddressOrUserCd(string MailAddress)
        {
            var result = new List<TrUser>();
            DbTask.ReadOnly(db =>
            {
                var userQuery = db.TrUsers.Where(_X => _X.UserCd == MailAddress).OrderBy(_X => _X.DeleteFlg);
                if (!userQuery.Any())
                {
                    userQuery = db.TrUsers.Where(_X => _X.MailAddress == MailAddress).OrderBy(_X => _X.DeleteFlg);
                }
                result = userQuery.ToList();
            });

            return result;
        }

試したこと・調べたこと

• teratailやGoogle等で検索した
• ソースコードを自分なりに変更した
• 知人に聞いた
• その他

上記の詳細・結果

類似の例外「System.InvalidCastException: Unable to cast object of type 'System.DateTime' to type 'System.DateTimeOffset'.」情報は見つけたが、開発環境.net5.0が古いのとCloseされていないので、参考にはならなかった。
[リンク内容]
https://github.com/VahidN/EFCoreSecondLevelCacheInterceptor/issues/131

.net6.0環境でのDateOnlyキャストエラーの記事についても試したが、駄目だった。
[リンク内容]
https://qiita.com/nacopon/items/10977d516e2a79b8dcc3

補足

言語：c#
開発環境：.net8.0 Entity Framework Core 8.0
データベース： MySql 8.0.36

Comments

[ikedas]

エラーメッセージは省略・抜粋・要約などせず、表示された内容全てを記してください (ちなみにこのコメント欄ではなく、質問文を編集して記してください)。

[sazi]

エラーが発生するのは移行後のデータによるものですか？
それとも、移行時に発生しているという事なのでしょうか？
エラーメッセージからは、DateTimeと認識されるデータのDateOnlyへのキャストをサポートしていないとも取れますので。

[kinkin334]

ikedasさん
コメントありがとうございます。
エラーメッセージでスタックトレースとかの情報を表示しなかったのは、ソースコードの秘匿性からです。
スタックトレースからはORマッパー（MySql.EntityFrameworkCore8.0.0）によるモデルの該当プロパティ格納時の型キャストへだと推測しています。
型キャストエラーに対処する方法を探しています。

[kinkin334]

saziさん
コメントありがとうございます。
>それとも、移行時に発生しているという事なのでしょうか？
「発生している問題」に記載していますが、該当プログラム実行時に発生しています。

EFCore6.0以降は各ライブラリdeveloperへのDateOnly型への対応が義務付けられているようです。postgresライブラリでは該当モデルへのデータ格納、ＤＢ更新は正常に行われるので、DateOnly型へ対応しています。
ライブラリ「MySql.EntityFrameworkCore8.0.0」のソースコードをGithubから入手して確認したのですが、DateOnly型対応しているように見受けられました。
しかし、ライブラリmysqlへを変更して実行すると該当箇所でキャストエラーが発生しています。
DateOnly型キャストエラーに対処する方法を探しています。

[ikedas]

ORMのコードが公知のものであるのなら、スタックトレースも (少なくとも質問者さんが独自に書いたコードの部分を除けば) 公表したところでさして問題とは思われません。

とにかく、現状ではORMの内部処理のどこかで型キャストに起因する問題が発生していることは確実と思われるので、その情報が提示されないと問題解決は難しくなりますね (絶対解決できないとは言えませんが)。

[sazi]

>>それとも、移行時に発生しているという事なのでしょうか？
>「発生している問題」に記載していますが、該当プログラム実行時に発生しています。
実行した時というのは、分かっています。
データを新規に追加したときや空の状態でも起きるのかというのが問です。
メッセージからは、時刻データが含まれたデータをキャストしようとして発生しているように見えますので、
移行したデータが、時刻を含む書式で移行されている事によるものなら、プログラムではなくデータの補正という事になるかもしれませんので。

[kinkin334]

ikedasさん

このスレッドを立てた意図は型キャストエラー「Unable to cast object of type 'System.DateTime' to type 'System.DateOnly'.」の回避の手がかりを持っているなら共有して欲しいと思ったからです。
公開できる範囲でスタックトレースを以下に公開しますが、特に原因を特定できそうな情報はありませんでした。ですから、公開する必要は無いと考えました。
場所 System.Data.Common.DbDataReader.GetFieldValue[T](Int32 ordinal)
場所 MySql.Data.MySqlClient.MySqlDataReader.GetFieldValue[T](Int32 ordinal)
場所 Microsoft.EntityFrameworkCore.Query.Internal.SingleQueryingEnumerable`1.Enumerator.MoveNext()
場所 System.Collections.Generic.List`1..ctor(IEnumerable`1 collection)
場所 System.Linq.Enumerable.ToList[TSource](IEnumerable`1 source)

[kinkin334]

saziさん

CREATE TABLE `tr_user`のスクリプトを見ていたいただければ「date型」とある通り、データには時刻は含まれていません。
ORマッパーのmysqlライブラリ内で何らかの理由により「Datetime型」誤認が発生し、モデルクラスの「DateOnly型」へ代入しようとして暗黙の型キャストにより例外が発生しているのではないかと推測しています。
ORマッパーがpostgresライブラリ且つDBがpostgresで対応するカラムがdate型の場合は、mysqlで例外が発生する場合と同じデータで正常動作しています。
これらの事象から、mysqlライブラリ内での「Datetime型」誤認の回避策があれば解決できるのではないかと考えています。

[sazi]

回避策の為の原因を探るために、実データがどうなのかを聞いているんですが。

[dodox86]

Entity Framework (Core)を使った.NET関連のプログラムでは、扱う人によっては実DBのテーブルのスキーマやカラムの属性を意識せずに作り続けてしまうことがあると思います。PostgreSQLのDB上の実テーブルからMySQLのDB上へはテーブル含めどのようにデータを移行したのでしょうか。C#プログラム本体のモデル上でキャスト云々の問題ではなく、EFで生成された移行元のPostgreSQL用のSQL、DbContextでは、MySQL用として使うには不整合が出ている気がします。

[sazi]

自己解決のコメントに
> 例外発生原因はEFCoreライブラリ「MySql.EntityFrameworkCore8.0.0」がDateOnly型に対応していない為でした。

とありますが、PostgresからMySQLへの移行時に型の変更をされたという事なのかが気になります。

Answer 1

自己解決しました

例外発生原因はEFCoreライブラリ「MySql.EntityFrameworkCore8.0.0」がDateOnly型に対応していない為でした。

同じ原因で嵌る人もいると思いますので、知見を共有します。

参考になるサイト
https://marcominerva.wordpress.com/2022/01/07/dateonly-and-timeonly-support-with-entity-framework-core-6-0/

以下のクラスを定義する

    public class DateOnlyConverter : ValueConverter<DateOnly, DateTime>
    {
        public DateOnlyConverter() : base(
                dateOnly => dateOnly.ToDateTime(TimeOnly.MinValue),
                dateTime => DateOnly.FromDateTime(dateTime)
            )
        {
        }
    }
    public class DateOnlyComparer : ValueComparer<DateOnly>
    {
        public DateOnlyComparer() : base(
                (d1, d2) => d1.DayNumber == d2.DayNumber,
                d => d.GetHashCode()
            )
        {
        }
    }

DbContext内の該当DateOnly型プロパティマッピングヵ所にHasConversionメソッドを記述する

                entity.Property(e => e.BirthDay)
                    .HasColumnName("birth_day")
                    .HasConversion<DateOnlyConverter, DateOnlyComparer>()
                    .HasComment("生年月日");

以上です

Comments

[sazi]

その記事は見つけていましたが、SQLServerの話であるし、文末にマイグレーションには対応していないとあります。
それで、先ずは移行後の話なのかを確認していたのです。

[kinkin-334]

saziさん
現象を誤認されていたようですが、DBカラムは同じdate型ままにmysqlへデータ移行した上でpostgres環境下では該当モデルのDeteOnly型で正常動作してたプログラムが、ライブラリをmysqlへ変更した途端に型キャスト例外が発生したというのが質問の経緯です

TimeOnly型も同様に未対応でしたので同様にSystem.InvalidCastExceptionが発生します。
該当記事のTimeOnlyConverter等の実装も必要だという事を共有します。

Answer 2

とりあえず省略されているところに記載がないならuser_idに最低でもuniqueインデックスを貼ってください。もし運用上問題ないなら主キー設定しても良いでしょう

`user_id` BIGINT(19) NOT NULL AUTO_INCREMENT COMMENT 'ユーザID',
↓↓↓
`user_id` BIGINT(19) NOT NULL PRIMARY KEY AUTO_INCREMENT COMMENT 'ユーザID',

Comments

[kinkin-334]

アドバイスありがとうございます。
主キーはuser_idへ設定済みです。

原因は特定でき、解決できました。

[yambejp]

＞主キーはuser_idへ設定済みです。

まぁ中略で重要な情報を削るからこういう行き違いが発生するんですけどね・・・