Package com.pugwoo.dbhelper

Interface DBHelper

All Known Implementing Classes:
P0_JdbcTemplateOp, P1_QueryOp, P2_InsertOp, P3_UpdateOp, P4_InsertOrUpdateOp, P5_DeleteOp, P6_ExecuteOp, SpringJdbcDBHelper
public interface DBHelper
2015年8月17日 18:18:57
Author:
pugwoo

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.slf4j.Logger
    LOGGER
     

  • Method Summary

    Modifier and Type
    Method
    Description
    <T> int
    delete(Class<T> clazz, String postSql, Object... args)
    自定义条件删除数据，该操作【会】自动使用软删除标记。 对于使用了拦截器和deleteValueScript的场景，该方法的实现是先根据条件查出数据，再批量删除，以便拦截器可以记录下实际被删的数据，此时删除性能可能比较差，请权衡使用。
    <T> int
    delete(Collection<T> list)
    删除数据库记录，返回数据库实际修改条数。 推荐使用单个主键的表使用该方法，当list所有对象都是同一个类时，将会拼凑为一条sql进行删除，效率提升多。 该操作【会】自动使用软删除进行删除
    <T> int
    delete(T t)
    删除数据库记录，返回数据库实际修改条数。 该操作【会】自动使用软删除进行删除
    <T> int
    deleteHard(Class<T> clazz, String postSql, Object... args)
    自定义条件删除数据（无论是否注解了软删除字段）。
    对于使用了拦截器和deleteValueScript的场景，该方法的实现是先根据条件查出数据，再批量删除，以便拦截器可以记录下实际被删的数据，此时删除性能可能比较差，请权衡使用。
    <T> int
    deleteHard(Collection<T> list)
    硬删除数据库记录（无论是否注解了软删除字段），返回数据库实际修改条数。 推荐使用单个主键的表使用该方法，当list所有对象都是同一个类时，将会拼凑为一条sql进行删除，效率提升多。
    <T> int
    deleteHard(T t)
    硬删除数据库记录（无论是否注解了软删除字段），返回数据库实际修改条数。
    static void
    disableCache()
    关闭DBHelper的缓存，目前缓存DO类信息
    static void
    enableCache()
    开启DBHelper的缓存，目前缓存DO类信息，默认开启
    boolean
    executeAfterCommit(Runnable runnable)
    当前事务提交后执行
    int
    executeRaw(String sql, Object... args)
    执行自行指定的SQL语句，支持in(?)表达式，支持INSERT UPDATE DELETE TRUNCATE操作
    int
    executeRaw(String sql, Map<String,?> paramMap)
    执行自行指定的SQL语句，支持通过namedParameter的方式传入参数，支持in(?)表达式，支持INSERT UPDATE DELETE TRUNCATE操作
    <T> List<T>
    getAll(Class<T> clazz)
    查询列表，查询所有记录，如果数据量大请慎用
    【会自动处理软删除记录】
    <T> List<T>
    getAll(Class<T> clazz, String postSql, Object... args)
    查询列表，查询所有记录，postSql指定查询where及order by limit等后续语句。
    【会自动处理软删除记录】
    <T> Stream<T>
    getAllForStream(Class<T> clazz)
    查询列表，查询所有记录，以Stream形式返回
    【特别注意】为了确保Stream方式查询有效，请确保jdbc的URL参数带上：useCursorFetch=true
    说明：可以通过setFetchSize方法修改流式获取数据时，每次获取的数据条数
    说明：Stream方式不会调用拦截器的afterQuery
    【会自动处理软删除记录】
    <T> Stream<T>
    getAllForStream(Class<T> clazz, String postSql, Object... args)
    查询列表，查询所有记录，postSql指定查询where及order by limit等后续语句。以Stream形式返回
    【特别注意】为了确保Stream方式查询有效，请确保jdbc的URL参数带上：useCursorFetch=true
    说明：可以通过setFetchSize方法修改流式获取数据时，每次获取的数据条数
    说明：Stream方式不会调用拦截器的afterQuery
    【会自动处理软删除记录】
    <T> List<T>
    getAllKey(Class<T> clazz, String postSql, Object... args)
    查询列表，但只查询主键出来，postSql指定查询where及order by limit等后续语句。
    【会自动处理软删除记录】
    <T> List<T>
    getByExample(T t, int limit)
    根据给定的对象t查询跟t的非null值完全相等的记录。 因为很容易出现当t的全部属性全为null时，把整个表都查询出来的问题，特要求调用者给定limit参数，该参数为返回的最大条目数。
    <T> T
    getByKey(Class<T> clazz, Object keyValue)
    适合于只有一个Key的情况，多主键的情况请使用getOne
    【会自动处理软删除记录】
    <T> long
    getCount(Class<T> clazz)
    计算总数
    【会自动处理软删除记录】
    <T> long
    getCount(Class<T> clazz, String postSql, Object... args)
    计算总数
    【会自动处理软删除记录】
    DatabaseTypeEnum
    getDatabaseType()
    查询dbHelper对应的数据库类型
    <T> T
    getOne(Class<T> clazz)
    查询一条记录，如果有多条，也只返回第一条。该方法适合于知道返回值只有一条记录的情况。
    【会自动处理软删除记录】
    <T> T
    getOne(Class<T> clazz, String postSql, Object... args)
    查询一条记录，如果有多条，也只返回第一条。该方法适合于知道返回值只有一条记录的情况。
    【会自动处理软删除记录】
    <T> PageData<T>
    getPage(Class<T> clazz, int page, int pageSize)
    查询列表，没有查询条件
    【会自动处理软删除记录】
    <T> PageData<T>
    getPage(Class<T> clazz, int page, int pageSize, String postSql, Object... args)
    查询列表，postSql可以带查询条件
    【会自动处理软删除记录】
    <T> PageData<T>
    getPageWithoutCount(Class<T> clazz, int page, int pageSize)
    查询列表，没有查询条件；不查询总数
    【会自动处理软删除记录】
    <T> PageData<T>
    getPageWithoutCount(Class<T> clazz, int page, int pageSize, String postSql, Object... args)
    查询列表，postSql可以带查询条件；不查询总数
    【会自动处理软删除记录】
    <T> List<T>
    getRaw(Class<T> clazz, String sql, Object... args)
    执行自行指定的SQL查询语句
    <T> List<T>
    getRaw(Class<T> clazz, String sql, Map<String,?> args)
    执行自行指定的SQL查询语句，支持通过namedParameter的方式传入参数，放到args里面
    <T> Stream<T>
    getRawForStream(Class<T> clazz, String sql, Object... args)
    执行自行指定的SQL查询语句，以流Stream的形式返回。
    【特别注意】为了确保Stream方式查询有效，请确保jdbc的URL参数带上：useCursorFetch=true
    说明：可以通过setFetchSize方法修改流式获取数据时，每次获取的数据条数
    说明：Stream方式不会调用拦截器的afterQuery
    <T> Stream<T>
    getRawForStream(Class<T> clazz, String sql, Map<String,?> args)
    执行自行指定的SQL查询语句，支持通过namedParameter的方式传入参数，放到args里面，以流Stream的形式返回。
    【特别注意】为了确保Stream方式查询有效，请确保jdbc的URL参数带上：useCursorFetch=true
    说明：可以通过setFetchSize方法修改流式获取数据时，每次获取的数据条数
    说明：Stream方式不会调用拦截器的afterQuery
    <T> T
    getRawOne(Class<T> clazz, String sql, Object... args)
    执行自行指定的SQL查询语句，只返回第一行 （特别说明，当有多行时也只返回第一行而不会失败或告警）
    <T> T
    getRawOne(Class<T> clazz, String sql, Map<String,?> args)
    执行自行指定的SQL查询语句，支持通过namedParameter的方式传入参数，放到args里面，只返回第一行 （特别说明，当有多行时也只返回第一行而不会失败或告警）
    <T> void
    handleRelatedColumn(List<T> list)
    单独抽离出处理RelatedColumn的类，参数list的元素不需要@Table的注解了。但要求list都同一class类型的对象。
    <T> void
    handleRelatedColumn(List<T> list, String... relatedColumnProperties)
    单独抽离出处理RelatedColumn的类，参数list的元素不需要@Table的注解了。但要求list都同一class类型的对象。
    <T> void
    handleRelatedColumn(T t)
    单独抽离出处理RelatedColumn的类，参数t不需要@Table的注解了
    <T> void
    handleRelatedColumn(T t, String... relatedColumnProperties)
    单独抽离出处理RelatedColumn的类，参数t不需要@Table的注解了
    int
    insert(Collection<?> list)
    批量插入多条记录，返回数据库实际修改的条数。
    【说明】该方法没有事务，请在外层加事务。
    【特别说明】因为需要获取自增主键，对于有自增id的插入，会降级为逐条插入，如果想提升性能，请使用insertBatchWithoutReturnId方法。
    <T> int
    insert(T t)
    插入一条记录
    如果包含了自增id，则自增Id会被设置。
    【注】只插入非null的值，如要需要插入null值，则用insertWithNull。
    int
    insertBatchWithoutReturnId(String tableName, Collection<Map<String,Object>> list)
    批量插入多条记录，返回数据库实际修改的条数。【不支持拦截器】
    int
    insertBatchWithoutReturnId(String tableName, List<String> cols, Collection<Object[]> values)
    以JDBCTemplate的batchUpdate方式，批量插入多条记录，返回数据库实际修改的条数。【不支持拦截器】
    <T> int
    insertBatchWithoutReturnId(Collection<T> list)
    批量插入多条记录，返回数据库实际修改的条数。

    【重点】不会自动设置插入数据的返回自增ID（拦截器里也拿不到ID），也不会设置回数据库的默认值
    <T> int
    insertOrUpdate(Collection<T> list)
    如果t有主键，则更新值；否则插入记录。只有非null的值会更新或插入。
    <T> int
    insertOrUpdate(T t)
    如果t有主键，则更新值；否则插入记录。只有非null的值会更新或插入。
    <T> int
    insertOrUpdateWithNull(T t)
    如果t有主键，则更新值；否则插入记录。包括null的值会更新或插入。
    <T> int
    insertWithNull(T t)
    插入一条记录，返回数据库实际修改条数。
    如果包含了自增id，则自增Id会被设置。
    static boolean
    isCacheEnabled()
    是否开启了DBHelper的缓存，目前缓存DO类信息，默认开启
    <T> boolean
    isExist(Class<T> clazz, String postSql, Object... args)
    是否出现至少一条记录
    <T> boolean
    isExistAtLeast(int atLeastCounts, Class<T> clazz, String postSql, Object... args)
    是否出现至少N条记录(含N条)
    void
    rollback()
    手动回滚@Transactional的事务。 对于已知需要回滚的动作，我更推荐主动调用让其回滚，而非抛出RuntimeException。 当前如果没有事务而调用该方法，将抛出org.springframework.transaction.NoTransactionException。

    对于手动回滚事务rollback抛出`org.springframework.transaction.UnexpectedRollbackException: Transaction rolled back because it has been marked as rollback-only` 异常的情况，需要使用者保证满足以下两点中的任意一点：
    1) 调用rollback的代码所在的方法是注解了@Transactional最外层的方法；
    2) 调用rollback的代码最近的@Transactional注解加上propagation = Propagation.NESTED属性。
    void
    setFetchSize(int fetchSize)
    对于流式Stream获取数据的，可以指定fetchSize大小，默认1000
    static void
    setGlobalComment(String comment)
    设置全局的SQL注释，设置后每条执行的SQL都将自动带上该注释到数据库中执行。
    说明：该方法会对所有的DBHelper实例生效。
    void
    setInterceptors(List<DBHelperInterceptor> interceptors)
    数据库拦截器
    static void
    setLocalComment(String comment)
    设置线程上下文的SQL注释，设置后当前线程执行的每条SQL都将自动带上该注释到数据库中执行。
    说明：该方法会对所有的DBHelper实例生效。
    void
    setMaxPageSize(int maxPageSize)
    设置允许的每页最大的个数，当页数超过允许的最大页数时，设置为最大页数。 默认对每页最大个数没有限制，该限制只对getPage和getPageWithoutCount接口生效。
    void
    setTimeoutWarningCallback(IDBHelperSlowSqlCallback callback)
    设置SQL执行超时回调，可用于自行实现将慢sql存放到db
    void
    setTimeoutWarningValve(long timeMS)
    设置SQL执行超时的WARN log，超时时间默认为1秒
    void
    turnOffFeature(FeatureEnum featureEnum)
    关闭某个特性
    void
    turnOnFeature(FeatureEnum featureEnum)
    开启某个特性
    <T> int
    update(Collection<T> list)
    批量更新数据库记录，返回数据库实际修改条数。【只更新非null字段，需要更新null字段请使用updateWithNull方法】

    当符合以下条件时，更新数据将转换成真正的批量更新，性能可提升100倍左右：
    1) list中所有的元素都是相同的类
    2) list中所有的元素都有且只有一个主键，且主键有值（多主键场景很少，后续有时间再支持多主键）
    特别说明：如果有cas版本，会抛出CasVersionNotMatchException异常（可以从该异常中获取实际的修改行数），需要自行注解@Transactional事务进行回滚，否则修改的数据不会回滚。此外，clickhouse不支持有cas的批量更新操作，一般情况下也不会使用clickhouse进行批量cas update操作。
    <T> int
    update(T t)
    更新单条数据库记录,必须带上object的key。【只更新非null字段】
    <T> int
    update(T t, String postSql, Object... args)
    更新单条数据库记录,必须带上object的key，主要用于mysql的update ...
    <T> int
    updateAll(Class<T> clazz, String setSql, String whereSql, Object... args)
    自定义更新多行记录，会自动去掉已软删除的行。 【重要更新 since 1.0.0】该方法修改的记录，不会再调用afterUpdate方法，如果需要获得被修改的行记录，请考虑使用canal方案。
    <T> int
    updateCustom(T t, String setSql, Object... args)
    自定义set字句更新，用于单个sql进行值更新，例如set reads = reads + 1这种情况。
    <T> int
    updateWithNull(T t)
    更新单个实例数据库记录，必须带上object的key，包含更新null值的字段
    <T> int
    updateWithNull(T t, String postSql, Object... args)
    带条件的更新单个对象，必须带上object的key，主要用于mysql的update ...
    static void
    withTableNames(Map<Class<?>,String> tableNames, Runnable runnable)
    获取指定类的表名，适合于分表场景；执行完成后会自动还原成原来的表名。

  • Field Details

    • LOGGER

      static final org.slf4j.Logger LOGGER

  • Method Details

    • withTableNames

      static void withTableNames(Map<Class<?>,String> tableNames, Runnable runnable)
      获取指定类的表名，适合于分表场景；执行完成后会自动还原成原来的表名。
      Parameters:
      tableNames - 设置DO类对应的表名
      runnable - 要执行的代码

    • setGlobalComment

      static void setGlobalComment(String comment)
      设置全局的SQL注释，设置后每条执行的SQL都将自动带上该注释到数据库中执行。
      说明：该方法会对所有的DBHelper实例生效。
      Parameters:
      comment - SQL注释（不需要加注释的标识），空字符串为清空

    • setLocalComment

      static void setLocalComment(String comment)
      设置线程上下文的SQL注释，设置后当前线程执行的每条SQL都将自动带上该注释到数据库中执行。
      说明：该方法会对所有的DBHelper实例生效。
      Parameters:
      comment - SQL注释（不需要加注释的标识），空字符串为清空

    • enableCache

      static void enableCache()
      开启DBHelper的缓存，目前缓存DO类信息，默认开启

    • disableCache

      static void disableCache()
      关闭DBHelper的缓存，目前缓存DO类信息

    • isCacheEnabled

      static boolean isCacheEnabled()
      是否开启了DBHelper的缓存，目前缓存DO类信息，默认开启
      Returns:
      true表示开启

    • turnOnFeature

      void turnOnFeature(FeatureEnum featureEnum)
      开启某个特性
      Parameters:
      featureEnum - 特性枚举，默认特性是否开启详见特性文档说明

    • turnOffFeature

      void turnOffFeature(FeatureEnum featureEnum)
      关闭某个特性
      Parameters:
      featureEnum - 特性枚举，默认特性是否开启详见特性文档说明

    • getDatabaseType

      DatabaseTypeEnum getDatabaseType()
      查询dbHelper对应的数据库类型

    • rollback

      void rollback()
      手动回滚@Transactional的事务。 对于已知需要回滚的动作，我更推荐主动调用让其回滚，而非抛出RuntimeException。 当前如果没有事务而调用该方法，将抛出org.springframework.transaction.NoTransactionException。

      对于手动回滚事务rollback抛出`org.springframework.transaction.UnexpectedRollbackException: Transaction rolled back because it has been marked as rollback-only` 异常的情况，需要使用者保证满足以下两点中的任意一点：
      1) 调用rollback的代码所在的方法是注解了@Transactional最外层的方法；
      2) 调用rollback的代码最近的@Transactional注解加上propagation = Propagation.NESTED属性。

    • executeAfterCommit

      boolean executeAfterCommit(Runnable runnable)
      当前事务提交后执行
      Parameters:
      runnable - 执行的回调方法
      Returns:
      当提交成功返回true，提交失败返回false；如果当前不在事务中时，返回false

    • setTimeoutWarningValve

      void setTimeoutWarningValve(long timeMS)
      设置SQL执行超时的WARN log，超时时间默认为1秒
      Parameters:
      timeMS - 毫秒

    • setMaxPageSize

      void setMaxPageSize(int maxPageSize)
      设置允许的每页最大的个数，当页数超过允许的最大页数时，设置为最大页数。 默认对每页最大个数没有限制，该限制只对getPage和getPageWithoutCount接口生效。
      Parameters:
      maxPageSize - 允许的每页最大的个数

    • setFetchSize

      void setFetchSize(int fetchSize)
      对于流式Stream获取数据的，可以指定fetchSize大小，默认1000
      Parameters:
      fetchSize - fetchSize

    • setTimeoutWarningCallback

      void setTimeoutWarningCallback(IDBHelperSlowSqlCallback callback)
      设置SQL执行超时回调，可用于自行实现将慢sql存放到db
      Parameters:
      callback - 执行的回调方法

    • setInterceptors

      void setInterceptors(List<DBHelperInterceptor> interceptors)
      数据库拦截器
      Parameters:
      interceptors - 拦截器列表，全量更新

    • getByKey

      <T> T getByKey(Class<T> clazz, Object keyValue) throws NullKeyValueException
      适合于只有一个Key的情况，多主键的情况请使用getOne
      【会自动处理软删除记录】
      Parameters:
      clazz - 查询的DO的类class
      keyValue - 查询的主键key值
      Returns:
      如果不存在则返回null
      Throws:
      NullKeyValueException

    • getPage

      <T> PageData<T> getPage(Class<T> clazz, int page, int pageSize)
      查询列表，没有查询条件
      【会自动处理软删除记录】
      Parameters:
      clazz - 【-支持@JoinTable-】
      page - 从1开始
      pageSize - 每页查询个数
      Returns:
      返回的data不会是null

    • getPage

      <T> PageData<T> getPage(Class<T> clazz, int page, int pageSize, String postSql, Object... args)
      查询列表，postSql可以带查询条件
      【会自动处理软删除记录】
      Parameters:
      clazz - 【-支持@JoinTable-】
      page - 从1开始
      pageSize - 每页查询个数
      postSql - 包含where关键字起的后续SQL语句，【不能】包含limit子句
      args - postSql中的参数列表
      Returns:
      返回的data不会是null

    • getCount

      <T> long getCount(Class<T> clazz)
      计算总数
      【会自动处理软删除记录】
      Parameters:
      clazz - 【-支持@JoinTable-】
      Returns:
      总数

    • getCount

      <T> long getCount(Class<T> clazz, String postSql, Object... args)
      计算总数
      【会自动处理软删除记录】
      Parameters:
      clazz - 【-支持@JoinTable-】
      postSql - 包含where关键字起的后续SQL语句
      args - postSql中的参数列表
      Returns:
      总数

    • getPageWithoutCount

      <T> PageData<T> getPageWithoutCount(Class<T> clazz, int page, int pageSize)
      查询列表，没有查询条件；不查询总数
      【会自动处理软删除记录】
      Parameters:
      clazz - 【-支持@JoinTable-】
      page - 从1开始
      pageSize - 每页查询个数
      Returns:
      返回的data不会是null

    • getPageWithoutCount

      <T> PageData<T> getPageWithoutCount(Class<T> clazz, int page, int pageSize, String postSql, Object... args)
      查询列表，postSql可以带查询条件；不查询总数
      【会自动处理软删除记录】
      Parameters:
      clazz - 【-支持@JoinTable-】
      page - 从1开始
      pageSize - 每页查询个数
      postSql - 包含where关键字起的后续SQL语句
      Returns:
      返回的data不会是null

    • getAll

      <T> List<T> getAll(Class<T> clazz)
      查询列表，查询所有记录，如果数据量大请慎用
      【会自动处理软删除记录】
      Parameters:
      clazz - 【-支持@JoinTable-】
      Returns:
      返回不会是null

    • getAllForStream

      <T> Stream<T> getAllForStream(Class<T> clazz)
      查询列表，查询所有记录，以Stream形式返回
      【特别注意】为了确保Stream方式查询有效，请确保jdbc的URL参数带上：useCursorFetch=true
      说明：可以通过setFetchSize方法修改流式获取数据时，每次获取的数据条数
      说明：Stream方式不会调用拦截器的afterQuery
      【会自动处理软删除记录】
      Parameters:
      clazz - 【-支持@JoinTable-】
      Returns:
      返回不会是null【重要】请在获取完数据之后，close stream，不然会一直占用数据库连接。

    • getAll

      <T> List<T> getAll(Class<T> clazz, String postSql, Object... args)
      查询列表，查询所有记录，postSql指定查询where及order by limit等后续语句。
      【会自动处理软删除记录】
      Parameters:
      clazz - 【-支持@JoinTable-】
      postSql - where及后续语句，可包含order by,group by,limit等语句
      Returns:
      返回不会是null

    • getAllForStream

      <T> Stream<T> getAllForStream(Class<T> clazz, String postSql, Object... args)
      查询列表，查询所有记录，postSql指定查询where及order by limit等后续语句。以Stream形式返回
      【特别注意】为了确保Stream方式查询有效，请确保jdbc的URL参数带上：useCursorFetch=true
      说明：可以通过setFetchSize方法修改流式获取数据时，每次获取的数据条数
      说明：Stream方式不会调用拦截器的afterQuery
      【会自动处理软删除记录】
      Parameters:
      clazz - 【-支持@JoinTable-】
      postSql - where及后续语句，可包含order by,group by,limit等语句
      Returns:
      返回不会是null【重要】请在获取完数据之后，close stream，不然会一直占用数据库连接。

    • getAllKey

      <T> List<T> getAllKey(Class<T> clazz, String postSql, Object... args)
      查询列表，但只查询主键出来，postSql指定查询where及order by limit等后续语句。
      【会自动处理软删除记录】
      Parameters:
      clazz - 【-支持@JoinTable-】
      postSql - where及后续语句，可包含order by,group by,limit等语句
      Returns:
      返回不会是null

    • getOne

      <T> T getOne(Class<T> clazz)
      查询一条记录，如果有多条，也只返回第一条。该方法适合于知道返回值只有一条记录的情况。
      【会自动处理软删除记录】
      Parameters:
      clazz - 【-支持@JoinTable-】
      Returns:
      如果不存在则返回null

    • getOne

      <T> T getOne(Class<T> clazz, String postSql, Object... args)
      查询一条记录，如果有多条，也只返回第一条。该方法适合于知道返回值只有一条记录的情况。
      【会自动处理软删除记录】
      Parameters:
      clazz - 查询的DO类【-支持@JoinTable-】
      postSql - where及后续语句，可包含order by,group by等语句
      args - postSql中的参数列表
      Returns:
      如果不存在则返回null

    • getRaw

      <T> List<T> getRaw(Class<T> clazz, String sql, Object... args)
      执行自行指定的SQL查询语句
      Parameters:
      clazz - 转换回来的DO类，也支持关联查询后处理；支持基本类型如Integer/Long/String等; 特别说明，对于Long和Integer，如果数据库返回的是null，由于ResultSet的getInt会返回0，所以这里也返回0
      sql - 自定义SQL
      args - 自定义参数

    • getRaw

      <T> List<T> getRaw(Class<T> clazz, String sql, Map<String,?> args)
      执行自行指定的SQL查询语句，支持通过namedParameter的方式传入参数，放到args里面
      Parameters:
      clazz - 转换回来的DO类，也支持关联查询后处理；支持基本类型如Integer/Long/String等; 特别说明，对于Long和Integer，如果数据库返回的是null，由于ResultSet的getInt会返回0，所以这里也返回0
      sql - 自定义SQL，参数用namedParameter的方式
      args - 自定义参数

    • getRawForStream

      <T> Stream<T> getRawForStream(Class<T> clazz, String sql, Object... args)
      执行自行指定的SQL查询语句，以流Stream的形式返回。
      【特别注意】为了确保Stream方式查询有效，请确保jdbc的URL参数带上：useCursorFetch=true
      说明：可以通过setFetchSize方法修改流式获取数据时，每次获取的数据条数
      说明：Stream方式不会调用拦截器的afterQuery
      Parameters:
      clazz - 转换回来的DO类，也支持关联查询后处理；支持基本类型如Integer/Long/String等; 特别说明，对于Long和Integer，如果数据库返回的是null，由于ResultSet的getInt会返回0，所以这里也返回0
      sql - 自定义SQL
      args - 自定义参数
      Returns:
      【重要】请在获取完数据之后，close stream，不然会一直占用数据库连接。

    • getRawForStream

      <T> Stream<T> getRawForStream(Class<T> clazz, String sql, Map<String,?> args)
      执行自行指定的SQL查询语句，支持通过namedParameter的方式传入参数，放到args里面，以流Stream的形式返回。
      【特别注意】为了确保Stream方式查询有效，请确保jdbc的URL参数带上：useCursorFetch=true
      说明：可以通过setFetchSize方法修改流式获取数据时，每次获取的数据条数
      说明：Stream方式不会调用拦截器的afterQuery
      Parameters:
      clazz - 转换回来的DO类，也支持关联查询后处理；支持基本类型如Integer/Long/String等; 特别说明，对于Long和Integer，如果数据库返回的是null，由于ResultSet的getInt会返回0，所以这里也返回0
      sql - 自定义SQL
      args - 自定义参数
      Returns:
      【重要】请在获取完数据之后，close stream，不然会一直占用数据库连接。

    • getRawOne

      <T> T getRawOne(Class<T> clazz, String sql, Object... args)
      执行自行指定的SQL查询语句，只返回第一行 （特别说明，当有多行时也只返回第一行而不会失败或告警）
      Parameters:
      clazz - 转换回来的DO类，也支持关联查询后处理；支持基本类型如Integer/Long/String等; 特别说明，对于Long和Integer，如果数据库返回的是null，由于ResultSet的getInt会返回0，所以这里也返回0
      sql - 自定义SQL
      args - 自定义参数

    • getRawOne

      <T> T getRawOne(Class<T> clazz, String sql, Map<String,?> args)
      执行自行指定的SQL查询语句，支持通过namedParameter的方式传入参数，放到args里面，只返回第一行 （特别说明，当有多行时也只返回第一行而不会失败或告警）
      Parameters:
      clazz - 转换回来的DO类，也支持关联查询后处理；支持基本类型如Integer/Long/String等; 特别说明，对于Long和Integer，如果数据库返回的是null，由于ResultSet的getInt会返回0，所以这里也返回0
      sql - 自定义SQL，参数用namedParameter的方式
      args - 自定义参数

    • getByExample

      <T> List<T> getByExample(T t, int limit)
      根据给定的对象t查询跟t的非null值完全相等的记录。 因为很容易出现当t的全部属性全为null时，把整个表都查询出来的问题，特要求调用者给定limit参数，该参数为返回的最大条目数。
      Parameters:
      t - 提供查询条件的对象t
      limit - 限制查询的最大条目数

    • isExist

      <T> boolean isExist(Class<T> clazz, String postSql, Object... args)
      是否出现至少一条记录
      Parameters:
      clazz - 查询的DO类
      postSql - 不能有limit子句
      args - postSql中的参数列表
      Returns:
      如果存在则返回true，否则返回false

    • isExistAtLeast

      <T> boolean isExistAtLeast(int atLeastCounts, Class<T> clazz, String postSql, Object... args)
      是否出现至少N条记录(含N条)
      Parameters:
      atLeastCounts - 至少有N条记录（isExist方法等级于atLeastCounts=1）
      clazz - 查询的DO类
      postSql - 不能有limit子句
      args - postSql中的参数列表
      Returns:
      如果存在则返回true，否则返回false

    • handleRelatedColumn

      <T> void handleRelatedColumn(T t)
      单独抽离出处理RelatedColumn的类，参数t不需要@Table的注解了
      Parameters:
      t - 需要处理RelatedColumn的对象

    • handleRelatedColumn

      <T> void handleRelatedColumn(List<T> list)
      单独抽离出处理RelatedColumn的类，参数list的元素不需要@Table的注解了。但要求list都同一class类型的对象。
      Parameters:
      list - 需要处理RelatedColumn的对象列表

    • handleRelatedColumn

      <T> void handleRelatedColumn(T t, String... relatedColumnProperties)
      单独抽离出处理RelatedColumn的类，参数t不需要@Table的注解了
      Parameters:
      t - 需要处理RelatedColumn的对象
      relatedColumnProperties - 只处理制定的这些RelatedColumn注解的成员变量，这个的值是成员变量的名称

    • handleRelatedColumn

      <T> void handleRelatedColumn(List<T> list, String... relatedColumnProperties)
      单独抽离出处理RelatedColumn的类，参数list的元素不需要@Table的注解了。但要求list都同一class类型的对象。
      Parameters:
      list - 需要处理RelatedColumn的对象列表
      relatedColumnProperties - 只处理制定的这些RelatedColumn注解的成员变量，这个的值是成员变量的名称

    • insert

      <T> int insert(T t)
      插入一条记录
      如果包含了自增id，则自增Id会被设置。
      【注】只插入非null的值，如要需要插入null值，则用insertWithNull。
      Parameters:
      t - 需要插入的DO对象实例
      Returns:
      实际修改的条数

    • insert

      int insert(Collection<?> list)
      批量插入多条记录，返回数据库实际修改的条数。
      【说明】该方法没有事务，请在外层加事务。
      【特别说明】因为需要获取自增主键，对于有自增id的插入，会降级为逐条插入，如果想提升性能，请使用insertBatchWithoutReturnId方法。
      Parameters:
      list - 需要插入的DO对象实例列表
      Returns:
      实际修改的条数

    • insertBatchWithoutReturnId

      <T> int insertBatchWithoutReturnId(Collection<T> list)
      批量插入多条记录，返回数据库实际修改的条数。

      【重点】不会自动设置插入数据的返回自增ID（拦截器里也拿不到ID），也不会设置回数据库的默认值
      Parameters:
      list - 需要插入的DO对象实例列表
      Returns:
      实际修改的条数

    • insertBatchWithoutReturnId

      int insertBatchWithoutReturnId(String tableName, Collection<Map<String,Object>> list)
      批量插入多条记录，返回数据库实际修改的条数。【不支持拦截器】
      Parameters:
      tableName - 插入的表名
      list - 列名和值
      Returns:
      实际修改的条数

    • insertBatchWithoutReturnId

      int insertBatchWithoutReturnId(String tableName, List<String> cols, Collection<Object[]> values)
      以JDBCTemplate的batchUpdate方式，批量插入多条记录，返回数据库实际修改的条数。【不支持拦截器】
      Parameters:
      tableName - 插入的表名
      cols - 列的列表
      values - 参数列表，每个元素是一条记录的值，按照cols的顺序，个数必须和cols的个数一致
      Returns:
      实际修改的条数

    • insertWithNull

      <T> int insertWithNull(T t)
      插入一条记录，返回数据库实际修改条数。
      如果包含了自增id，则自增Id会被设置。
      Parameters:
      t - 需要插入的DO对象实例
      Returns:
      实际修改的条数

    • insertOrUpdate

      <T> int insertOrUpdate(T t)
      如果t有主键，则更新值；否则插入记录。只有非null的值会更新或插入。
      Parameters:
      t - 需要插入的DO对象实例
      Returns:
      返回数据库实际修改的条数

    • insertOrUpdateWithNull

      <T> int insertOrUpdateWithNull(T t)
      如果t有主键，则更新值；否则插入记录。包括null的值会更新或插入。
      Parameters:
      t - 需要插入的DO对象实例
      Returns:
      返回数据库实际修改的条数

    • insertOrUpdate

      <T> int insertOrUpdate(Collection<T> list)
      如果t有主键，则更新值；否则插入记录。只有非null的值会更新或插入。
      Parameters:
      list - 需要插入的DO对象实例列表
      Returns:
      返回数据库实际修改的条数

    • updateWithNull

      <T> int updateWithNull(T t) throws NullKeyValueException
      更新单个实例数据库记录，必须带上object的key，包含更新null值的字段
      Parameters:
      t - 更新的对象实例
      Returns:
      返回数据库实际修改条数
      Throws:
      NullKeyValueException - 当对象t的主键值为null时抛出

    • updateWithNull

      <T> int updateWithNull(T t, String postSql, Object... args) throws NullKeyValueException
      带条件的更新单个对象，必须带上object的key，主要用于mysql的update ... where ...这样的CAS修改
      Parameters:
      t - 更新的对象实例
      postSql - where及后续的sql，包含where关键字
      args - postSql中的参数
      Returns:
      返回数据库实际修改条数
      Throws:
      NullKeyValueException - 当对象t的主键值为null时抛出

    • update

      <T> int update(T t) throws NullKeyValueException
      更新单条数据库记录,必须带上object的key。【只更新非null字段】
      Parameters:
      t - 更新的对象实例
      Returns:
      返回数据库实际修改条数
      Throws:
      NullKeyValueException - 当对象t的主键值为null时抛出

    • update

      <T> int update(T t, String postSql, Object... args) throws NullKeyValueException
      更新单条数据库记录,必须带上object的key，主要用于mysql的update ... where ...这样的CAS修改。 【只更新非null字段】
      Parameters:
      t - 更新的对象实例
      postSql - where及后续的sql，包含where关键字
      args - postSql中的参数
      Returns:
      返回数据库实际修改条数
      Throws:
      NullKeyValueException - 当对象t的主键值为null时抛出

    • updateCustom

      <T> int updateCustom(T t, String setSql, Object... args) throws NullKeyValueException
      自定义set字句更新，用于单个sql进行值更新，例如set reads = reads + 1这种情况。
      Parameters:
      t - 必须提供key
      setSql - 可包含set关键字也可不包含，多个则用逗号隔开，【不能】包含where子句，例如a=a+1,c=b 或 set a=a+1,c=b
      args - set子句的参数
      Returns:
      实际修改的条数
      Throws:
      NullKeyValueException - 当t没有带上key时，抛出该异常

    • updateAll

      <T> int updateAll(Class<T> clazz, String setSql, String whereSql, Object... args)
      自定义更新多行记录，会自动去掉已软删除的行。 【重要更新 since 1.0.0】该方法修改的记录，不会再调用afterUpdate方法，如果需要获得被修改的行记录，请考虑使用canal方案。
      Parameters:
      clazz - 要更新的DO类
      setSql - update sql中的set sql子句，可以包括set关键字也可以不包括
      whereSql - update sql中的where sql子句，可以包括where关键字也可以不包括
      args - whereSql中的参数
      Returns:
      实际修改条数

    • update

      <T> int update(Collection<T> list) throws NullKeyValueException
      批量更新数据库记录，返回数据库实际修改条数。【只更新非null字段，需要更新null字段请使用updateWithNull方法】

      当符合以下条件时，更新数据将转换成真正的批量更新，性能可提升100倍左右：
      1) list中所有的元素都是相同的类
      2) list中所有的元素都有且只有一个主键，且主键有值（多主键场景很少，后续有时间再支持多主键）
      特别说明：如果有cas版本，会抛出CasVersionNotMatchException异常（可以从该异常中获取实际的修改行数），需要自行注解@Transactional事务进行回滚，否则修改的数据不会回滚。此外，clickhouse不支持有cas的批量更新操作，一般情况下也不会使用clickhouse进行批量cas update操作。
      Parameters:
      list - 要更新的对象列表
      Returns:
      实际修改条数
      Throws:
      NullKeyValueException - 当对象列表中的对象的主键值为null时抛出

    • delete

      <T> int delete(T t) throws NullKeyValueException
      删除数据库记录，返回数据库实际修改条数。 该操作【会】自动使用软删除进行删除
      Parameters:
      t - 要删除的对象
      Returns:
      实际删除的条数
      Throws:
      NullKeyValueException

    • deleteHard

      <T> int deleteHard(T t) throws NullKeyValueException
      硬删除数据库记录（无论是否注解了软删除字段），返回数据库实际修改条数。
      Parameters:
      t - 要删除的对象
      Returns:
      实际删除的条数
      Throws:
      NullKeyValueException - 当对象的主键值为null时抛出

    • delete

      <T> int delete(Collection<T> list) throws NullKeyValueException
      删除数据库记录，返回数据库实际修改条数。 推荐使用单个主键的表使用该方法，当list所有对象都是同一个类时，将会拼凑为一条sql进行删除，效率提升多。 该操作【会】自动使用软删除进行删除
      Parameters:
      list - 要更新的对象列表
      Returns:
      实际删除的条数
      Throws:
      NullKeyValueException - 当任意一个值没有带key时，抛出异常

    • deleteHard

      <T> int deleteHard(Collection<T> list) throws NullKeyValueException
      硬删除数据库记录（无论是否注解了软删除字段），返回数据库实际修改条数。 推荐使用单个主键的表使用该方法，当list所有对象都是同一个类时，将会拼凑为一条sql进行删除，效率提升多。
      Parameters:
      list - 要更新的对象列表
      Returns:
      实际删除的条数
      Throws:
      NullKeyValueException - 当任意一个值没有带key时，抛出异常

    • delete

      <T> int delete(Class<T> clazz, String postSql, Object... args)
      自定义条件删除数据，该操作【会】自动使用软删除标记。 对于使用了拦截器和deleteValueScript的场景，该方法的实现是先根据条件查出数据，再批量删除，以便拦截器可以记录下实际被删的数据，此时删除性能可能比较差，请权衡使用。
      Parameters:
      clazz - 必须有默认构造方法
      postSql - 必须提供，必须写where，【不允许】留空
      args - postSql的参数
      Returns:
      实际删除的条数

    • deleteHard

      <T> int deleteHard(Class<T> clazz, String postSql, Object... args)
      自定义条件删除数据（无论是否注解了软删除字段）。
      对于使用了拦截器和deleteValueScript的场景，该方法的实现是先根据条件查出数据，再批量删除，以便拦截器可以记录下实际被删的数据，此时删除性能可能比较差，请权衡使用。
      Parameters:
      clazz - 必须有默认构造方法
      postSql - 必须提供，必须写where，【不允许】留空
      args - postSql的参数
      Returns:
      实际删除的条数

    • executeRaw

      int executeRaw(String sql, Object... args)
      执行自行指定的SQL语句，支持in(?)表达式，支持INSERT UPDATE DELETE TRUNCATE操作
      Parameters:
      sql - 自定义SQL
      args - 自定义参数
      Returns:
      返回影响的行数

    • executeRaw

      int executeRaw(String sql, Map<String,?> paramMap)
      执行自行指定的SQL语句，支持通过namedParameter的方式传入参数，支持in(?)表达式，支持INSERT UPDATE DELETE TRUNCATE操作
      Parameters:
      sql - 自定义SQL，参数用namedParameter的方式
      paramMap - 自定义参数
      Returns:
      返回影响的行数