org.jooq

Interface LoaderOptionsStep<R extends Record>

All Superinterfaces:

LoaderSourceStep<R>

public interface LoaderOptionsStep<R extends Record>
extends LoaderSourceStep<R>

The Loader API is used for configuring data loads.

Add options to for the loading behaviour. For performance reasons, you can fine-tune three different types of measures:

• The bulk statement size. This specifies how many rows will be inserted in a single bulk statement / multi-row INSERT statement.
• The batch statement size. This specifies how many bulk statements will be sent to the server as a single JDBC batch statement.
• The commit size. This specifies how many batch statements will be committed in a single transaction.

Referencing XYZ*Step types directly from client code

It is usually not recommended to reference any XYZ*Step types directly from client code, or assign them to local variables. When writing dynamic SQL, creating a statement's components dynamically, and passing them to the DSL API statically is usually a better choice. See the manual's section about dynamic SQL for details: https://www.jooq.org/doc/latest/manual/sql-building/dynamic-sql.

Drawbacks of referencing the XYZ*Step types directly:

• They're operating on mutable implementations (as of jOOQ 3.x)
• They're less composable and not easy to get right when dynamic SQL gets complex
• They're less readable
• They might have binary incompatible changes between minor releases

Author:

Lukas Eder

Method Summary

Modifier and Type	Method and Description
LoaderOptionsStep<R>	batchAfter(int number) Batch a given number of bulk statements together.
LoaderOptionsStep<R>	batchAll() Batch all bulk statements in one JDBC batch statement.
LoaderOptionsStep<R>	batchNone() Do not batch bulk statements together.
LoaderOptionsStep<R>	bulkAfter(int number) Bulk-insert a given number of statements in a single multi-row bulk statement.
LoaderOptionsStep<R>	bulkAll() Bulk-insert all rows in a single multi-row bulk statement.
LoaderOptionsStep<R>	bulkNone() Do not bulk-insert rows in multi-row bulk statements.
LoaderOptionsStep<R>	commitAfter(int number) Commit after a certain number of batches.
LoaderOptionsStep<R>	commitAll() Commit only after inserting all batches.
LoaderOptionsStep<R>	commitEach() Commit each batch.
LoaderOptionsStep<R>	commitNone() Leave committing / rollbacking up to client code.
LoaderOptionsStep<R>	onDuplicateKeyError() Instruct the Loader to cause an error in loading if there are any duplicate records.
LoaderOptionsStep<R>	onDuplicateKeyIgnore() Instruct the Loader to skip duplicate records if any of the unique keys' values are already in the database.
LoaderOptionsStep<R>	onDuplicateKeyUpdate() Instruct the Loader to update duplicate records if any of the unique keys' values are already in the database.
LoaderOptionsStep<R>	onErrorAbort() Instruct the Loader to abort loading after the first error that might occur when inserting a record.
LoaderOptionsStep<R>	onErrorIgnore() Instruct the Loader to ignore any errors that might occur when inserting a record.

Methods inherited from interface org.jooq.LoaderSourceStep

loadArrays, loadArrays, loadArrays, loadArrays, loadCSV, loadCSV, loadCSV, loadCSV, loadCSV, loadCSV, loadCSV, loadCSV, loadCSV, loadCSV, loadJSON, loadJSON, loadJSON, loadJSON, loadJSON, loadJSON, loadJSON, loadJSON, loadJSON, loadJSON, loadRecords, loadRecords, loadRecords, loadRecords, loadXML, loadXML, loadXML, loadXML, loadXML, loadXML, loadXML, loadXML, loadXML, loadXML, loadXML

Method Detail

onDuplicateKeyUpdate

@Support(value={AURORA_MYSQL,AURORA_POSTGRES,CUBRID,DB2,HSQLDB,MARIADB,MYSQL,ORACLE,POSTGRES_9_5,SQLSERVER,SYBASE,TERADATA})
LoaderOptionsStep<R> onDuplicateKeyUpdate()

Instruct the Loader to update duplicate records if any of the unique keys' values are already in the database. This is only supported if InsertQuery.onDuplicateKeyUpdate(boolean) is supported, too.

If the loaded table does not have any unqiue keys, then all records are inserted and this clause behaves like onDuplicateKeyIgnore()

If you don't specify a behaviour, onDuplicateKeyError() will be the default. This cannot be combined with onDuplicateKeyError() or onDuplicateKeyIgnore()

onDuplicateKeyIgnore

@Support
LoaderOptionsStep<R> onDuplicateKeyIgnore()

Instruct the Loader to skip duplicate records if any of the unique keys' values are already in the database.

If the loaded table does not have any unique keys, then all records are inserted. This may influence the JDBC driver's outcome on Connection.getWarnings(), depending on your JDBC driver's implementation

If you don't specify a behaviour, onDuplicateKeyError() will be the default. This cannot be combined with onDuplicateKeyError() or onDuplicateKeyUpdate()

onDuplicateKeyError

