About

ドキュメント

Javadoc

モジュール

プロジェクト文書

Built by Maven

タスクの一覧

S2JDBC-Genでは以下のタスクを提供します。

コアタスク

タスク名 説明
GenerateEntityTask データベースのテーブルからエンティティクラスのJavaコードを生成するタスクです。
GenerateDdlTask エンティティクラスからバージョン管理されたDDLを生成するタスクです。
MigrateTask バージョン管理されたDDLを使いデータベーススキーマのマイグレーションを実行するタスクです。

オプションタスク

タスク名 説明
GenerateTestTask エンティティクラスからテストクラスのJavaコードを生成するタスクです。テストクラスではエンティティを使って実際にデータベースアクセスを行います。
GenerateConditionTask エンティティクラスから条件クラスのJavaコードを生成するタスクです。条件クラスを使用すると、S2JDBCを使った問い合わせをタイプセーフにすることができます。
GenerateNamesTask エンティティクラスから名前インタフェースのJavaコードを生成するクラスです。名前インタフェースはエンティティのプロパティ名を定数としてもつインタフェースです。この定数を使用することで、結合先のプロパティや検索条件のプロパティをタイプセーフで指定できます。
GenerateServiceTask エンティティクラスからサービスクラスのJavaコードを生成するクラスです。サービスクラスはエンティティの問い合わせを簡略化するメソッドを提供します。

ユーティリティタスク

タスク名 説明
DumpDbMetaTask テーブルやカラムのメタデータをダンプするタスクです。主にS2JDBC-Genの開発者が利用することを想定しています。
DumpDataTask データベースのデータをCSV形式でダンプするタスクです。ダンプの機能はGenerateDdlTaskに含まれていますが、GenerateDdlTaskとは別にダンプを行いたい場合に使用できます。
LoadDataTask CSV形式のダンプファイルをロードするタスクです。ロードの機能はMigrateTaskに含まれていますが、MigrateTaskとは別にロードを行いたい場合に使用できます。
ExecuteSqlTask SQLファイルに含まれた任意のSQLを実行するタスクです。

DumpDataTask

説明

データベースのデータをCSV形式でダンプ出力します。ダンプの対象となるのはエンティティに対応するテーブルです。

このタスクを実行するにはエンティティクラスが1つ以上存在している必要があります。

接続先のデータベースはJdbcManagerのコンポーネント名によって決まります。

パラメータ

属性 説明 デフォルト値 必須
classpathDir エンティティクラスを含むクラスパスのディレクトリです。このディレクトリはタスクの実行時のクラスパスに含まれている必要があります。 - YES
rootPackageName ルートパッケージ名です。 "" NO
entityPackageName エンティティクラスのパッケージ名です。エンティティクラスは、rootPackageNameとこの値をピリオドで連結したパッケージに配置されているとみなされます。 "entity" NO
entityNamePattern このタスクで対象とするエンティティ名の正規表現です。 ".*" NO
ignoreEntityNamePattern このタスクで対象としないエンティティ名の正規表現です。 "" NO
dumpDir ダンプファイルを出力するディレクトリです。 "db/dump" NO
dumpFileEncoding ダンプファイルのエンコーディングです。 "UTF-8" NO
genDialectClassName S2JDBC-Genのダイアレクトインタフェースの実装クラス名です。ここに指定するクラスはorg.seasar.extension.jdbc.gen.dialect.GenDialectインタフェースを実装している必要があります。指定しない場合はS2JDBCのダイアレクト に対応したデフォルトのクラスが使用されます。 - NO
configPath JdbcManagerのコンポーネント定義を含む設定ファイルです。 "s2jdbc.dicon" NO
env 環境名です。 "ut" NO
jdbcManagerName JdbcManagerのコンポーネント名です。 "jdbcManager" NO
factoryClassName S2JDBC-Genの公開されたインタフェースの実装を作成するファクトリのクラス名です。S2JDBC-Genをカスタマイズする場合に独自のファクトリクラスを指定できます。ここに指定するクラスはorg.seasar.extension.jdbc.gen.internal.factory.Factoryインタフェースを実装している必要があります。 "org.seasar.extension.jdbc.gen.internal.factory.FactoryImpl" NO
classpath このタスクを実行する際のクラスパスです。 - classpathrefが指定されていない場合YES
classpathref このタスクを実行する際のクラスパスの参照です。 - classpathが指定されていない場合YES

ネストした要素として指定されるパラメータ

jvmArg

このタスクの大部分の処理は別VMで行われます。VMに引数を渡す場合は<jvmarg>要素を使用します。 これはAntのJavaタスクで使用できる<jvmarg>と同じです。 使用可能な属性やネストした要素についてはAntのドキュメントを参照してください。

   <dump-data
      classpathDir="build/classes"
      rootPackageName="examples"
      classpathref="classpath"
   />

ルートパッケージに"examples"を設定してタスクを実行します。

DumpDbMetaTask

説明

データベースのテーブルとカラムのメタデータを出力します。

