DefaultColumnBuilder (hsweb-easy-orm-rdb 4.0.15 API)

java.lang.Object
- org.hswebframework.ezorm.rdb.operator.ddl.DefaultColumnBuilder

所有已实现的接口:: ColumnBuilder

public class DefaultColumnBuilder
extends Object
implements ColumnBuilder

作者:: zhouhao

构造器概要

构造器
构造器和说明

DefaultColumnBuilder(RDBColumnMetadata columnMetaData, TableBuilder tableBuilder, RDBTableMetadata tableMetaData)

构造器
构造器和说明
`DefaultColumnBuilder(RDBColumnMetadata columnMetaData, TableBuilder tableBuilder, RDBTableMetadata tableMetaData)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`ColumnBuilder`	`alias(String name)` 设置别名 `AbstractColumnMetadata.getAlias()`
`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()`.
`ColumnBuilder`	`defaultValue(DefaultValue value)` 设置默认值
`ColumnBuilder`	`length(int len)` 设置列长度 ,通常用于字符类型的列`RDBColumnMetadata.setLength(int)`
`ColumnBuilder`	`length(int precision, int scale)` 设置列位数和精度,通常用于数值类型的列.
`ColumnBuilder`	`name(String name)` 设置列名 `AbstractColumnMetadata.getName()`
`ColumnBuilder`	`notNull()` 设置不能为空 `RDBColumnMetadata.isNotNull()`
`ColumnBuilder`	`primaryKey()` 设置为主键 `RDBColumnMetadata#isPrimaryKey()`
`ColumnBuilder`	`property(String propertyName, Object value)` 自定义列配置 `AbstractColumnMetadata.setProperty(String, Object)`
`ColumnBuilder`	`type(DataType type)` 设置数据类型
`ColumnBuilder`	`type(String typeId)` 根据类型ID设置类型

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.hswebframework.ezorm.rdb.operator.ddl.ColumnBuilder
bigint, clob, datetime, defaultValueNative, defaultValueRuntime, integer, number, number, text, tinyint, type, varchar

- 构造器详细资料
  - DefaultColumnBuilder
```
public DefaultColumnBuilder(RDBColumnMetadata columnMetaData,
                            TableBuilder tableBuilder,
                            RDBTableMetadata tableMetaData)
```
- 方法详细资料
  - name
```
public ColumnBuilder name(String name)
```
    从接口复制的说明: ColumnBuilder
    
    设置列名 AbstractColumnMetadata.getName()
    
    指定者:
    
    name 在接口中 ColumnBuilder
    
    参数:
    
    name - 列名
    
    返回:
    
    ColumnBuilder
  - custom
```
public ColumnBuilder custom(java.util.function.Consumer<RDBColumnMetadata> consumer)
```
    从接口复制的说明: ColumnBuilder
    自定义列结构
```
   custom(column-> column.addFeature....)
 
```
    指定者:
    
    custom 在接口中 ColumnBuilder
    
    参数:
    
    consumer - 自定义回调
    
    返回:
    
    ColumnBuilder
  - alias
```
public ColumnBuilder alias(String name)
```
    从接口复制的说明: ColumnBuilder
    
    设置别名 AbstractColumnMetadata.getAlias()
    
    指定者:
    
    alias 在接口中 ColumnBuilder
    
    参数:
    
    name - 别名
    
    返回:
    
    ColumnBuilder
  - type
```
public ColumnBuilder type(String typeId)
```
    从接口复制的说明: ColumnBuilder
    
    根据类型ID设置类型
    
    指定者:
    
    type 在接口中 ColumnBuilder
    
    参数:
    
    typeId - 类型ID
    
    返回:
    
    ColumnBuilder
    
    另请参阅:
    
    Dialect.convertDataType(String)
  - dataType
```
public ColumnBuilder dataType(String dataType)
```
    从接口复制的说明: ColumnBuilder
    
    设置数据类型,如: varchar(32) RDBColumnMetadata.getDataType().
    建议使用ColumnBuilder.type(JDBCType, Class)和ColumnBuilder.length(int)
    
    指定者:
    
    dataType 在接口中 ColumnBuilder
    
    参数:
    
    dataType - 数据类型
    
    返回:
    
    ColumnBuilder
  - type
