org.jooq.LoaderCSVOptionsStep Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Other licenses:
* -----------------------------------------------------------------------------
* Commercial licenses for this work are available. These replace the above
* Apache-2.0 license and offer limited warranties, support, maintenance, and
* commercial database integrations.
*
* For more information, please visit: http://www.jooq.org/licenses
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package org.jooq;
import org.jetbrains.annotations.*;
/**
* The Loader API is used for configuring data loads.
*
* The step in constructing the {@link 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
*/
public interface LoaderCSVOptionsStep extends LoaderListenerStep {
/**
* 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.
*
* @param number The number of rows to ignore.
*/
@NotNull @CheckReturnValue
@Support
LoaderCSVOptionsStep ignoreRows(int number);
/**
* Specify the quote character. By default, this is "
*/
@NotNull @CheckReturnValue
@Support
LoaderCSVOptionsStep quote(char quote);
/**
* Specify the separator character. By default, this is ,
*/
@NotNull @CheckReturnValue
@Support
LoaderCSVOptionsStep separator(char separator);
/**
* 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.
* {@link 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.
*/
@NotNull @CheckReturnValue
@Support
LoaderCSVOptionsStep nullString(String nullString);
}