接続先のデータベースはJdbcManagerのコンポーネント名によって決まります。

パラメータ

属性 説明 デフォルト値 必須
schemaName このタスクが対象とするスキーマ名です。 - NO
tableNamePattern このタスクが対象とするテーブル名の正規表現です。 ".*" NO
ignoreTableNamePattern このタスクが対象としないこのタスクが対象としないテーブル名の正規表現です。 ".*\$.*" NO
genDialectClassName S2JDBC-Genのダイアレクトインタフェースの実装クラス名です。ここに指定するクラスはorg.seasar.extension.jdbc.gen.dialect.GenDialectインタフェースを実装している必要があります。指定しない場合はS2JDBCのダイアレクト に対応したデフォルトのクラスが使用されます。 - NO
configPath JdbcManagerのコンポーネント定義を含む設定ファイルです。 "s2jdbc.dicon" NO
env 環境名です。 "ut" NO
jdbcManagerName JdbcManagerのコンポーネント名です。 "jdbcManager" NO
factoryClassName S2JDBC-Genの公開されたインタフェースの実装を作成するファクトリのクラス名です。S2JDBC-Genをカスタマイズする場合に独自のファクトリクラスを指定できます。ここに指定するクラスはorg.seasar.extension.jdbc.gen.internal.factory.Factoryインタフェースを実装している必要があります。 "org.seasar.extension.jdbc.gen.internal.factory.FactoryImpl" NO
classpath このタスクを実行する際のクラスパスです。 - classpathrefが指定されていない場合YES
classpathref このタスクを実行する際のクラスパスの参照です。 - classpathが指定されていない場合YES

ネストした要素として指定されるパラメータ

jvmArg

このタスクの大部分の処理は別VMで行われます。VMに引数を渡す場合は<jvmarg>要素を使用します。 これはAntのJavaタスクで使用できる<jvmarg>と同じです。 使用可能な属性やネストした要素についてはAntのドキュメントを参照してください。

   <dump-db-meta
      classpathDir="build/classes"
      schema="PUBLIC"
      classpathref="classpath"
   />

"PUBLIC"というスキーマを指定してタスクを実行します。

ExecuteSqlTask

説明

指定されたファイルに含まれる任意のSQLを実行します。

接続先のデータベースはJdbcManagerのコンポーネント名によって決まります。

パラメータ

属性 説明 デフォルト値 必須
sqlFileEncoding SQLファイルのエンコーディングです。 "UTF-8" NO
statementDelimiter SQLステートメントの区切り文字です。 ";" NO
blockDelimiter SQLブロックの区切り文字です。指定しない場合は、データベースのデフォルトの区切り文字が使用されます。たとえば、SQL Serverでは"go"、Oralce Databaseでは"/"、MySQLでは"/"、DB2では"@"が使用されます。 - NO
haltOnError "true"の場合、SQLの実行が失敗すると即座にエラーを返します。 "true" NO
transactional "true"の場合、単一のトランザクションとして実行します。 "false" NO
genDialectClassName S2JDBC-Genのダイアレクトインタフェースの実装クラス名です。ここに指定するクラスはorg.seasar.extension.jdbc.gen.dialect.GenDialectインタフェースを実装している必要があります。指定しない場合はS2JDBCのダイアレクト に対応したデフォルトのクラスが使用されます。 - NO
configPath JdbcManagerのコンポーネント定義を含む設定ファイルです。 "s2jdbc.dicon" NO
env 環境名です。 "ut" NO
jdbcManagerName JdbcManagerのコンポーネント名です。 "jdbcManager" NO
factoryClassName S2JDBC-Genの公開されたインタフェースの実装を作成するファクトリのクラス名です。S2JDBC-Genをカスタマイズする場合に独自のファクトリクラスを指定できます。ここに指定するクラスはorg.seasar.extension.jdbc.gen.internal.factory.Factoryインタフェースを実装している必要があります。 "org.seasar.extension.jdbc.gen.internal.factory.FactoryImpl" NO
classpath このタスクを実行する際のクラスパスです。 - classpathrefが指定されていない場合YES
classpathref このタスクを実行する際のクラスパスの参照です。 - classpathが指定されていない場合YES

ネストした要素として指定されるパラメータ

sqlFileList

SQLファイルを指定するためには、<sqlFileList>要素を使用します。 この要素はひとつ以上の指定が必須です。

<sqlFileList>はAntの<filelist>と同じデータ型です。 使用可能な属性やネストした要素についてはAntのドキュメントを参照してください。

jvmArg

このタスクの大部分の処理は別VMで行われます。VMに引数を渡す場合は<jvmarg>要素を使用します。 これはAntのJavaタスクで使用できる<jvmarg>と同じです。 使用可能な属性やネストした要素についてはAntのドキュメントを参照してください。

    <exe-sql
      transactional="true"
      classpathref="classpath">
        <sqlFileList dir="sql">
          <file name="aaa.sql"/>
          <file name="bbb.sql"/>
          <file name="ccc.sql"/>
        </sqlFileList>
    </exe-sql>

