<?xml version="1.0" encoding="UTF-8"?>
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
	<properties>
		<title>バッチ更新</title>
	</properties>
	<body>
		<section name="目次">
			<ul>
				<li><a href="#概要">概要</a></li>
				<li><a href="#SQLの自動生成によるバッチ更新">SQLの自動生成によるバッチ更新</a>
					<ul>
						<li><a href="#SQL自動生成におけるバージョン番号と楽観的排他制御">SQL自動生成におけるバージョン番号と楽観的排他制御</a></li>
						<li><a href="#更新対象プロパティ">更新対象プロパティ</a></li>
					</ul>
				</li>
				<li><a href="#SQLファイルによるバッチ更新">SQLファイルによるバッチ更新</a>
					<ul>
						<li><a href="#SQLファイルにおけるバージョン番号と楽観的排他制御">SQLファイルにおけるバージョン番号と楽観的排他制御</a></li>
					</ul>
				</li>
				<li><a href="#一意制約違反">一意制約違反</a></li>
				<li><a href="#クエリタイムアウト">クエリタイムアウト</a></li>
				<li><a href="#バッチサイズ">バッチサイズ</a></li>
			</ul>
		</section>
		<section name="概要">
			<p>
				バッチ更新を行うには、<a href="../../apidocs/org/seasar/doma/BatchUpdate.html"><code>@BatchUpdate</code></a>をDaoのメソッドに注釈します。
			</p>
<source><![CDATA[@Config(config = AppConfig.class)
public interface EmployeeDao {
    @BatchUpdate
    int[] update(List<Employee> employees);
    ...
}]]></source>
			<p>
				デフォルトでは、UPDATE文が自動生成されます。
				<code>@BatchUpdate</code>の<code>sqlFile</code>に<code>true</code>を設定することで、任意の<a href="../sqlfile.html">SQLファイル</a>にマッピングできます。
			</p>
			<p>
				パラメータの要素の<a href="../entity.html">エンティティクラス</a>に<a href="../entity.html#エンティティリスナー">エンティティリスナー</a>が指定されている場合、更新の実行前にエンティティリスナーの<code>preUpdate</code>メソッドをエンティティごとに呼び出します。
				また、更新の実行後にエンティティリスナーの<code>postUpdate</code>メソッドをエンティティごとに呼び出します。
			</p>
		</section>
		<section name="SQLの自動生成によるバッチ更新">
			<p>
				戻り値の型は<code>int[]</code>でなければいけません。
				パラメータの型は<a href="../entity.html">エンティティクラス</a>を要素とする<code>java.lang.Iterable</code>のサブタイプでなければいけません。
				指定できるパラメータの数は1つです。
				引数は<code>null</code>であってはいけません。
				戻り値の配列の要素の数はパラメータの<code>Iterable</code>の要素の数と等しくなります。
				配列のそれぞれの要素が更新された件数を返します。
			</p>
			<subsection name="SQL自動生成におけるバージョン番号と楽観的排他制御">
				<p>
					次の条件を満たす場合に、楽観的排他制御が行われます。
				</p>
				<ul>
					<li>パラメータの<code>java.lang.Iterable</code>のサブタイプの要素である<a href="../entity.html">エンティティクラス</a>に<code>@Version</code>が注釈されたプロパティがある</li>
					<li>@BatchUpdateの<code>ignoreVersion</code>要素が<code>false</code>である</li>
				</ul>
				<p>
					楽観的排他制御が有効であれば、バージョン番号は識別子とともに更新条件に含まれ、1増分して更新されます。
					このときの更新件数が0件の場合、楽観的排他制御の失敗を示す<a href="../../apidocs/org/seasar/doma/jdbc/BatchOptimisticLockException.html"><code>org.seasar.doma.jdbc.BatchOptimisticLockException</code></a>がスローされます。
					また、更新件数が0件でない場合、<code>BatchOptimisticLockException</code>はスローされず、エンティティのバージョンプロパティの値が1増分されます。
				</p>
				<p>
					<code>@BatchUpdate</code>の<code>ignoreVersion</code>要素が<code>true</code>の場合、
					バージョン番号は更新条件には含まれず、UPDATE文のSET句に含まれます。バージョン番号はアプリケーションで設定した値で更新されます。
					この場合、更新件数が0件であっても、<code>BatchOptimisticLockException</code>はスローされません。
				</p>
