ColumnBuilder (Easy ORM RDB 4.1.4 API)

所有已知实现类:: DefaultColumnBuilder

public interface ColumnBuilder

列构造器,用于通过DSL方式来描述列的结构:



    createOrAlter("test")
    .addColumn("id").varchar().primaryKey().commit()
    .commit()
    .sync();

从以下版本开始:: 4.0
作者:: zhouhao

方法概要

所有方法实例方法抽象方法默认方法
限定符和类型	方法和说明
`ColumnBuilder`	`alias(String name)` 设置别名 `AbstractColumnMetadata.getAlias()`
`default ColumnBuilder`	`bigint()` 设置BIGINT类型,`JDBCType.BIGINT`
`default ColumnBuilder`	`clob()` 设置CLOB类型,`JDBCType.CLOB`
`ColumnBuilder`	`columnDef(String def)` 设置固定的列定义 `RDBColumnMetadata#setColumnDefinition(String)` `columnDef("varchar(32) not null")`
`ColumnBuilder`	`comment(String comment)` 设置列注释
`TableBuilder`	`commit()` 完成构造,返回TableBuilder
`ColumnBuilder`	`custom(java.util.function.Consumer<RDBColumnMetadata> consumer)` 自定义列结构 `custom(column-> column.addFeature....)`
`ColumnBuilder`	`dataType(String dataType)` 设置数据类型,如: varchar(32) `RDBColumnMetadata.getDataType()`.
`default ColumnBuilder`	`datetime()` 设置TIMESTAMP类型,`JDBCType.TIMESTAMP`
`ColumnBuilder`	`defaultValue(DefaultValue value)` 设置默认值
`default ColumnBuilder`	`defaultValueNative(String defaultSql)` 设置默认值SQL
`default ColumnBuilder`	`defaultValueRuntime(RuntimeDefaultValue value)` 设置运行时默认值
`default ColumnBuilder`	`integer()` 设置integer类型,`JDBCType.INTEGER`
`ColumnBuilder`	`length(int len)` 设置列长度 ,通常用于字符类型的列`RDBColumnMetadata.setLength(int)`
`ColumnBuilder`	`length(int precision, int scale)` 设置列位数和精度,通常用于数值类型的列.
`ColumnBuilder`	`name(String name)` 设置列名 `AbstractColumnMetadata.getName()`
`ColumnBuilder`	`notNull()` 设置不能为空 `RDBColumnMetadata.isNotNull()`
`default ColumnBuilder`	`number(int len)` 设置整数类型 `JDBCType.NUMERIC` `Long`
`default ColumnBuilder`	`number(int precision, int scale)` 设置数字类型 `JDBCType.NUMERIC` `BigDecimal`
`ColumnBuilder`	`primaryKey()` 设置为主键 `RDBColumnMetadata#isPrimaryKey()`
`ColumnBuilder`	`property(String propertyName, Object value)` 自定义列配置 `AbstractColumnMetadata.setProperty(String, Object)`
`default ColumnBuilder`	`text()` 设置文本类型,`JDBCType.LONGNVARCHAR`
`default ColumnBuilder`	`tinyint()` 设置TINYINT类型,`JDBCType.TINYINT`
`ColumnBuilder`	`type(DataType type)` 设置数据类型
`default ColumnBuilder`	`type(JDBCType jdbcType, Class<?> javaType)` 设置JDBC类型和JAVA类型
`ColumnBuilder`	`type(String typeId)` 根据类型ID设置类型
`default ColumnBuilder`	`varchar(int length)` 设置字符串类型

- 方法详细资料
  - custom
```
ColumnBuilder custom(java.util.function.Consumer<RDBColumnMetadata> consumer)
```
    自定义列结构
```
   custom(column-> column.addFeature....)
 
```
    参数:
    
    consumer - 自定义回调
    
    返回:
    
    ColumnBuilder
  - name
```
ColumnBuilder name(String name)
```
    设置列名 AbstractColumnMetadata.getName()
    
    参数:
    
    name - 列名
    
    返回:
    
    ColumnBuilder
  - alias
```
ColumnBuilder alias(String name)
```
    设置别名 AbstractColumnMetadata.getAlias()
    
    参数:
    
    name - 别名
    
    返回:
    
    ColumnBuilder
  - dataType
```
ColumnBuilder dataType(String dataType)
```
    设置数据类型,如: varchar(32) RDBColumnMetadata.getDataType().
    建议使用type(JDBCType, Class)和length(int)
    
    参数:
    
    dataType - 数据类型
    
    返回:
    
    ColumnBuilder
  - type
```
ColumnBuilder type(String typeId)
```
    根据类型ID设置类型
    
    参数:
    
    typeId - 类型ID
    
    返回:
    
    ColumnBuilder
    
    另请参阅:
    
    Dialect.convertDataType(String)
  - type
