org.jooq.LoaderCSVOptionsStep Maven / Gradle / Ivy
/**
* Copyright (c) 2009-2014, Data Geekery GmbH (http://www.datageekery.com)
* All rights reserved.
*
* This work is dual-licensed
* - under the Apache Software License 2.0 (the "ASL")
* - under the jOOQ License and Maintenance Agreement (the "jOOQ License")
* =============================================================================
* You may choose which license applies to you:
*
* - If you're using this work with Open Source databases, you may choose
* either ASL or jOOQ License.
* - If you're using this work with at least one commercial database, you must
* choose jOOQ License
*
* For more information, please visit http://www.jooq.org/licenses
*
* Apache Software License 2.0:
* -----------------------------------------------------------------------------
* 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.
*
* jOOQ License and Maintenance Agreement:
* -----------------------------------------------------------------------------
* Data Geekery grants the Customer the non-exclusive, timely limited and
* non-transferable license to install and use the Software under the terms of
* the jOOQ License and Maintenance Agreement.
*
* This library is distributed with a LIMITED WARRANTY. See the jOOQ License
* and Maintenance Agreement for more details: http://www.jooq.org/licensing
*/
package org.jooq;
/**
* 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.
*
* @author Lukas Eder
*/
public interface LoaderCSVOptionsStep> extends LoaderLoadStep {
/**
* 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.
*/
@Support
LoaderCSVOptionsStep ignoreRows(int number);
/**
* Specify the quote character. By default, this is "
*/
@Support
LoaderCSVOptionsStep quote(char quote);
/**
* Specify the separator character. By default, this is ,
*/
@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.
*/
@Support
LoaderCSVOptionsStep nullString(String nullString);
}