<source><![CDATA[@BatchUpdate(ignoreVersion = true)
int[] update(List<Employee> employees);]]></source>
				<p>
					<code>@BatchUpdate</code>の<code>suppressOptimisticLockException</code>要素が<code>true</code>の場合、
					<code>@Version</code>が注釈されたプロパティがあればバージョン番号は更新条件に含まれ増分もされますが、
					更新件数が0件であっても<code>BatchOptimisticLockException</code>はスローされません。
					ただし、エンティティのバージョンプロパティの値は1増分されます。
				</p>
<source><![CDATA[@BatchUpdate(suppressOptimisticLockException = true)
int[] update(List<Employee> employees);]]></source>
			</subsection>
			<subsection name="更新対象プロパティ">
				<h4><code>@Column</code>の<code>updatable</code>要素</h4>
				<p>
					<a href="../entity.html">エンティティクラス</a>に<code>@Column</code>が注釈されたプロパティがある場合、
					<code>@Column</code>の<code>updatable</code>要素が<code>false</code>のものは更新対象外です。
				</p>
				<h4><code>@BatchUpdate</code>の<code>exclude</code>要素</h4>
				<p>
					<code>@BatchUpdate</code>の<code>exclude</code>要素に指定されたプロパティを更新対象外とします。
					プロパティがこの要素に指定されていれば、<code>@Column</code>の<code>updatable</code>要素が<code>true</code>であっても削除対象外です。
				</p>
<source><![CDATA[@BatchUpdate(exclude = {"name", "salary"})
int[] update(List<Employee> employees);]]></source>
				<h4><code>@BatchUpdate</code>の<code>include</code>要素</h4>
				<p>
					<code>@BatchUpdate</code>の<code>include</code>要素に指定されたプロパティのみを削除対象とします。
					<code>@BatchUpdate</code>の<code>include</code>要素と<code>exclude</code>要素の両方に
					同じプロパティが指定された場合、そのプロパティは更新対象外になります。
					プロパティがこの要素に指定されていても、<code>@Column</code>の<code>updatable</code>要素が<code>false</code>であれば更新対象外です。
				</p>
<source><![CDATA[@BatchUpdate(include = {"name", "salary"})
int[] update(List<Employee> employees);]]></source>
			</subsection>
		</section>
		<section name="SQLファイルによるバッチ更新">
			<p>
				SQLファイルによるバッチ更新を行うには、<code>@BatchUpdate</code>の<code>sqlFile</code>要素に<code>true</code>を設定し、
				メソッドに対応する<a href="../sqlfile.html">SQLファイル</a>を用意します。
			</p>
<source><![CDATA[@BatchUpdate(sqlFile = true)
int[] update(List<Employee> employees);]]></source>
			<p>
				戻り値の型は<code>int[]</code>でなければいけません。
				パラメータは任意の型を要素とする<code>java.lang.Iterable</code>のサブタイプでなければいけません。
				指定できるパラメータの数は1つです。
				引数は<code>null</code>であってはいけません。
				戻り値の配列の要素の数はパラメータの<code>Iterable</code>の要素の数と等しくなります。
				配列のそれぞれの要素が更新された件数を返します。
			</p>
			<p>
				たとえば、上記のメソッドに対応するSQLは次のように記述します。
			</p>
<source><![CDATA[update employee set name = /* employees.name */'hoge', salary = /* employees.salary */100 where id = /* employees.id */0]]></source>
			<p>
				SQLファイル上では、パラメータの名前は<code>java.lang.Iterable</code>のサブタイプの要素を指します。
			</p>
			<p>
				SQLファイルによるバッチ更新では、バージョン番号の自動更新は行われません。
				また、<code>@BatchUpdate</code>の<code>exclude</code>要素、<code>include</code>要素は参照されません。
			</p>
			<subsection name="SQLファイルにおけるバージョン番号と楽観的排他制御">
				<p>
					次の条件を満たす場合に、楽観的排他制御が行われます。
				</p>
				<ul>
					<li>パラメータの<code>java.lang.Iterable</code>のサブタイプの要素が<a href="../entity.html">エンティティクラス</a>であり、エンティティクラスに<code>@Version</code>が注釈されたプロパティがある</li>
					<li>@BatchUpdateの<code>ignoreVersion</code>要素が<code>false</code>である</li>
				</ul>
				<p>
					ただし、SQLファイルに楽観的排他制御用のSQLを記述するのは、アプリケーション開発者の責任です。
					たとえば、下記のSQLのように、WHERE句でバージョンを番号を指定しSET句でバージョン番号を1だけ増分しなければいけません。
				</p>
