org.jooq.Loader 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 java.sql.Statement;
import java.util.List;
import org.jetbrains.annotations.NotNull;
/**
* The Loader API is used for configuring data loads.
*
* This type is the final type holding information about the outcome of the data
* load.
*
* @author Lukas Eder
*/
public interface Loader {
/**
* A list of errors that might have happened during the load.
*/
@NotNull @CheckReturnValue
List errors();
/**
* The number of processed rows.
*/
int processed();
/**
* The number of executed statements, bulk statements, or batch statements.
*/
int executed();
/**
* The number of ignored rows.
*
* If using {@link LoaderOptionsStep#onDuplicateKeyIgnore()} along with
* {@link LoaderOptionsStep#batchAll()} or
* {@link LoaderOptionsStep#batchAfter(int)}, it may be possible that some
* dialects will not produce the correct ignored count, as the respective
* JDBC drivers cannot produce this count over
* {@link Statement#executeBatch()} and related methods.
*/
int ignored();
/**
* The number of inserted or updated rows.
*/
int stored();
/**
* The results that are also returned from {@link Loader}.
*/
@NotNull @CheckReturnValue
LoaderContext result();
}