<?xml version="1.0" encoding="UTF-8"?>
<document>
	<properties>
		<title>S2JDBC-Gen - Exec-Sql</title>
	</properties>
	<body>
		<section name="Exec-Sql">
			<ul>
				<li>
					<p>
						<a href="#説明">説明</a>
						<ul>
							<li>
								<p>
									<a href="#概要">概要</a>
								</p>
							</li>
						</ul>
					</p>
				</li>
				<li>
					<p>
						<a href="#パラメータ">パラメータ</a>
						<ul>
							<li>
								<p>
									<a href="#トップレベルのパラメータ">トップレベルのパラメータ</a>
								</p>
							</li>
							<li>
								<p>
									<a href="#ネストした要素として指定されるパラメータ">ネストした要素として指定されるパラメータ</a>
								</p>
							</li>
						</ul>
					</p>
				</li>
				<li>
					<p>
						<a href="#例">例</a>
						<ul>
							<li>
								<p>
									<a href="#SQLファイルを実行する">SQLファイルを実行する</a>
								</p>
							</li>
							<li>
								<p>
									<a href="#トランザクション内で実行する">トランザクション内で実行する</a>
								</p>
							</li>
						</ul>
					</p>
				</li>
			</ul>
		</section>
		<section name="説明">
			<subsection name="概要">
				<p>
					指定されたファイルに含まれる任意のSQLを実行します。
				</p>
				<p>
					実行できるSQLファイルの形式については、<a href="../file_format.html#SQLファイル">SQLファイル</a>を参照ください。
				</p>
				<p>
					接続先のデータベースはJdbcManagerのコンポーネント名によって決まります。
				</p>
			</subsection>
		</section>
		<section name="パラメータ">
			<p>
				Antタスクへのパラメータを以下に示します。
			</p>
			<subsection name="トップレベルのパラメータ">
				<table border="1" cellpadding="2" cellspacing="0">
					<tr><th>属性</th><th>説明</th><th>デフォルト値</th><th>必須</th></tr>
					<tr><td>sqlFileEncoding</td><td>SQLファイルのエンコーディングです。</td><td>"UTF-8"</td><td>NO</td></tr>
					<tr><td>statementDelimiter</td><td>SQLステートメントの区切り文字です。</td><td>";"</td><td>NO</td></tr>
					<tr><td>blockDelimiter</td><td>SQLブロックの区切り文字です。指定しない場合は、データベースのデフォルトの区切り文字が使用されます。たとえば、SQL Serverでは"go"、Oralce Databaseでは"/"、MySQLでは"/"、DB2では"@"が使用されます。</td><td>-</td><td>NO</td></tr>
					<tr><td>haltOnError</td><td>"true"の場合、SQLの実行が失敗すると即座にエラーを返します。</td><td>"true"</td><td>NO</td></tr>
					<tr><td>transactional</td><td>"true"の場合、単一のトランザクションとして実行します。</td><td>"false"</td><td>NO</td></tr>
					<tr><td>genDialectClassName</td><td>S2JDBC-Genのダイアレクトインタフェースの実装クラス名です。ここに指定するクラスはorg.seasar.extension.jdbc.gen.dialect.GenDialectインタフェースを実装している必要があります。指定しない場合は<a href="../s2jdbc_setup.html#ダイアレクト">S2JDBCのダイアレクト</a>に対応したデフォルトのクラスが使用されます。</td><td>-</td><td>NO</td></tr>
					<tr><td>configPath</td><td>JdbcManagerのコンポーネント定義を含む設定ファイルです。このタスクの実行に使用されます。</td><td>"s2jdbc.dicon"</td><td>NO</td></tr>
					<tr><td>env</td><td>環境名です。</td><td>"ut"</td><td>NO</td></tr>
					<tr><td>jdbcManagerName</td><td>JdbcManagerのコンポーネント名です。</td><td>"jdbcManager"</td><td>NO</td></tr>
					<tr><td>factoryClassName</td><td>S2JDBC-Genの公開されたインタフェースの実装を作成するファクトリのクラス名です。S2JDBC-Genをカスタマイズする場合に独自のファクトリクラスを指定できます。ここに指定するクラスはorg.seasar.extension.jdbc.gen.internal.factory.Factoryインタフェースを実装している必要があります。</td><td>"org.seasar.extension.jdbc.gen<br />.internal.factory.FactoryImpl"</td><td>NO</td></tr>
					<tr><td>commandInvokerClassName</td><td>S2JDBC-Genのコマンドを呼び出すクラスの名前です。コマンドの呼び出し前後で任意の処理を実行したい場合に指定します。ここに指定するクラスはorg.seasar.extension.jdbc.gen.command.CommandInvokerインタフェースを実装している必要があります。</td><td>"org.seasar.extension.jdbc.gen<br />.internal.command.CommandInvokerImpl"</td><td>NO</td></tr>
					<tr><td>classpath</td><td>このタスクを実行する際のクラスパスです。</td><td>-</td><td>classpathrefが指定されていない場合YES</td></tr>
					<tr><td>classpathref</td><td>このタスクを実行する際のクラスパスの参照です。</td><td>-</td><td>classpathが指定されていない場合YES</td></tr>
				</table>
			</subsection>
			<subsection name="ネストした要素として指定されるパラメータ">
				<h4>
					SqlFileList
				</h4>
				<p>
					SQLファイルを指定するためには、&lt;SqlFileList&gt;要素を使用します。
					この要素はひとつ以上の指定が必須です。
				</p>
				<p>
					&lt;SqlFileList&gt;はAntの&lt;FileList&gt;と同じデータ型です。
					使用可能な属性やネストした要素についてはAntのドキュメントを参照してください。
				</p>
				<h4>
					jvmArg
				</h4>
				<p>
					このタスクの大部分の処理は別VMで行われます。VMに引数を渡す場合は&lt;jvmarg&gt;要素を使用します。
					これはAntのJavaタスクで使用できる&lt;jvmarg&gt;と同じです。
					使用可能な属性やネストした要素についてはAntのドキュメントを参照してください。
				</p>
			</subsection>
		</section>
		<section name="例">
			<subsection name="SQLファイルを実行する">
				<p>
					SQLファイルを実行するには、実行したいSQLファイルを&lt;SqlFileList&gt;に指定します。
					次の例では1つのSQLファイルを指定していますが、複数のSQLを指定可能です。
				</p>
<source><![CDATA[<exec-sql
    classpathRef="classpath">
        <sqlFileList dir="sql">
            <file name="aaa.sql"/>
        </sqlFileList>
</exec-sql>]]></source>
			</subsection>
			<subsection name="トランザクション内で実行する">
				<p>
					SQLファイル内のSQLをトランザクション内で実行するには、transactional属性に"true"を指定します。
				</p>
<source><![CDATA[<exec-sql
    transactional="true"
    classpathRef="classpath">
        <sqlFileList dir="sql">
            <file name="aaa.sql"/>
            <file name="bbb.sql"/>
            <file name="ccc.sql"/>
        </sqlFileList>
</exec-sql>]]></source>
				<p>
					上記の定義では、トランザクションが開始された後、aaa.sql、bbb.sql、ccc.sqlに記述されたSQLが順に実行され、エラーが発生しなければコミットされます。
					エラーが発生した場合、トランザクションはロールバックされます。
				</p>
			</subsection>
		</section>
	</body>
</document>
