Package com.pugwoo.dbhelper.annotation

Annotation Type Table

@Target(TYPE) @Retention(RUNTIME) public @interface Table
2015年1月12日 16:19:46 数据表信息注解

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    表名

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    alias
    表别名，默认是t，该别名目前仅对查询操作生效
    int
    autoTrimString
    是否自动去除String类型的字段两端的空白。该设置的优先级低于Table注解的autoTrimString属性。
    值为1表示自动去除两端空白，值为0表示不去除，值为-1不设置，如果Column的autoTrimString属性也为-1时，不自动去除
    String
    comment
    表注释
    String
    insertDefaultValueMap
    表级别的插入数据默认值集合，这里填的是DBHelperContext中的默认值集合的名称
    如果字段级别有默认值，则它的优先级高于表级别的默认值
    ValueConditionEnum
    insertValueCondition
    insertValueScript脚本的执行条件，默认为null，表示只有当原值为null时才执行脚本
    Class<?>
    sameTableNameAs
    指定和另外一个DO/VO类同名，当指定别名时，value()值失效，建议将其留空，以免有歧义
    String
    softDeleteDBHelperBean
    当软删除表不是同一个数据库时，可以通过softDeleteDBHelper指定数据库
    String
    softDeleteTable
    指定软删除表名，本表删除时，会将删除的数据插入到该表中，该表的结构必须和本表一致。
    String
    virtualTablePath
    作用同virtualTableSQL()注解，但是是一个classpath路径
    String
    virtualTableSQL
    虚拟表SQL，从select开始的完整SQL，该方式只对查询操作有效。当非空时有效，此时value()表名失效。

    说明：虚拟表也支持path路径，path路径的文件内容就是SQL。
    该方式适用于自定义表，接近于getRaw方法，有以下约束：
    1) getPage不会自动移除limit和加order by 2) 不支持自动处理软删除softDelete标记 3) 不支持getByKey/getByKeyList/getAllKey/getByExample

  • Element Details

    • value

      String value
      表名

    • sameTableNameAs

      Class<?> sameTableNameAs
      指定和另外一个DO/VO类同名，当指定别名时，value()值失效，建议将其留空，以免有歧义
      Default:
      void.class

    • softDeleteTable

      String softDeleteTable
      指定软删除表名，本表删除时，会将删除的数据插入到该表中，该表的结构必须和本表一致。
      Default:
      ""

    • softDeleteDBHelperBean

      String softDeleteDBHelperBean
      当软删除表不是同一个数据库时，可以通过softDeleteDBHelper指定数据库
      Default:
      ""

    • insertDefaultValueMap

      String insertDefaultValueMap
      表级别的插入数据默认值集合，这里填的是DBHelperContext中的默认值集合的名称
      如果字段级别有默认值，则它的优先级高于表级别的默认值
      Default:
      ""

    • insertValueCondition

      ValueConditionEnum insertValueCondition
      insertValueScript脚本的执行条件，默认为null，表示只有当原值为null时才执行脚本
      Default:
      WHEN_NULL

    • virtualTableSQL

      String virtualTableSQL
      虚拟表SQL，从select开始的完整SQL，该方式只对查询操作有效。当非空时有效，此时value()表名失效。

      说明：虚拟表也支持path路径，path路径的文件内容就是SQL。
      该方式适用于自定义表，接近于getRaw方法，有以下约束：
      1) getPage不会自动移除limit和加order by 2) 不支持自动处理软删除softDelete标记 3) 不支持getByKey/getByKeyList/getAllKey/getByExample
      Default:
      ""

    • virtualTablePath

      String virtualTablePath
      作用同virtualTableSQL()注解，但是是一个classpath路径
      Default:
      ""

    • alias

      String alias
      表别名，默认是t，该别名目前仅对查询操作生效
      Default:
      "t"

    • comment

      String comment
      表注释
      Default:
      ""

    • autoTrimString

      int autoTrimString
      是否自动去除String类型的字段两端的空白。该设置的优先级低于Table注解的autoTrimString属性。
      值为1表示自动去除两端空白，值为0表示不去除，值为-1不设置，如果Column的autoTrimString属性也为-1时，不自动去除
      Default:
      -1