3つのSQLファイルを同一トランザクション内で実行します。

GenerateConditionTask

説明

条件クラスを生成します。

このタスクを実行するにはエンティティクラスが1つ以上存在している必要があります。

パラメータ

属性 説明 デフォルト値 必須
classpathDir エンティティクラスを含むクラスパスのディレクトリです。このディレクトリはタスクの実行時のクラスパスに含まれている必要があります。 - YES
rootPackageName ルートパッケージ名です。 "" NO
entityPackageName エンティティクラスのパッケージ名です。エンティティクラスは、rootPackageNameとこの値をピリオドで連結したパッケージに配置されているとみなされます。 "entity" NO
entityNamePattern このタスクで対象とするエンティティ名の正規表現です。 ".*" NO
ignoreEntityNamePattern このタスクで対象としないエンティティ名の正規表現です。 "" NO
conditionPackageName 条件クラ条件クラスのパッケージ名です。条件クラスは、rootPackageNameとこの値をピリオドで連結したパッケージに配置されます。 "condition" NO
conditionClassNameSuffix 条件クラス名のサフィックスです。 "Condition" NO
conditionTemplateFileName 条件クラスのテンプレートファイル名です。 "java/condition.ftl" NO
templateFileEncoding テンプレートファイルのエンコーディングです。 "UTF-8" NO
temptemplateFilePrimaryDir テンプレートファイルを検索する際の優先ディレクトリです。 - NO
javaFileDestDir Javaファイルの出力先ディレクトリです。 "src/main/java" NO
javaFileEncoding Javaファイルのエンコーディングです。 "UTF-8" NO
overwrite "true"の場合、条件クラスのJavaファイルを上書きします。 "true" NO
configPath JdbcManagerのコンポーネント定義を含む設定ファイルです。 "s2jdbc.dicon" NO
env 環境名です。 "ut" NO
jdbcManagerName JdbcManagerのコンポーネント名です。接続先のデータベースはJdbcManagerのコンポーネント名によって決まります。 "jdbcManager" NO
factoryClassName S2JDBC-Genの公開されたインタフェースの実装を作成するファクトリのクラス名です。S2JDBC-Genをカスタマイズする場合に独自のファクトリクラスを指定できます。ここに指定するクラスはorg.seasar.extension.jdbc.gen.internal.factory.Factoryインタフェースを実装している必要があります。 "org.seasar.extension.jdbc.gen.internal.factory.FactoryImpl" NO
classpath このタスクを実行する際のクラスパスです。 - classpathrefが指定されていない場合YES
classpathref このタスクを実行する際のクラスパスの参照です。 - classpathが指定されていない場合YES

ネストした要素として指定されるパラメータ

jvmArg

このタスクの大部分の処理は別VMで行われます。VMに引数を渡す場合は<jvmarg>要素を使用します。 これはAntのJavaタスクで使用できる<jvmarg>と同じです。 使用可能な属性やネストした要素についてはAntのドキュメントを参照してください。

    <gen-condition
      classpathDir="build/classes"
      rootPackageName="examples"
      classpathref="classpath"
   />

"examples"というルートパッケージを指定してタスクを実行します。

GenerateDdlTask

説明

DDLを生成します。

このタスクを実行するにはエンティティクラスが1つ以上存在している必要があります。

パラメータ

