Improved Javadoc on store() and storeUsing() methods

This commit is contained in:
Lukas Eder 2012-04-18 20:01:54 +00:00
parent ffa0aa9efc
commit f842b7d905
2 changed files with 21 additions and 0 deletions

View File

@ -35,6 +35,8 @@
*/
package org.jooq;
import java.sql.Statement;
import org.jooq.exception.DataAccessException;
/**
@ -87,6 +89,13 @@ public interface TableRecord<R extends TableRecord<R>> extends Record {
* SET [modified fields = modified values, excluding keys]
* WHERE [key fields = key values]</pre></code></li>
* </ul>
* <p>
* If there is an <code>IDENTITY</code> column defined on the record's
* underlying table (see {@link Table#getIdentity()}), then the
* auto-generated <code>IDENTITY</code> value is refreshed automatically on
* <code>INSERT</code>'s. Refreshing is done using
* {@link Statement#getGeneratedKeys()}, where this is supported by the JDBC
* driver.
*
* @param keys The key fields used for deciding whether to execute an
* <code>INSERT</code> or <code>UPDATE</code> statement. If an

View File

@ -35,6 +35,8 @@
*/
package org.jooq;
import java.sql.Statement;
import org.jooq.exception.DataAccessException;
/**
@ -112,6 +114,16 @@ public interface UpdatableRecord<R extends UpdatableRecord<R>> extends Updatable
* WHERE [main key fields = main key values]</pre></code></li>
* </ul>
* <p>
* If there is an <code>IDENTITY</code> column defined on the record's
* underlying table (see {@link Table#getIdentity()}), then the
* auto-generated <code>IDENTITY</code> value is refreshed automatically on
* <code>INSERT</code>'s. Similarly, all members of the primary key are
* refreshed, to ensure that trigger-generated values will be available
* after <code>INSERT</code>. Normally, primary key and
* <code>IDENTITY</code> columns coincide, but this doesn't have to be.
* Refreshing is done using {@link Statement#getGeneratedKeys()}, where this
* is supported by the JDBC driver.
* <p>
* This is in fact the same as calling
* <code>store(getTable().getMainKey().getFieldsArray())</code>
*