Module org.jooq
Package org.jooq

Interface LoaderCSVOptionsStep<R extends Record>

All Superinterfaces:
LoaderListenerStep<R>, LoaderLoadStep<R>
public interface LoaderCSVOptionsStep<R extends Record> extends LoaderListenerStep<R>
The Loader API is used for configuring data loads.

The step in constructing the Loader object where you can set the optional CSV 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:

  • 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 Details

    • ignoreRows

      @NotNull @CheckReturnValue @Support @NotNull LoaderCSVOptionsStep<R> ignoreRows​(int number)
      Specify that a certain number of rows should be ignored from the CSV file. This is useful for skipping processing information

      By default, this is set to 1, as CSV files are expected to hold a header row.

      Parameters:
      number - The number of rows to ignore.

    • quote

      @NotNull @CheckReturnValue @Support @NotNull LoaderCSVOptionsStep<R> quote​(char quote)
      Specify the quote character. By default, this is "

    • separator

      @NotNull @CheckReturnValue @Support @NotNull LoaderCSVOptionsStep<R> separator​(char separator)
      Specify the separator character. By default, this is ,

    • nullString

      @NotNull @CheckReturnValue @Support @NotNull LoaderCSVOptionsStep<R> nullString​(String nullString)
      Specify the input string representation of NULL.

      By default, this is set to null, which means that all empty strings are loaded into the database as such. In some databases (e.g. SQLDialect.ORACLE), this is effectively the same as loading NULL.

      In order to treat empty strings as null, you can set the nullString to "". If the null string is overridden with something like {null}, for instance, then empty strings will also be loaded as such by jOOQ.