Top Description Methods
org.jooq

public Interface LoaderRowsStep<R extends org.jooq.Record>

Known Direct Implementers
org.jooq.impl.LoaderImpl
Imports
org.jetbrains.annotations.*, java.util.Collection, org.jooq.LoaderFieldMapper.LoaderFieldContext, org.jooq.exception.LoaderConfigurationException

The Loader API is used for configuring data loads.

The step in constructing the Loader object where you can set the mandatory row loader options.

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:

Author
Lukas Eder

Method Summary

Modifier and TypeMethod and Description
public @NotNull LoaderListenerStep<R>
fields(Field<?>... fields)

Deprecated as a consequence of Field being deprecated.
Specify the the fields to be loaded into the table in the correct order.
public @NotNull LoaderListenerStep<R>
fields(Collection<? extends Field<?>> fields)

Specify the the fields to be loaded into the table in the correct order.

public @NotNull LoaderListenerStep<R>
fields(LoaderFieldMapper mapper)

Specify a function to apply on each input field to receive the target table's field.

public @NotNull LoaderCSVOptionsStep<R>
fieldsCorresponding()

Indicate that all input fields which have a corresponding field in the target table (with the same name) should be loaded.

public @NotNull LoaderCSVOptionsStep<R>
fieldsFromSource()

Deprecated for removal since 3.14. - 3.14.0 - [#10010] - Use fieldsCorresponding() instead.
Indicate that all input fields which have a corresponding field in the target table (with the same name) should be loaded.

Method Detail

fieldsback to summary
public @NotNull LoaderListenerStep<R> fields(Field<?>... fields)

Deprecated

as a consequence of Field being deprecated. See corresponding docs for further information.

Specify the the fields to be loaded into the table in the correct order.

The record column at index i is inserted into the table field at index i. If fields[i] == null or fields.length <= i, then the record column is skipped.

Annotations
@NotNull
@CheckReturnValue
@Support
fieldsback to summary
public @NotNull LoaderListenerStep<R> fields(Collection<? extends Field<?>> fields)

Specify the the fields to be loaded into the table in the correct order.

The record column at index i is inserted into the table field at index i. If new ArrayList(fields).get(i) == null or new ArrayList(fields).size() <= i, then the record column is skipped.

Annotations
@NotNull
@CheckReturnValue
@Support
fieldsback to summary
public @NotNull LoaderListenerStep<R> fields(LoaderFieldMapper mapper)

Specify a function to apply on each input field to receive the target table's field.

The input field obtained from LoaderFieldContext#field() corresponds to the source record field, if any, or an unspecified field enumeration is used. The LoaderFieldContext#index() property corresponds to the source column index.

Annotations
@NotNull
@CheckReturnValue
@Support
fieldsCorrespondingback to summary
public @NotNull LoaderCSVOptionsStep<R> fieldsCorresponding()

Indicate that all input fields which have a corresponding field in the target table (with the same name) should be loaded.

Annotations
@NotNull
@CheckReturnValue
@Support
Exceptions
LoaderConfigurationException:
When the source data does not expose field names.
fieldsFromSourceback to summary
public @NotNull LoaderCSVOptionsStep<R> fieldsFromSource()

Deprecated

for removal since 3.14.

- 3.14.0 - [#10010] - Use fieldsCorresponding() instead.

Indicate that all input fields which have a corresponding field in the target table (with the same name) should be loaded.

Annotations
@Deprecated
forRemoval:true
since:3.14
@NotNull
@CheckReturnValue
@Support
Exceptions
LoaderConfigurationException:
When the source data does not expose field names.