属性 説明 デフォルト値 必須
classpathDir エンティティクラスを含むクラスパスのディレクトリです。このディレクトリはタスクの実行時のクラスパスに含まれている必要があります。 - YES
rootPackageName ルートパッケージ名です。 "" NO
entityPackageName エンティティクラスのパッケージ名です。エンティティクラスは、rootPackageNameとこの値をピリオドで連結したパッケージに配置されているとみなされます。 "entity" NO
entityNamePattern このタスクで対象とするエンティティ名の正規表現です。 ".*" NO
ignoreEntityNamePattern このタスクで対象としないエンティティ名の正規表現です。 "" NO
createTableDdlFileName テーブルを作成するDDLファイル名です。 "010-create-table.sql" NO
createUniqueKeyDdlFileName 一意キーを作成するDDLファイル名です。 "020-create-uniquekey.sql" NO
createSequenceDdlFileName シーケンスを作成するDDLファイル名です。 "030-create-sequence.sql" NO
createForeignKeyDdlFileName 外部キーを作成するDDLファイル名です。 "050-create-foreignkey.sql" NO
dropTableDdlFileName テーブルを削除するDDLファイル名です。 "040-drop-table.sql" NO
dropUniqueKeyDdlFileName 一意キーを削除するDDLファイル名です。 "030-drop-uniquekey.sql" NO
dropSequenceDdlFileName シーケンスを削除するDDLファイル名です。 "020-drop-sequence.sql" NO
dropForeignKeyDdlFileName 外部キーを削除するDDLファイル名です。 "010-drop-foreignkey.sql" NO
ddlFileEncoding DDLファイルのエンコーディングです。 "UTF-8" NO
sqlKeywordCase SQLのキーワードを大文字にするか小文字にするかを指定する列挙型の値です。大文字にするには"uppercase"、小文字にするには"lowercase"を指定します。テンプレートに記述された文字をそのまま使用する場合は"originalcase"を指定します。 "originalcase" NO
sqlIdentifierCase SQLの識別子を大文字にするか小文字にするかを指定する列挙型の値です。大文字にするには"uppercase"、小文字にするには"lowercase"を指定します。エンティティに記述した文字をそのまま使用する場合は"originalcase"を指定します。 "originalcase" NO
dump "true"の場合、データベースのデータのダンプ出力を行います。 "true" NO
dumpDirName ダンプファイルの出力先のディレクトリです。 "040-dump" NO
dumpFileEncoding ダンプファイルのエンコーディングです。 "UTF-8" NO
createTableTemplateFileName テーブルを作成するDDLのテンプレートファイル名です。 "sql/create-table.ftl" NO
createUniqueKeyTemplateFileName 一意キーを作成するDDLのテンプレートファイル名です。 "sql/create-uniquekey.ftl" NO
createSequenceTemplateFileName シーケンスを作成するDDLのテンプレートファイル名です。 "sql/create-sequence.ftl" NO
createForeignKeyTemplateFileName 外部キーを作成するDDLのテンプレートファイル名です。 "sql/create-foreignkey.ftl" NO
dropTableTemplateFileName テーブルを削除するDDLのテンプレートファイル名です。 "sql/drop-table.ftl" NO
dropUniqueKeyTemplateFileName 一意キーを削除するDDLのテンプレートファイル名です。 "sql/drop-uniquekey.ftl" NO
dropSequenceTemplateFileName シーケンスを削除するDDLのテンプレートファイル名です。 "sql/drop-sequence.ftl" NO
dropForeignKeyTemplateFileName 外部キーを削除するDDLのテンプレートファイル名です。 "sql/drop-foreignkey.ftl" NO
templateFileEncoding テンプレートファイルのエンコーディングです。 "UTF-8" NO
templateFilePrimaryDir テンプレートファイルを検索する際の優先ディレクトリです。 - NO
migrateDir マイグレーション用のファイルを管理するディレクトリです。 "db\migrate" NO
ddlInfoFile DDLのバージョン番号を管理するファイルです。 "db\ddl-info.txt" NO
versionNoPattern バージョン番号のパターンです。バージョン番号に対応するディレクトリ名に使用されます。 "0000" NO
statementDelimiter SQLステートメントの区切り文字です。 ";" NO
schemaInfoFullTableName スキーマのバージョンを管理するテーブル名です。 "SCHEMA_INFO" NO
schemaInfoColumnName スキーマのバージョンを管理するカラム名です。 "VERSION" NO
tableOption CREATE TABLE文の最後に付与されるオプションです。MySQLで、データベースのエンジンを指定する場合、たとえば、"ENGINE = INNODB"というように指定できます。 - NO
genDialectClassName S2JDBC-Genのダイアレクトインタフェースの実装クラス名です。ここに指定するクラスはorg.seasar.extension.jdbc.gen.dialect.GenDialectインタフェースを実装している必要があります。指定しない場合はS2JDBCのダイアレクト に対応したデフォルトのクラスが使用されます。 - NO
configPath JdbcManagerのコンポーネント定義を含む設定ファイルです。 "s2jdbc.dicon" NO
env 環境名です。 "ut" NO
jdbcManagerName JdbcManagerのコンポーネント名です。 "jdbcManager" NO
factoryClassName S2JDBC-Genの公開されたインタフェースの実装を作成するファクトリのクラス名です。S2JDBC-Genをカスタマイズする場合に独自のファクトリクラスを指定できます。ここに指定するクラスはorg.seasar.extension.jdbc.gen.internal.factory.Factoryインタフェースを実装している必要があります。 "org.seasar.extension.jdbc.gen.internal.factory.FactoryImpl" NO
classpath このタスクを実行する際のクラスパスです。 - classpathrefが指定されていない場合YES
classpathref このタスクを実行する際のクラスパスの参照です。 - classpathが指定されていない場合YES

ネストした要素として指定されるパラメータ

jvmArg

このタスクの大部分の処理は別VMで行われます。VMに引数を渡す場合は<jvmarg>要素を使用します。 これはAntのJavaタスクで使用できる<jvmarg>と同じです。 使用可能な属性やネストした要素についてはAntのドキュメントを参照してください。

    <gen-ddl
      classpathDir="build/classes"
      rootPackageName="examples"
      sqlKeywordCaseType="lowercase"
      sqlIdentifierCaseType="uppercase"
      classpathref="classpath"
   />

sqlKeywordCaseTypeとsqlIdentifierCaseTypeを指定してタスクを実行します。 このタスクによって生成されるSQLは次のように、キーワードが小文字、識別子が大文字になります。

    create table HOGE (AAA varchar(255));

GenerateEntityTask

説明

エンティティクラスを生成します。

パラメータ

