github/jooq
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[#1504] Document behaviour of fetch() and fetchOne() in case jOOQ cannot

Browse Source 
fetch actual records
This commit is contained in:
Lukas Eder 2012-06-29 14:56:49 +02:00
parent cad539b372
commit cd1e228444
2 changed files with 27 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
jOOQ/src/main/java/org/jooq/InsertQuery.java
View File

@ -232,6 +232,10 @@ public interface InsertQuery<R extends Record> extends StoreQuery<R>, Insert<R>
* must assure transactional integrity between the two statements.</li>
* </ul>
*
* @return The returned value as specified by any of the
* {@link #setReturning()} methods. This may return
* <code>null</code> in case jOOQ could not retrieve any generated
* keys from the JDBC driver.
* @see #getReturnedRecords()
*/
@Support
@ -257,8 +261,15 @@ public interface InsertQuery<R extends Record> extends StoreQuery<R>, Insert<R>
* other fields are requested, a second statement is issued. Client code
* must assure transactional integrity between the two statements.</li>
* </ul>
* <p>
* This currently only works well for DB2, HSQLDB, MySQL, and Postgres
*
* @return The returned values as specified by any of the
* {@link #setReturning()} methods. Note:
* <ul>
* <li>Not all databases / JDBC drivers support returning several
* values on multi-row inserts!</li><li>This may return an empty
* <code>Result</code> in case jOOQ could not retrieve any generated
* keys from the JDBC driver.</li>
* </ul>
*/
@Support
Result<R> getReturnedRecords();

14
jOOQ/src/main/java/org/jooq/InsertResultStep.java
View File

@ -76,7 +76,16 @@ public interface InsertResultStep<R extends Record> extends Insert<R> {
* <p>
* This currently only works well for DB2, HSQLDB, MySQL, and Postgres
*
* @return The returned values as specified by the
* {@link InsertReturningStep}. Note:
* <ul>
* <li>Not all databases / JDBC drivers support returning several
* values on multi-row inserts!</li><li>This may return an empty
* <code>Result</code> in case jOOQ could not retrieve any generated
* keys from the JDBC driver.</li>
* </ul>
* @throws DataAccessException if something went wrong executing the query
* @see InsertQuery#getReturnedRecords()
*/
@Support
Result<R> fetch() throws DataAccessException;
@ -85,7 +94,12 @@ public interface InsertResultStep<R extends Record> extends Insert<R> {
* The record holding returned values as specified by the
* {@link InsertReturningStep}
*
* @return The returned value as specified by the
* {@link InsertReturningStep}. This may return <code>null</code> in
* case jOOQ could not retrieve any generated keys from the JDBC
* driver.
* @throws DataAccessException if something went wrong executing the query
* @see InsertQuery#getReturnedRecord()
*/
@Support
R fetchOne() throws DataAccessException;