Skip to content

Commit 6a15c1f

Browse files
committed
ネーミング規約の制御についてドキュメントを記述しました
1 parent 8d03e94 commit 6a15c1f

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

docs/sources/config.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,29 @@ REQUIRES_NEW 属性のトランザクションとの連動
142142

143143
デフォルトでは、 ``UnknownColumnException`` がスローされます。
144144

145+
テーブルやカラムにおけるネーミング規約の制御
146+
--------------------------------------------
147+
148+
``Naming`` を ``getNaming`` メソッドで返してください。
149+
150+
``Naming`` は、 ``@Entity`` の ``name`` 要素に指定された(もしくは指定されない) ``NamingType``
151+
をどのように適用するかについて制御するインタフェースです。
152+
このインタフェースを使うことで、個別のエンティティクラスに ``NamingType`` を指定しなくても
153+
エンティティのクラス名とプロパティ名からデータベースのテーブル名とカラム名を解決できます。
154+
155+
``Naming`` が使用される条件は以下の通りです。
156+
157+
* ``@Table`` や ``@Column`` の ``name`` 要素に値が指定されていない。
158+
159+
一般的なユースケースを実現するための実装は、 ``Naming`` の ``static`` なメンバに定義されています。
160+
161+
デフォルトでは、 ``Naming.NONE`` が使用されます。
162+
この実装は、エンティティクラスに指定された ``NamingType`` を使い、
163+
指定がない場合は何の規約も適用しません。
164+
165+
例えば、指定がない場合にスネークケースの大文字を適用したいというケースでは、
166+
``Naming.SNAKE_UPPER_CASE`` を使用できます。
167+
145168
マップのキーのネーミング規約の制御
146169
----------------------------------
147170

0 commit comments

Comments
 (0)