Doma 3でJava 11のRaw String Literalsに対応するとしたら

raw-string-literals-4.md

sql 要素に SQL の取得元を enum で指定する案

Raw String Literals に対応した場合、SQL取得は内部文字列、外部ファイル、自動生成の３モードとなる。   sql 要素に enum で STRING, FILE, AUTO の３モードいずれかを指定するようにする。デフォルトは、STRING

Select の場合

SQLはアノテーションから読む

@Select(sql = STRING, value = `select * from emp`)
Emp select();

エイリアスとして

@Select(`select * from emp`)
Emp select();

SQLはファイルから読む

@Select(sql = FILE)
Emp select();

@Select で sql=AUTO を指定した場合

コンパイルエラー(SelectにSQL自動生成がないため)

@Select(sql = AUTO)
Emp select();

またはエラーにせず、Select のSQL自動生成(ユニークキー指定の1件検索のみ)をサポートする

@Select(sql = AUTO)
Emp select(Integer id);

メソッド引数名は、エンティティのフィールド名に存在するものである必要がある。
生成されるSQLは、

select /*%expand*/* from emp where id = /* id */1

これが実装されるとアノテーションの組み合わせによりコンパイルエラーにするパターンがなくなる。

Insert の場合

SQLはアノテーションから読む

@Insert(sql = STRING, value = `insert into ...`)
int insert(Emp e);

エイリアスとして

@Insert(`insert into ...`)
int insert(Emp e);

SQLはファイルから読む

@Insert(sql = FILE)
int insert(Emp e);

SQLは自動で組み立てる

@Insert(sql = AUTO)
int insert(Emp e);