属性 説明 デフォルト値 必須
schemaName このタスクが対象とするスキーマ名です。 - NO
tableNamePattern このタスクが対象とするテーブル名の正規表現です。 ".*" NO
ignoreTableNamePattern このタスクが対象としないテーブル名の正規表現です。 "(SCHEMA_INFO|.*\$.*)" NO
versionColumnNamePattern エンティティのプロパティに@Versionを付与するカラム名の正規表現です。大文字小文字の違いは考慮されません。 "VERSION([_]?NO)?" NO
pluralFormFile @OneToManyの関連プロパティ名を複数形で作成する際に使用される辞書ファイルです。 - NO
showCatalogName "true"の場合、@Tableのcatalog属性にカタログ名を明記します。 "false" NO
showSchemaName "true"の場合、@Tableのschema属性にスキーマ名を明記します。 "false" NO
showTableName "true"の場合、@Tableのname属性にテーブル名を明記します。 "false" NO
showColumnName "true"の場合、@Columnのname属性にカラム名を明記します。 "false" NO
showColumnDefinition "true"の場合、@ColumnのcolumnDefinition属性にカラム定義を明記します。 "false" NO
showJoinColumn "true"の場合、@JoinColumnを明記します。 "false" NO
entityTemplateFileName エンティティクラスのテンプレートファイル名です。 "java/entity.ftl" NO
templateFileEncoding テンプレートファイルのエンコーディングです。 "UTF-8" NO
templateFilePrimaryDir テンプレートファイルを検索する際の優先ディレクトリです。 - NO
rootPackageName ルートパッケージ名です。 "" NO
entityPackageName エンティティクラスのパッケージ名です。エンティティクラスは、rootPackageNameとこの値をピリオドで連結したパッケージに配置されます。 "entity" NO
javaFileDestDir Javaファイルの出力先ディレクトリです。 "src/main/java" NO
javaFileEncoding Javaファイルのエンコーディングです。 "UTF-8" NO
overwrite "true"の場合、エンティティクラスのJavaファイルを上書きします。 "false" NO
genDialectClassName S2JDBC-Genのダイアレクトインタフェースの実装クラス名です。ここに指定するクラスはorg.seasar.extension.jdbc.gen.dialect.GenDialectインタフェースを実装している必要があります。指定しない場合はS2JDBCのダイアレクト に対応したデフォルトのクラスが使用されます。 - NO
configPath JdbcManagerのコンポーネント定義を含む設定ファイルです。 "s2jdbc.dicon" NO
env 環境名です。 "ut" NO
jdbcManagerName JdbcManagerのコンポーネント名です。接続先のデータベースはJdbcManagerのコンポーネント名によって決まります。 "jdbcManager" NO
factoryClassName S2JDBC-Genの公開されたインタフェースの実装を作成するファクトリのクラス名です。S2JDBC-Genをカスタマイズする場合に独自のファクトリクラスを指定できます。ここに指定するクラスはorg.seasar.extension.jdbc.gen.internal.factory.Factoryインタフェースを実装している必要があります。 "org.seasar.extension.jdbc.gen.internal.factory.FactoryImpl" NO
classpath このタスクを実行する際のクラスパスです。 - classpathrefが指定されていない場合YES
classpathref このタスクを実行する際のクラスパスの参照です。 - classpathが指定されていない場合YES

ネストした要素として指定されるパラメータ

jvmArg

このタスクの大部分の処理は別VMで行われます。VMに引数を渡す場合は<jvmarg>要素を使用します。 これはAntのJavaタスクで使用できる<jvmarg>と同じです。 使用可能な属性やネストした要素についてはAntのドキュメントを参照してください。

    <gen-entity
      rootpackagename="examples"
      classpathref="classpath"
    />

ルートパッケージに"examples"を設定してタスクを実行します。

GenerateNamesTask

説明

名前インタフェースを作成します。

このタスクを実行するにはエンティティクラスが1つ以上存在している必要があります。

パラメータ

