DBFluteプロパティについて

• 概要
• ファイルの仕様
• プロパティの形式
  • map型プロパティ
  • 値型プロパティ

概要

DBFluteプロパティとは、GenerateやReplaceSchemaなどの "DBFluteタスク" を実行する際に参照するプロパティのことです。DB種類・接続先情報などの必須のプロパティから、 ちょっとした挙動を変えるための非必須の微調整プロパティまで様々なプロパティがあります。

アプリケーションの実行時にこれらプロパティが参照されることはありません。 あくまで、自動生成などのDBFluteタスク実行時にのみ参照されるプロパティであり、プロパティだけを変更してアプリを実行してもその変更は反映されません。 (アプリの実行環境に影響するプロパティに関しては)変更後に再自動生成を行うことで反映されるようになります。

ファイルの仕様

DBFluteクライアントを作成した時点で、通常必要とされるDBFluteプロパティは全て用意されていますので、 利用するときは、既にあるファイルをエディタで開いて編集します。

配置場所

[DBFluteクライアント]/dfprop

拡張子

.dfprop ※テキストファイル

エンコーディング

UTF-8

エディタは、Eclipse上であれば "EMecha(Eclipse Plugin)" がお奨めです。

プロパティの形式

map型プロパティ

"...Map.dfprop" で終わるファイルに関しては、map型プロパティとなります。

e.g. map型プロパティのDBFluteプロパティ @basicInfoMap.dfprop
map:{
    ; database = h2
    ; targetLanguage = java
    ; targetContainer = seasar
    ...
}

多くのDBFluteプロパティがこの形式です。編集前に基本的な仕様は押さえておくと良いでしょう。

値型プロパティ

それ以外の(map型じゃない)DBFluteプロパティに関しては、"値型プロパティ" となります。 ファイルの中身がそのままそのプロパティの "定義値" として認識されます。但し、コメントの仕様に関してはmap型プロパティと同じです。

e.g. 値型プロパティのDBFluteプロパティ @allClassCopyright.dfprop
# /---------------------------------------------------------------------------
# allClassCopyright: (NotRequired - Default '')
# 
# The copyright for all classes.
# This property is NOT map style.
# You should specify before your first generating.
# 
/*
 * Copyright(c) DBFlute TestCo.,TestLtd. All Rights Reserved.
 */
# ----------------/

例えば、"allClassCopyright.dfprop" がこの形式のプロパティです(他にはほとんどありません)。

但し、一部例外があります。classificationResource.dfprop は、かなり特殊な形式のDBFluteプロパティで、map型でも値型でもないと言えます。