io.gallery.db.mapper.DataBaseMapper Maven / Gradle / Ivy

Go to download
package io.gallery.db.mapper;

import io.gallery.db.bean.DataBaseGenericPage;
import io.gallery.db.util.DataBaseProvider;
import org.apache.ibatis.annotations.*;
import org.springframework.cache.annotation.Cacheable;
import org.springframework.transaction.annotation.Transactional;

import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

@Mapper
public interface DataBaseMapper {

    /**
     * 表字段缓存名称
     */
    String CACHE_COLUMNS_NAME = "columns";

    /**
     * 新增记录
     *
     * @param record Entity
     * @return int
     */
    @Transactional
    @InsertProvider(type = DataBaseProvider.class, method = "insert")
    @Options(useGeneratedKeys = true, keyProperty = "generatedKey")
    int insert(Entity record);

    /**
     * 根据主键删除记录
     *
     * @param input Map
     * @return int
     */
    @Transactional
    @DeleteProvider(type = DataBaseProvider.class, method = "delete")
    int delete(Map input);

    /**
     * 根据条件删除记录
     *
     * @param input Map
     * @return int
     */
    @Transactional
    @DeleteProvider(type = DataBaseProvider.class, method = "deleteByParams")
    int deleteByParams(Map input);

    /**
     * 根据主键更新记录
     *
     * @param record Entity
     * @return int
     */
    @Transactional
    @UpdateProvider(type = DataBaseProvider.class, method = "update")
    int update(Entity record);

    /**
     * 根据条件获取列表
     *
     * @param input Map
     * @return 实体类列表
     */
    @SelectProvider(type = DataBaseProvider.class, method = "select")
    List select(Map input);

    /**
     * 根据条件获取第一条记录
     *
     * @param input Map
     * @return 实体类
     */
    @SelectProvider(type = DataBaseProvider.class, method = "selectOne")
    LinkedHashMap selectOne(Map input);

    /**
     * 根据条件获取数量
     *
     * @param input Map
     * @return long
     */
    @SelectProvider(type = DataBaseProvider.class, method = "count")
    long count(Map input);

    /**
     * 设置列表检索条件
     *
     * @param query 检索条件入参
     * @return 检索条件出参
     */
    Example setCondition(Query query);

    /**
     * 获取字段列表(columnname::columntype)
     *
     * @param table  String
     * @param schema String
     * @return 列表
     */
    @Cacheable(cacheNames = {CACHE_COLUMNS_NAME})
    @SelectProvider(type = DataBaseProvider.class, method = "columns")
    List columns(@Param("table") String table, @Param("schema") String schema);

    /**
     * 执行自定义SQL
     *
     * @param sql String
     * @return List
     */
    @SelectProvider(type = DataBaseProvider.class, method = "execute")
    List execute(String sql);

    /**
     * 执行自定义SQL
     *
     * @param sql String
     * @return long
     */
    @SelectProvider(type = DataBaseProvider.class, method = "execute")
    long executeCount(String sql);

    /**
     * 执行自定义SQL
     *
     * @param sql String
     * @return LinkedHashMap
     */
    @SelectProvider(type = DataBaseProvider.class, method = "execute")
    LinkedHashMap executeOne(String sql);

    /**
     * 执行自定义SQL
     *
     * @param params Map
     * @return List
     */
    @SelectProvider(type = DataBaseProvider.class, method = "executeWithParams")
    List executeWithParams(Map params);

    /**
     * 执行自定义SQL
     *
     * @param params Map
     * @return LinkedHashMap
     */
    @SelectProvider(type = DataBaseProvider.class, method = "executeWithParams")
    LinkedHashMap executeWithParamsOne(Map params);

    /**
     * 执行自定义SQL
     *
     * @param params Map
     * @return long
     */
    @SelectProvider(type = DataBaseProvider.class, method = "executeWithParams")
    long executeWithParamsCount(Map params);

    /**
     * 执行自定义SQL
     *
     * @param params Map
     * @return int
     */
    @UpdateProvider(type = DataBaseProvider.class, method = "executeWithParams")
    int executeInsertOrUpdate(Map params);

    /**
     * 执行自定义SQL
     *
     * @param sql String
     */
    @UpdateProvider(type = DataBaseProvider.class, method = "execute")
    void exec(String sql);

    /**
     * 执行自定义SQL
     *
     * @param input Map
     */
    @UpdateProvider(type = DataBaseProvider.class, method = "executeWithParams")
    void execWithParams(Map input);
}