org.jooq.LoaderCSVStep 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.*;
import java.util.Collection;
import org.jooq.LoaderFieldMapper.LoaderFieldContext;
import org.jooq.exception.LoaderConfigurationException;
/**
* The Loader API is used for configuring data loads.
*
* The step in constructing the {@link Loader} object where you can set the
* mandatory 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 LoaderCSVStep {
/**
* Specify the the fields to be loaded into the table in the correct order.
*
* The CSV column at index i is inserted into the table field
* at index i. If fields[i] == null or
* fields.length <= i, then the CSV column is skipped.
*/
@NotNull @CheckReturnValue
@Support
LoaderCSVOptionsStep fields(Field... fields);
/**
* Specify the the fields to be loaded into the table in the correct order.
*
* The CSV 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 CSV column is
* skipped.
*/
@NotNull @CheckReturnValue
@Support
LoaderCSVOptionsStep fields(Collection> fields);
/**
* Specify a function to apply on each input field to receive the target
* table's field.
*
* The input field obtained from {@link LoaderFieldContext#field()} wraps
* the CSV header column name if any, or an unspecified field enumeration is
* used. The {@link LoaderFieldContext#index()} property corresponds to the
* CSV column index.
*/
@NotNull @CheckReturnValue
@Support
LoaderCSVOptionsStep fields(LoaderFieldMapper mapper);
/**
* Indicate that all input fields which have a corresponding field in the
* target table (with the same name) should be loaded.
*
* @throws LoaderConfigurationException When the source data does not expose
* field names.
* @deprecated - 3.14.0 - [#10010] - Use {@link #fieldsCorresponding()}
* instead.
*/
@Deprecated(forRemoval = true, since = "3.14")
@NotNull @CheckReturnValue
@Support
LoaderCSVOptionsStep fieldsFromSource();
/**
* Indicate that all input fields which have a corresponding field in the
* target table (with the same name) should be loaded.
*
* @throws LoaderConfigurationException When the source data does not expose
* field names.
*/
@NotNull @CheckReturnValue
@Support
LoaderCSVOptionsStep fieldsCorresponding();
}