属性 説明 デフォルト値 必須
classpathDir エンティティクラスを含むクラスパスのディレクトリです。このディレクトリはタスクの実行時のクラスパスに含まれている必要があります。 - YES
rootPackageName ルートパッケージ名です。 "" NO
entityPackageName エンティティクラスのパッケージ名です。エンティティクラスは、rootPackageNameとこの値をピリオドで連結したパッケージに配置されているとみなされます。 "entity" NO
entityNamePattern このタスクで対象とするエンティティ名の正規表現です。 ".*" NO
ignoreEntityNamePattern このタスクで対象としないエンティティ名の正規表現です。 "" NO
namesPackageName 名前インタフェースのパッケージ名です。名前インタフェースは、rootPackageNameとこの値をピリオドで連結したパッケージに配置されます。 "entity" NO
namesInterfaceNameSuffix 名前インタフェース名のサフィックスです。 "Names" NO
namesTemplateFileName 名前インタフェースのテンプレートファイル名です。 "java/names.ftl" NO
templateFileEncoding テンプレートファイルのエンコーディングです。 "UTF-8" NO
templateFilePrimaryDir テンプレートファイルを検索する際の優先ディレクトリです。 - NO
javaFileDestDir Javaファイルの出力先ディレクトリです。 "src/main/java" NO
javaFileEncoding Javaファイルのエンコーディングです。 "UTF-8" NO
overwrite "true"の場合、名前インタフェースのJavaファイルを上書きします。 "true" NO
configPath JdbcManagerのコンポーネント定義を含む設定ファイルです。 "s2jdbc.dicon" NO
env 環境名です。 "ut" NO
jdbcManagerName JdbcManagerのコンポーネント名です。接続先のデータベースはJdbcManagerのコンポーネント名によって決まります。 "jdbcManager" NO
factoryClassName S2JDBC-Genの公開されたインタフェースの実装を作成するファクトリのクラス名です。S2JDBC-Genをカスタマイズする場合に独自のファクトリクラスを指定できます。ここに指定するクラスはorg.seasar.extension.jdbc.gen.internal.factory.Factoryインタフェースを実装している必要があります。 "org.seasar.extension.jdbc.gen.internal.factory.FactoryImpl" NO
classpath このタスクを実行する際のクラスパスです。 - classpathrefが指定されていない場合YES
classpathref このタスクを実行する際のクラスパスの参照です。 - classpathが指定されていない場合YES

ネストした要素として指定されるパラメータ

jvmArg

このタスクの大部分の処理は別VMで行われます。VMに引数を渡す場合は<jvmarg>要素を使用します。 これはAntのJavaタスクで使用できる<jvmarg>と同じです。 使用可能な属性やネストした要素についてはAntのドキュメントを参照してください。

    <gen-names
      rootpackagename="examples"
      classpathref="classpath"
    />

ルートパッケージに"examples"を設定してタスクを実行します。

GenerateServiceTask

説明

サービスクラスを生成します。

このタスクを実行するにはエンティティクラスが1つ以上存在している必要があります。

パラメータ

属性 説明 デフォルト値 必須
classpathDir エンティティクラスを含むクラスパスのディレクトリです。このディレクトリはタスクの実行時のクラスパスに含まれている必要があります。 - YES
rootPackageName ルートパッケージ名です。 "" NO
entityPackageName エンティティクラスのパッケージ名です。エンティティクラスは、rootPackageNameとこの値をピリオドで連結したパッケージに配置されているとみなされます。 "entity" NO
entityNamePattern このタスクで対象とするエンティティ名の正規表現です。 ".*" NO
ignoreEntityNamePattern このタスクで対象としないエンティティ名の正規表現です。 "" NO
servicePackageName サービスクラスのパッケージ名です。サービスクラスは、rootPackageNameとこの値をピリオドで連結したパッケージに配置されます。 "service" NO
serviceClassNameSuffix サービスクラス名のサフィックスです。 "Service" NO
abstractServiceTemplateFileName 抽象サービスクラスのテンプレートファイル名です。 "java/abstract-service.ftl" NO
serviceTemplateFileName サービスクラスのテンプレートファイル名です。 "java/service.ftl" NO
implementNames "true"の場合、名前インタフェースを実装します。 "true" NO
namesInterfaceNameSuffix 名前インタフェース名のサフィックスです。 "Names" NO
namesPackageName 名前インタフェースのパッケージ名です。名前インタフェースは、rootPackageNameとこの値をピリオドで連結したパッケージに配置されているとみなされます。 "entity" NO
templateFileEncoding テンプレートファイルのエンコーディングです。 "UTF-8" NO
templateFilePrimaryDir テンプレートファイルを検索する際の優先ディレクトリです。 - NO
javaFileDestDir Javaファイルの出力先ディレクトリです。 "src/main/java" NO
javaFileEncoding Javaファイルのエンコーディングです。 "UTF-8" NO
overwrite "true"の場合、サービスクラスのJavaファイルを上書きします。 "false" NO
configPath JdbcManagerのコンポーネント定義を含む設定ファイルです。 "s2jdbc.dicon" NO
env 環境名です。 "ut" NO
jdbcManagerName JdbcManagerのコンポーネント名です。接続先のデータベースはJdbcManagerのコンポーネント名によって決まります。 "jdbcManager" NO
factoryClassName S2JDBC-Genの公開されたインタフェースの実装を作成するファクトリのクラス名です。S2JDBC-Genをカスタマイズする場合に独自のファクトリクラスを指定できます。ここに指定するクラスはorg.seasar.extension.jdbc.gen.internal.factory.Factoryインタフェースを実装している必要があります。 "org.seasar.extension.jdbc.gen.internal.factory.FactoryImpl" NO
classpath このタスクを実行する際のクラスパスです。 - classpathrefが指定されていない場合YES
classpathref このタスクを実行する際のクラスパスの参照です。 - classpathが指定されていない場合YES

ネストした要素として指定されるパラメータ

jvmArg