```
public ColumnBuilder type(DataType type)
```
    从接口复制的说明: ColumnBuilder
    
    设置数据类型
    
    指定者:
    
    type 在接口中 ColumnBuilder
    
    参数:
    
    type - 类型
    
    返回:
    
    ColumnBuilder
    
    另请参阅:
    
    Dialect.convertDataType(String)
  - comment
```
public ColumnBuilder comment(String comment)
```
    从接口复制的说明: ColumnBuilder
    
    设置列注释
    
    指定者:
    
    comment 在接口中 ColumnBuilder
    
    参数:
    
    comment - 列注释
    
    返回:
    
    ColumnBuilder
  - notNull
```
public ColumnBuilder notNull()
```
    从接口复制的说明: ColumnBuilder
    
    设置不能为空 RDBColumnMetadata.isNotNull()
    
    指定者:
    
    notNull 在接口中 ColumnBuilder
    
    返回:
    
    ColumnBuilder
  - primaryKey
```
public ColumnBuilder primaryKey()
```
    从接口复制的说明: ColumnBuilder
    
    设置为主键 RDBColumnMetadata#isPrimaryKey()
    
    指定者:
    
    primaryKey 在接口中 ColumnBuilder
    
    返回:
    
    ColumnBuilder
  - columnDef
```
public ColumnBuilder columnDef(String def)
```
    从接口复制的说明: ColumnBuilder
    设置固定的列定义 RDBColumnMetadata#setColumnDefinition(String)
```
 columnDef("varchar(32) not null")
 
```
    指定者:
    
    columnDef 在接口中 ColumnBuilder
    
    参数:
    
    def - 列定义
    
    返回:
    
    ColumnBuilder
  - defaultValue
```
public ColumnBuilder defaultValue(DefaultValue value)
```
    从接口复制的说明: ColumnBuilder
    
    设置默认值
    
    指定者:
    
    defaultValue 在接口中 ColumnBuilder
    
    参数:
    
    value - 默认值
    
    返回:
    
    ColumnBuilder
    
    另请参阅:
    
    NativeSqlDefaultValue, RuntimeDefaultValue
  - length
```
public ColumnBuilder length(int len)
```
    从接口复制的说明: ColumnBuilder
    
    设置列长度 ,通常用于字符类型的列RDBColumnMetadata.setLength(int)
    
    指定者:
    
    length 在接口中 ColumnBuilder
    
    参数:
    
    len - 列长度
    
    返回:
    
    ColumnBuilder
  - length
```
public ColumnBuilder length(int precision,
                            int scale)
```
    从接口复制的说明: ColumnBuilder
    
    设置列位数和精度,通常用于数值类型的列. RDBColumnMetadata#setPrecision(int)
    
    指定者:
    
    length 在接口中 ColumnBuilder
    
    参数:
    
    precision - 位数
    
    scale - 精度 (小数位数)
    
    返回:
    
    ColumnBuilder
  - property
```
public ColumnBuilder property(String propertyName,
                              Object value)
```
    从接口复制的说明: ColumnBuilder
    
    自定义列配置 AbstractColumnMetadata.setProperty(String, Object)
    
    指定者:
    
    property 在接口中 ColumnBuilder
    
    参数:
    
    propertyName - 配置名
    
    value - 值
    
    返回:
    
    ColumnBuilder
  - commit
```
public TableBuilder commit()
```
    从接口复制的说明: ColumnBuilder
    
    完成构造,返回TableBuilder
    
    指定者:
    
    commit 在接口中 ColumnBuilder
    
    返回:
    
    TableBuilder

类 DefaultColumnBuilder

构造器概要

方法概要

从类继承的方法 java.lang.Object

从接口继承的方法 org.hswebframework.ezorm.rdb.operator.ddl.ColumnBuilder

构造器详细资料

DefaultColumnBuilder

方法详细资料

name

custom

alias

type

dataType

type

comment

notNull

primaryKey

columnDef

defaultValue

length

length

property

commit