@Support
LoaderOptionsStep<R> onDuplicateKeyError()

Instruct the Loader to cause an error in loading if there are any duplicate records.

If this is combined with onErrorAbort() and commitAll() in a later step of Loader, then loading is rollbacked on abort.

If you don't specify a behaviour, this will be the default. This cannot be combined with onDuplicateKeyIgnore() or onDuplicateKeyUpdate()

onErrorIgnore

@Support
LoaderOptionsStep<R> onErrorIgnore()

Instruct the Loader to ignore any errors that might occur when inserting a record. The Loader will then skip the record and try inserting the next one. After loading, you can access errors with Loader.errors()

If you don't specify a behaviour, onErrorAbort() will be the default. This cannot be combined with onErrorAbort()

onErrorAbort

@Support
LoaderOptionsStep<R> onErrorAbort()

Instruct the Loader to abort loading after the first error that might occur when inserting a record. After loading, you can access errors with Loader.errors()

If this is combined with commitAll() in a later step of Loader, then loading is rollbacked on abort.

If you don't specify a behaviour, this will be the default. This cannot be combined with onErrorIgnore()

commitEach

@Support
LoaderOptionsStep<R> commitEach()

Commit each batch.

This is the same as calling commitAfter(int) with 1 as parameter.

With this clause, errors will never result in a rollback, even when you specify onDuplicateKeyError() or onErrorAbort()

The COMMIT OPTIONS might be useful for fine-tuning performance behaviour in some RDBMS, where large commits lead to a high level of concurrency in the database. Use this on fresh transactions only. Commits/Rollbacks are executed directly upon the connection returned by Configuration.connectionProvider(). This might not work with container-managed transactions, or when Connection.getAutoCommit() is set to true.

If you don't specify a COMMIT OPTION, commitNone() will be the default, leaving transaction handling up to you.

commitAfter

@Support
LoaderOptionsStep<R> commitAfter(int number)

Commit after a certain number of batches.

With this clause, errors will never result in a rollback, even when you specify onDuplicateKeyError() or onErrorAbort()

The COMMIT OPTIONS might be useful for fine-tuning performance behaviour in some RDBMS, where large commits lead to a high level of concurrency in the database. Use this on fresh transactions only. Commits/Rollbacks are executed directly upon the connection returned by Configuration.connectionProvider(). This might not work with container-managed transactions, or when Connection.getAutoCommit() is set to true.

If you don't specify a COMMIT OPTION, commitNone() will be the default, leaving transaction handling up to you.

Parameters:

number - The number of records that are committed together.

commitAll

@Support
LoaderOptionsStep<R> commitAll()

Commit only after inserting all batches. If this is used together with onDuplicateKeyError() or onErrorAbort(), an abort will result in a rollback of previously loaded records.

The COMMIT OPTIONS might be useful for fine-tuning performance behaviour in some RDBMS, where large commits lead to a high level of concurrency in the database. Use this on fresh transactions only. Commits/Rollbacks are executed directly upon the connection returned by Configuration.connectionProvider(). This might not work with container-managed transactions, or when Connection.getAutoCommit() is set to true.

If you don't specify a COMMIT OPTION, commitNone() will be the default, leaving transaction handling up to you.

commitNone

@Support
LoaderOptionsStep<R> commitNone()

Leave committing / rollbacking up to client code.

The COMMIT OPTIONS might be useful for fine-tuning performance behaviour in some RDBMS, where large commits lead to a high level of concurrency in the database.

If you don't specify a COMMIT OPTION, this will be the default, leaving transaction handling up to you. This should be your choice, when you use container-managed transactions, too, or your Connection.getAutoCommit() value is set to true.

batchAll

@Support
LoaderOptionsStep<R> batchAll()

Batch all bulk statements in one JDBC batch statement.

If commitEach() or commitAfter(int) are set, this will force the COMMIT option to commitAll().

batchNone

@Support
LoaderOptionsStep<R> batchNone()

Do not batch bulk statements together.

If you don't specify a BATCH OPTION, this will be the default.

batchAfter

@Support
LoaderOptionsStep<R> batchAfter(int number)

Batch a given number of bulk statements together.

Parameters:

number - The number of records that are batched together.

bulkAll

@Support
LoaderOptionsStep<R> bulkAll()

Bulk-insert all rows in a single multi-row bulk statement.

If commitEach() or commitAfter(int) are set, this will force the COMMIT option to commitAll().

bulkNone

@Support
LoaderOptionsStep<R> bulkNone()

Do not bulk-insert rows in multi-row bulk statements.

If you don't specify a BULK OPTION, this will be the default.

bulkAfter

@Support
LoaderOptionsStep<R> bulkAfter(int number)

Bulk-insert a given number of statements in a single multi-row bulk statement.

If commitEach() is set, each bulk statement will be committed. If commitAfter(int) is set, the given number of bulk statements are committed.

Parameters:

number - The number of records that are put together in one bulk statement.