このタスクの大部分の処理は別VMで行われます。VMに引数を渡す場合は<jvmarg>要素を使用します。 これはAntのJavaタスクで使用できる<jvmarg>と同じです。 使用可能な属性やネストした要素についてはAntのドキュメントを参照してください。

    <gen-service
      rootpackagename="examples"
      classpathref="classpath"
    />

ルートパッケージに"examples"を設定してタスクを実行します。

GenerateTestTask

説明

エンティティのテストクラスを作成します。

このタスクを実行するにはエンティティクラスが1つ以上存在している必要があります。

パラメータ

属性 説明 デフォルト値 必須
classpathDir エンティティクラスを含むクラスパスのディレクトリです。このディレクトリはタスクの実行時のクラスパスに含まれている必要があります。 - YES
rootPackageName ルートパッケージ名です。 "" NO
entityPackageName エンティティクラスのパッケージ名です。エンティティクラスは、rootPackageNameとこの値をピリオドで連結したパッケージに配置されているとみなされます。 "entity" NO
entityNamePattern このタスクで対象とするエンティティ名の正規表現です。 ".*" NO
ignoreEntityNamePattern このタスクで対象としないエンティティ名の正規表現です。 "" NO
testClassNameSuffix テストクラス名のサフィックスです。 "Test" NO
templateFileName テストクラスのテンプレートファイル名です。 "java/test.ftl" NO
templateFileEncoding テンプレートファイルのエンコーディングです。 "UTF-8" NO
templateFilePrimaryDir テンプレートファイルを検索する際の優先ディレクトリです。 - NO
javaFileDestDir Javaファイルの出力先ディレクトリです。 "src/test/java" NO
javaFileEncoding Javaファイルのエンコーディングです。 "UTF-8" NO
overwrite "true"の場合、テストクラスのJavaファイルを上書きします。 "false" NO
configPath JdbcManagerのコンポーネント定義を含む設定ファイルです。テストコードではこの設定ファイルがincludeされます。 "s2jdbc.dicon" NO
env 環境名です。 "ut" NO
jdbcManagerName JdbcManagerのコンポーネント名です。接続先のデータベースはJdbcManagerのコンポーネント名によって決まります。 "jdbcManager" NO
factoryClassName S2JDBC-Genの公開されたインタフェースの実装を作成するファクトリのクラス名です。S2JDBC-Genをカスタマイズする場合に独自のファクトリクラスを指定できます。ここに指定するクラスはorg.seasar.extension.jdbc.gen.internal.factory.Factoryインタフェースを実装している必要があります。 "org.seasar.extension.jdbc.gen.internal.factory.FactoryImpl" NO
classpath このタスクを実行する際のクラスパスです。 - classpathrefが指定されていない場合YES
classpathref このタスクを実行する際のクラスパスの参照です。 - classpathが指定されていない場合YES

ネストした要素として指定されるパラメータ

jvmArg

このタスクの大部分の処理は別VMで行われます。VMに引数を渡す場合は<jvmarg>要素を使用します。 これはAntのJavaタスクで使用できる<jvmarg>と同じです。 使用可能な属性やネストした要素についてはAntのドキュメントを参照してください。

    <gen-test
      rootpackagename="examples"
      classpathref="classpath"
    />

ルートパッケージに"examples"を設定してタスクを実行します。

LoadDataTask

説明

ダンプファイルをデータベースにロードします。

このタスクを実行するにはエンティティクラスが1つ以上存在している必要があります。

パラメータ

属性 説明 デフォルト値 必須
classpathDir エンティティクラスを含むクラスパスのディレクトリです。このディレクトリはタスクの実行時のクラスパスに含まれている必要があります。 - YES
rootPackageName ルートパッケージ名です。 "" NO
entityPackageName エンティティクラスのパッケージ名です。エンティティクラスは、rootPackageNameとこの値をピリオドで連結したパッケージに配置されているとみなされます。 "entity" NO
entityNamePattern このタスクで対象とするエンティティ名の正規表現です。 ".*" NO
ignoreEntityNamePattern このタスクで対象としないエンティティ名の正規表現です。 "" NO
dumpDir ダンプファイルが格納されているディレクトリです。 "db/dump" NO
dumpFileEncoding ダンプファイルのエンコーディングです。 "UTF-8" NO
loadBatchSize ダンプファイルのデータをロードする際のバッチサイズです。 "10" NO
transactional "true"の場合、単一のトランザクションとして実行します。 "false" NO
genDialectClassName S2JDBC-Genのダイアレクトインタフェースの実装クラス名です。ここに指定するクラスはorg.seasar.extension.jdbc.gen.dialect.GenDialectインタフェースを実装している必要があります。指定しない場合はS2JDBCのダイアレクト に対応したデフォルトのクラスが使用されます。 - NO
configPath JdbcManagerのコンポーネント定義を含む設定ファイルです。 "s2jdbc.dicon" NO
env 環境名です。 "ut" NO
jdbcManagerName JdbcManagerのコンポーネント名です。接続先のデータベースはJdbcManagerのコンポーネント名によって決まります。 "jdbcManager" NO
factoryClassName S2JDBC-Genの公開されたインタフェースの実装を作成するファクトリのクラス名です。S2JDBC-Genをカスタマイズする場合に独自のファクトリクラスを指定できます。ここに指定するクラスはorg.seasar.extension.jdbc.gen.internal.factory.Factoryインタフェースを実装している必要があります。 "org.seasar.extension.jdbc.gen.internal.factory.FactoryImpl" NO
classpath このタスクを実行する際のクラスパスです。 - classpathrefが指定されていない場合YES
classpathref このタスクを実行する際のクラスパスの参照です。 - classpathが指定されていない場合YES