<source><![CDATA[update EMPLOYEE set DELETE_FLAG = 1, VERSION = /* employees.version */1 + 1 where ID = /* employees.id */1 and VERSION = /* employees.version */1]]></source>
				<p>
					このSQLの更新件数が0件の場合、楽観的排他制御の失敗を示す<a href="../../apidocs/org/seasar/doma/jdbc/BatchOptimisticLockException.html"><code>org.seasar.doma.jdbc.BatchOptimisticLockException</code></a>がスローされます。
					更新件数が0件でない場合、<code>BatchOptimisticLockException</code>はスローされず、エンティティのバージョンプロパティの値が1増分されます。
				</p>
				<p>
					楽観的排他制御が有効であれば、バージョン番号は識別子とともに更新条件に含まれ、1増分して更新されます。
					このときの更新件数が0件の場合、楽観的排他制御の失敗を示す<a href="../../apidocs/org/seasar/doma/jdbc/BatchOptimisticLockException.html"><code>org.seasar.doma.jdbc.BatchOptimisticLockException</code></a>がスローされます。
					一方、更新件数が0件でない場合、<code>BatchOptimisticLockException</code>はスローされず、エンティティのバージョンプロパティの値が1増分されます。
				</p>
				<p>
					<code>@BatchUpdate</code>の<code>ignoreVersion</code>要素が<code>true</code>の場合、
					更新件数が0件であっても、<code>BatchOptimisticLockException</code>はスローされません。
					また、エンティティのバージョンプロパティの値は変更されません。
				</p>
<source><![CDATA[@BatchUpdate(sqlFile = true, ignoreVersion = true)
int[] update(List<Employee> employees);]]></source>
				<p>
					<code>@BatchUpdate</code>の<code>suppressOptimisticLockException</code>要素が<code>true</code>の場合、
					更新件数が0件であっても<code>BatchOptimisticLockException</code>はスローされません。
					ただし、エンティティのバージョンプロパティの値は1増分されます。
				</p>
<source><![CDATA[@BatchUpdate(sqlFile = true, suppressOptimisticLockException = true)
int[] update(List<Employee> employees);]]></source>
			</subsection>
		</section>
		<section name="一意制約違反">
			<p>
				一意制約違反が発生した場合は、SQLファイルの使用の有無に関係なく<a href="../../apidocs/org/seasar/doma/jdbc/UniqueConstraintException.html"><code>org.seasar.doma.jdbc.UniqueConstraintException</code></a>がスローされます。
			</p>
		</section>
		<section name="クエリタイムアウト">
			<p>
				<code>@BatchUpdate</code>の<code>queryTimeout</code>要素にクエリタイムアウトの秒数を指定できます。
			</p>
<source><![CDATA[@BatchUpdate(queryTimeout = 10)
int[] update(List<Employee> employees);]]></source>
			<p>
				この設定は、SQLファイルの使用の有無に関係なく適用されます。
				<code>queryTimeout</code>要素に値を指定しない場合、
				<a href="../config.html">設定クラス</a>に指定されたクエリタイムアウトが使用されます。
			</p>
		</section>
		<section name="バッチサイズ">
			<p>
				<code>@BatchUpdate</code>の<code>batchSize</code>要素にバッチサイズを指定できます。
			</p>
<source><![CDATA[@BatchUpdate(batchSize = 10)
int[] update(List<Employee> employees);]]></source>
			<p>
				この設定は、SQLファイルの使用の有無に関係なく適用されます。
				<code>batchSize</code>要素に値を指定しない場合、
				<a href="../config.html">設定クラス</a>に指定されたバッチサイズが使用されます。
			</p>
		</section>
	</body>
</document>