org.mybatis.dynamic.sql.util.mybatis3.CommonInsertMapper Maven / Gradle / Ivy

Go to download
/*
 *    Copyright ${license.git.copyrightYears} the original author or authors.
 *
 *    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.
 */
package org.mybatis.dynamic.sql.util.mybatis3;

import java.util.List;

import org.apache.ibatis.annotations.Flush;
import org.apache.ibatis.annotations.InsertProvider;
import org.apache.ibatis.executor.BatchResult;
import org.mybatis.dynamic.sql.insert.render.GeneralInsertStatementProvider;
import org.mybatis.dynamic.sql.insert.render.InsertSelectStatementProvider;
import org.mybatis.dynamic.sql.insert.render.InsertStatementProvider;
import org.mybatis.dynamic.sql.insert.render.MultiRowInsertStatementProvider;
import org.mybatis.dynamic.sql.util.SqlProviderAdapter;

/**
 * This is a general purpose mapper for executing various types of insert statements.
 * This mapper is appropriate for insert statements that do NOT expect generated keys.
 *
 * @param  the type of record associated with this mapper
 */
public interface CommonInsertMapper {
    /**
     * Execute an insert statement with input fields mapped to values in a POJO.
     *
     * @param insertStatement the insert statement
     * @return the number of rows affected
     */
    @InsertProvider(type = SqlProviderAdapter.class, method = "insert")
    int insert(InsertStatementProvider insertStatement);

    /**
     * Execute an insert statement with input fields supplied directly.
     *
     * @param insertStatement the insert statement
     * @return the number of rows affected
     */
    @InsertProvider(type = SqlProviderAdapter.class, method = "generalInsert")
    int generalInsert(GeneralInsertStatementProvider insertStatement);

    /**
     * Execute an insert statement with input fields supplied by a select statement.
     *
     * @param insertSelectStatement the insert statement
     * @return the number of rows affected
     */
    @InsertProvider(type = SqlProviderAdapter.class, method = "insertSelect")
    int insertSelect(InsertSelectStatementProvider insertSelectStatement);

    /**
     * Execute an insert statement that inserts multiple rows. The row values are supplied by mapping
     * to values in a List of POJOs.
     *
     * @param insertStatement the insert statement
     * @return the number of rows affected
     */
    @InsertProvider(type = SqlProviderAdapter.class, method = "insertMultiple")
    int insertMultiple(MultiRowInsertStatementProvider insertStatement);

    /**
     * Flush batched insert statements and return details of the current batch.
     * This is useful when there is no direct access to the @link({@link org.apache.ibatis.session.SqlSession}.
     *
     * @return details about the current batch including update counts, etc.
     */
    @Flush
    List flush();
}