ネストした要素として指定されるパラメータ

jvmArg

このタスクの大部分の処理は別VMで行われます。VMに引数を渡す場合は<jvmarg>要素を使用します。 これはAntのJavaタスクで使用できる<jvmarg>と同じです。 使用可能な属性やネストした要素についてはAntのドキュメントを参照してください。

    <load-data
      rootpackagename="examples"
      loadBatchSize="20"
      classpathref="classpath"
    />

バッチサイズを変更してタスクを実行します。

MigrateTask

説明

マイグレーションを実行します。

このタスクを実行するにはエンティティクラスが1つ以上存在している必要があります。

パラメータ

属性 説明 デフォルト値 必須
classpathDir エンティティクラスを含むクラスパスのディレクトリです。このディレクトリはタスクの実行時のクラスパスに含まれている必要があります。 - YES
rootPackageName ルートパッケージ名です。 "" NO
entityPackageName エンティティクラスのパッケージ名です。エンティティクラスは、rootPackageNameとこの値をピリオドで連結したパッケージに配置されているとみなされます。 "entity" NO
entityNamePattern このタスクで対象とするエンティティ名の正規表現です。 ".*" NO
ignoreEntityNamePattern このタスクで対象としないエンティティ名の正規表現です。 "" NO
schemaInfoFullTableName スキーマのバージョンを管理するテーブル名です。 "SCHEMA_INFO" NO
schemaInfoColumnName スキーマのバージョンを管理するカラム名です。 "VERSION" NO
migrateDir マイグレーション用のファイルを管理するディレクトリです。 "db/migrate" NO
ddlInfoFile DDLのバージョン番号を管理するファイルです。 "db/ddl-info.txt" NO
versionNoPattern バージョン番号のパターンです。バージョン番号に対応するディレクトリ名にしようされます。 "0000" NO
version マイグレーション先のバージョンです。 "latest" NO
statementDelimiter SQLステートメントの区切り文字です。 ";" NO
blockDelimiter SQLブロックの区切り文字です。指定しない場合は、データベースのデフォルトの区切り文字が使用されます。たとえば、SQL Serverでは"go"、Oralce Databaseでは"/"、MySQLでは"/"、DB2では"@"が使用されます。 - NO
ddlFileEncoding DDLファイルのエンコーディングです。 "UTF-8" NO
dumpFileEncoding ダンプファイルのエンコーディングです。 "UTF-8" NO
haltOnError "true"の場合、SQLの実行が失敗すると即座にエラーを返します。 "true" NO
loadBatchSize ダンプファイルのデータをロードする際のバッチサイズです。 "10" NO
transactional "true"の場合、単一のトランザクションとして実行します。 "false" NO
genDialectClassName S2JDBC-Genのダイアレクトインタフェースの実装クラス名です。ここに指定するクラスはorg.seasar.extension.jdbc.gen.dialect.GenDialectインタフェースを実装している必要があります。指定しない場合はS2JDBCのダイアレクト に対応したデフォルトのクラスが使用されます。 - NO
configPath JdbcManagerのコンポーネント定義を含む設定ファイルです。 "s2jdbc.dicon" NO
env 環境名です。 "ut" NO
jdbcManagerName JdbcManagerのコンポーネント名です。接続先のデータベースはJdbcManagerのコンポーネント名によって決まります。 "jdbcManager" NO
factoryClassName S2JDBC-Genの公開されたインタフェースの実装を作成するファクトリのクラス名です。S2JDBC-Genをカスタマイズする場合に独自のファクトリクラスを指定できます。ここに指定するクラスはorg.seasar.extension.jdbc.gen.internal.factory.Factoryインタフェースを実装している必要があります。 "org.seasar.extension.jdbc.gen.internal.factory.FactoryImpl" NO
classpath このタスクを実行する際のクラスパスです。 - classpathrefが指定されていない場合YES
classpathref このタスクを実行する際のクラスパスの参照です。 - classpathが指定されていない場合YES

ネストした要素として指定されるパラメータ

jvmArg

このタスクの大部分の処理は別VMで行われます。VMに引数を渡す場合は<jvmarg>要素を使用します。 これはAntのJavaタスクで使用できる<jvmarg>と同じです。 使用可能な属性やネストした要素についてはAntのドキュメントを参照してください。

    <migrate
      rootpackagename="examples"
      version="15"
      classpathref="classpath"
    />

マイグレーション先のバージョン番号を指定してタスクを実行します。