```
ColumnBuilder type(DataType type)
```
    设置数据类型
    
    参数:
    
    type - 类型
    
    返回:
    
    ColumnBuilder
    
    另请参阅:
    
    Dialect.convertDataType(String)
  - comment
```
ColumnBuilder comment(String comment)
```
    设置列注释
    
    参数:
    
    comment - 列注释
    
    返回:
    
    ColumnBuilder
  - notNull
```
ColumnBuilder notNull()
```
    设置不能为空 RDBColumnMetadata.isNotNull()
    
    返回:
    
    ColumnBuilder
  - primaryKey
```
ColumnBuilder primaryKey()
```
    设置为主键 RDBColumnMetadata#isPrimaryKey()
    
    返回:
    
    ColumnBuilder
  - columnDef
```
ColumnBuilder columnDef(String def)
```
    设置固定的列定义 RDBColumnMetadata#setColumnDefinition(String)
```
 columnDef("varchar(32) not null")
 
```
    参数:
    
    def - 列定义
    
    返回:
    
    ColumnBuilder
  - defaultValue
```
ColumnBuilder defaultValue(DefaultValue value)
```
    设置默认值
    
    参数:
    
    value - 默认值
    
    返回:
    
    ColumnBuilder
    
    另请参阅:
    
    NativeSqlDefaultValue, RuntimeDefaultValue
  - property
```
ColumnBuilder property(String propertyName,
                       Object value)
```
    自定义列配置 AbstractColumnMetadata.setProperty(String, Object)
    
    参数:
    
    propertyName - 配置名
    
    value - 值
    
    返回:
    
    ColumnBuilder
  - length
```
ColumnBuilder length(int len)
```
    设置列长度 ,通常用于字符类型的列RDBColumnMetadata.setLength(int)
    
    参数:
    
    len - 列长度
    
    返回:
    
    ColumnBuilder
  - length
```
ColumnBuilder length(int precision,
                     int scale)
```
    设置列位数和精度,通常用于数值类型的列. RDBColumnMetadata#setPrecision(int)
    
    参数:
    
    precision - 位数
    
    scale - 精度 (小数位数)
    
    返回:
    
    ColumnBuilder
  - commit
```
TableBuilder commit()
```
    完成构造,返回TableBuilder
    
    返回:
    
    TableBuilder
  - type
```
default ColumnBuilder type(JDBCType jdbcType,
                           Class<?> javaType)
```
    设置JDBC类型和JAVA类型
    
    参数:
    
    jdbcType - JDBC类型
    
    javaType - JAVA类型
    
    返回:
    
    ColumnBuilder
  - varchar
```
default ColumnBuilder varchar(int length)
```
    设置字符串类型
    
    参数:
    
    length - 长度
    
    返回:
    
    ColumnBuilder
  - number
```
default ColumnBuilder number(int precision,
                             int scale)
```
    设置数字类型 JDBCType.NUMERIC BigDecimal
    
    参数:
    
    precision - 数字位数
    
    scale - 小数位数
    
    返回:
    
    ColumnBuilder
  - number
```
default ColumnBuilder number(int len)
```
    设置整数类型 JDBCType.NUMERIC Long
    
    参数:
    
    len - 数字位数
    
    返回:
    
    ColumnBuilder
  - text
```
default ColumnBuilder text()
```
    设置文本类型,JDBCType.LONGNVARCHAR
    
    返回:
    
    ColumnBuilder
  - clob
```
default ColumnBuilder clob()
```
    设置CLOB类型,JDBCType.CLOB
    
    返回:
    
    ColumnBuilder
  - integer
```
default ColumnBuilder integer()
```
    设置integer类型,JDBCType.INTEGER
    
    返回:
    
    ColumnBuilder
  - bigint
```
default ColumnBuilder bigint()
```
    设置BIGINT类型,JDBCType.BIGINT
    
    返回:
    
    ColumnBuilder
  - tinyint
```
default ColumnBuilder tinyint()
```
    设置TINYINT类型,JDBCType.TINYINT
    
    返回:
    
    ColumnBuilder
  - datetime
```
default ColumnBuilder datetime()
```
    设置TIMESTAMP类型,JDBCType.TIMESTAMP
    
    返回:
    
    ColumnBuilder
  - defaultValueNative
```
default ColumnBuilder defaultValueNative(String defaultSql)
```
    设置默认值SQL
    
    参数:
    
    defaultSql - 默认值SQL
    
    返回:
    
    ColumnBuilder
  - defaultValueRuntime
```
default ColumnBuilder defaultValueRuntime(RuntimeDefaultValue value)
```
    设置运行时默认值
    
    参数:
    
    value - 默认值
    
    返回:
    
    ColumnBuilder

接口 ColumnBuilder

方法概要

方法详细资料

custom

name

alias

dataType

type

type

comment

notNull

primaryKey

columnDef

defaultValue

property

length

length

commit

type

varchar

number

number

text

clob

integer

bigint

tinyint

datetime

defaultValueNative

defaultValueRuntime